† admission_enroll_list ()

† admission_enroll_list ()

DEPRECATED in API Version 2.7.31

Function prototype
† admission_enroll_list (session, [max_res], [offset])

Is a function to list ENROLMENTS of admission in the programs were the active user or the active team have a case manager role

Version1.0

Input

parameters:

session: is the session id obtained in the session_init call

max_res: maximum number of elements to be returned

offset: row position of the first result to be returned (first row = "zero")

Output

parameters:

result: is an XML that contains the admission list

admissions: admission objects with all fields in the XML

count: number of admissions

ref: is the reference to the admission. If It’s local admission, only shows an ID. If the admission refers to an external HIS or Linkcare-HIS, an URI location is used in the reference like (SOURCE/ID/NNNN)

status: status of the admission
ACTIVE: An active admission
ENROLLED: An admission not assigned to a PROTOCOL
PREADMISSION: An admission assigned to a protocol with open admission forms
PAUSED: An admission temporarily PAUSED
REJECTED: An admission
DISCHARGED: A discharged admission

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

Request

sample:

admission_enroll_list ( “LCAAAAAAAAAAAAAAAAAAA”);

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<result>

<?xml version="1.0" encoding="UTF-8"?>
<admissions>
   <count>1</count>
   <admission>
      <ref>745</ref>
      <data>
         <case>
            <ref>1111</ref>
            <data>
               <nickname>IDONTSMOKE</nickname>
               <username>idontsmoke</username>
               <gender>F</gender>
               <bdate>2014-09-18</bdate>
            </data>
         </case>
         <team>
            <ref>1</ref>
            <insignia>12</insignia>
         </team>
         <program>
            <id>66</id>
            <name>Stop smoking program</name>
            <description>COFARES-SMOKING</description>
         </program>
         <enrol_date>2014-09-02 00:00:00</enrol_date>
         <admission_date />
         <discharge_request_date />
         <discharge_date />
         <suspended_date />
         <rejected_date />
         <notes />
         <status>ENROLLED</status>
         <date_to_display>2014-09-02 00:00:00</date_to_display>
         <age_to_display />
         <his_episode_ref />
         <protocol>
            <id />
            <name />
            <description />
         </protocol>
      </data>
   </admission>
</admissions>

</result>

<ErrorMsg></ErrorMsg>

Notes:

Used in user's dashboard