/
case_get_health_profile ()

case_get_health_profile ()

Owned by Pedro Jose Sanchez Luling
Last updated: Jun 03, 2022
Function prototype

case_get_health_profile (session, case , [profile_code_list])

API Version2.7.13 and higher

Returns all the information about the Health Profile of a patient

The information is obtained from FORMS referenced by any of the HEALTH PROFILE CODES.

Input

parameters:

  • session: a token obtained by calling session_init ()
  • case: a case reference. If no case is specified, the current session user will be assumed
  • profile_code_list: if null, all FORMS whose FORM_CODE is a HEALTH PROFILE CODES will be returned. Otherwise it must be a valid HEALTH PROFILE CODE, and in that case only the FORMS with for that specific PROFILE CODE will be returned. More than one HEALTH PROFILE CODE can be specified (Separated by commas)

Output

parameters:

  • health_profile: is an XML with the Health Profile information, categorised by the HEALTH PROFILE CODES. For each HEALTH PROFILE CODE can exist multiple tasks, though only the first one is the valid one (the list of tasks will appear in reverse chronological order). The rest are provided just as information to know the history about how the information was collected
  • 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: the code of the error (if any)

Request

sample:

case_get_health_profile( “LCAAAAAAAAAAA”, “1234”, "ALLERGIES,DIETARY_RESTRICTIONS");

Response

sample:


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
  <health_profile>
    <profile>
      <code>ALLERGIES</code>
      <description>Allergies</description>
	  <forms>
      	<form>
          <ref>20018</ref>
          <name>ALLERGIES</name>
          <code>ALLERGIES</code>
          <date>2015-01-28 00:00:00</date>
          <status>OPEN</status>
          <task>
            <ref>4546</ref>
          </task>
          <admission>
            <ref>21844</ref>
          </admission>
          <subscription>
            <ref>9876</ref>
          </subscription>
          <program>
            <ref></ref>
            <description></description>
          </program>
        </form>
	  </forms>
    </profile>  
  </health_profile>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>



Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the list of favorite items of the CASE

CASE.NOT_FOUND

The CASE reference provided does not correspond to an existing CASE

Related content