admission_list_program ( session, [program], [status = "ACTIVE"], [search_str = ""], [max_res = 100], [offset = 0], [sort], [direction], [filter = "ACTIVE"], [subscription], [trial_arm])

All

SOAP, REST (from API Version 2.7.31)

Input parameters:

• session: is the session id obtained in the session_init call

• program:  Reference the PROGRAM selected to filter the search results. If null, all PROGRAMS will be considered.

• status:  One of the possible ADMISSION status: "ACTIVE", "ENROLLED", "REJECTED", "DISCHARGED", "INACTIVE", "ALL".

  • ADMISSIONS with alerts: From API version 2.7.17 it is possible to request only ADMISSION with alerts by prepending the character "!" to the status. For example: "!ACTIVE". An ADMISSION has alerts when there exists an EVENT OBJECT associated to the ADMISSION, and the EVENT OBJECT has a priority above "NORMAL"

  • Multiple status: From API version 2.7.21 it is possible to specify a list of ADMISSION status separated by commas (e.g. "ACTIVE, ENROLLED"). The "ADMISSIONS with alerts" mark can be expressed as an additional status in the list by adding the character "!" (e.g. "!, ENROLLED, ACTIVE") and it is used globally for all the specified filters (it is not possible to request alerts only for an specific status and not for the rest).

• search_str: is the string used to search by patient nickname, local ID’s, national ID’s, telephone, etc.

• limit: is the max number of rows extracted by call

• offset: is the offset number to start from the items

• sort: string used in order to sort the list (id_source, id_patient, nickname, birthday, enrol_date, date_to_display)

• direction: asc, desc

• filter: "ACTIVE"/"ALL" (default = "ACTIVE") Indicates the status of the SUBSCRIPTIONs. If "ACTIVE", only ADMISSIONs in active SUBSCRIPTIONS will be returned

• subscription: Reference of the SUBSCRIPTION selected to filter the search results. If null, all SUBSCRIPTIONS will be considered

• trial_arm: (default = null) Filter by a specific trial arm in PROGRAMS configured as “Medical Trial”. Introduced in API Version 2.7.32.
  Possible values are:

  • null: All ADMISSIONS will be considered, no matter to which trial arm are assigned

  • “I”: Only ADMISSIONS assigned to the “INTERVENTION” trial arm will be considered

  • “C”: Only ADMISSIONS assigned to the “CONTROL” trial arm will be considered

Output parameters:

• result: is an XML that contains the admission list

  • count: number of admissions

  • num_cases: the total number of CASES (note that a single CASE can have more than one ADMISSION). Introduced in API Version 2.7.6

  • admissions: Array of ADMISSIONS. The information about each ADMISSION contains:

    • admission

      • 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)

      • data: information about the ADMISSION

        • 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

        • patient_data_complete: (true/false) Indicates whether the patient data is complete according to the FORMAT SETTINGS defined for the SUBSCRIPTION of this ADMISSION. This can only happen when the ADMISSION has status “INCOMPLETE” indicating that cannot change to “ENROLLED” until all the required information about the patient is completed. Introduced in API Version 2.7.26

        • date_to_display: The date of the last closed TASK (this does not include TASKS assigned to role SERVICE)

        • multiple: number of admissions of the same patient in the context.

        • referral: (added in API Version 2.7.13) Referral of the ADMISSION

          • professional: Information about the PROFESSIONAL assigned as referral of the ADMISSION

            • ref: reference of the PROFESSIONAL

            • name: full name of the PROFESSIONAL

          • team: Information about the TEAM assigned as referral of the ADMISSION

            • ref: reference of the TEAM

            • name: Name of the TEAM

            • insignia:reference to the image (badge) of the TEAM

        • custom_fields: Contains a list of customized fields of the ADMISSION along with their values. Customized fields are defined in the ADMISSION_ADDITIONAL_FIELDS SETTING and allow to calculate dynamically some values of the ADMISSION. Introduced in API Version 2.7.26

          • ref: reference of the custom field

          • type: data type. Can be “TEXT”, “NUMERIC”, “DATE”

          • description: description of the custom field

          • value: value assigned to the custom field.

      • performance: Information about the performance of the CASE in the ADMISSION

        • compliance: measure of the compliance. Compliance is expressed as a numeric value in the range 0-6. The value can be used as a 'color' tag (0: no value, 1: blue, 2: green, 3: yellow, 4: orange, 5: red, 6: black)

        • adherence: measure of the adherence. Adherence is expressed as a numeric value in the range 0-6. The value can be used as a 'color' tag (0: no value, 1: blue, 2: green, 3: yellow, 4: orange, 5: red, 6: black)

        • output: measure of the output. Outcome is expressed as a numeric value in the range 0-6. The value can be used as a 'color' tag (0: no value, 1: blue, 2: green, 3: yellow, 4: orange, 5: red, 6: black)

• 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

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The active session does not have permission to create or modify the DATACODE

2.7.31

The format of the XML has been changed to allow the representation of the response in JSON format when the API is invoked via REST (see change details for version 2.7.31)

IMPORTANT: Remember to call session_init() indicating the appropriate API Version

• Root node changed from <admissions> to <admission_list>

• Added subnode <admissions> to enclose the list of admissions