/
case_get_identifier_list ()

case_get_identifier_list ()

Feb 19, 2021
Function prototype

case_get_identifier_list ( session , case, [subscription])

API VersionALL

Returns a list of identifiers associated to a CASE. 

This operation is restricted by privileges granted to the session's user. It is only allowed if:

  • If the CASE corresponds to the same session's user: all existing identifiers will be returned
  • If the session's user is a PROFESSIONAL (doctor): all existing identifiers will be returned
  • If the session's user is an ASSOCIATE of the CASE:: all existing identifiers will be returned
  • Otherwise: an error will be returned (no permissions)

Input

parameters:

  • session: a token obtained by calling session_init ()
  • case: a case reference
  • subscription: if informed, only the identifiers used in that subscription will be returned

Output

parameters:

  • result
    • identifiers/identifier: a list of IDENTIFIERS 
      • label: name (code) of the IDENTIFIER
      • description: Description of the IDENTIFIER in the active session language
      • value: value assigned to the IDENTIFIER
      • program: (only in IDENTIFIER OBJECT that are associated to a SUBSCRIPTION). Introduced in API version 2.7.18
        • ref: PROGRAM reference
        • code: PROGRAM Code.
        • name: PROGRAM name
        • description: Description in the active session language
        • image_info: Image associated to the PROGRAM. The image is stored as a LIBRARY RESOURCE OBJECT
      • team: (only in IDENTIFIER OBJECT that are associated to a SUBSCRIPTION). Introduced in API version 2.7.18
        • ref: TEAM reference
        • code: TEAM Code.
        • name: TEAM name
  • ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

case_get_identifier_list ( “LCAAAAAAAAAAAA”, 32131)

Response

sample:


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
  <identifier_list>
    <identifiers>
      <identifier>
        <description>Pasaporte</description>
        <label>STUDY_REF</label>
        <value>32432</value>
        <program>
          <ref>393</ref>
          <code>BRCA</code>
          <name>BRCA</name>
          <description/>
          <image_info/>
        </program>
        <team>
          <ref>1</ref>
          <code>LINKCARE</code>
          <name>Linkcare</name>
        </team>
      </identifier>
      <identifier>
        <description>Spanish DNI</description>
        <label>NAT_ES</label>
        <value>46626222G</value>
        <image_ref>3626</image_ref>
      </identifier>
    </identifiers>
    <programs>
      <ref>313</ref>
      <name>BRCA</name>
      <description>BRCA</description>
      <subscriptions>
        <subscription>
          <ref>23412</ref>
          <team>
            <ref>32837</ref>
            <insignia>34</insignia>
          </team>
          <identifier_settings>PROGRAM</identifier_settings>
          <identifiers>
            <label>PASSPORT</label>
            <label>NAT_ES</label>
          </identifiers>
        </subscription>
      </subscriptions>
    </programs>
  </identifier_list>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Notes: