admission_get (session, admission)

All

SOAP, REST (from API Version 2.7.26)

Input parameters:

• session: is the session token obtained in the session_init() call

• admission: reference of an existing ADMISSION

Output parameters:

• result/admission: An XML with all the information about an admission

  • ref: is the reference to the ID and the center of the admission. It can be an external center or an internal admission in the Linkcare System.

  • version: version of the ADMISSION (version of PROGRAM when the ADMISSION was created). Note that the SUBSCRIPTION may have been updated to a different version (using the API function subscription_update() ), but the ADMISSION can still have an older version number, because updating the version of a SUBSCRIPTION doesn’t involve updating the version of the existing ADMISSIONS.

  • data

    • case: information about the CASE

      • ref: A reference to the CASE

      • data: personal data of the CASE. This node was added in API 2.7.6

        • nickname: Name of the patient. Depending on the privileges of the active USER, the nickname can be an abbreviation to anonymize the CASE

        • username 

        • gender: (M/F) gender of the CASE

        • age: Age of the CASE

        • bdate: Birthdate of the CASE

    • subscription: Information about the SUBSCRIPTION of the ADMISSION

      • <ref>1663</ref> <active>true</active> <locked>false</locked> <team> <ref>1</ref> <name>Linkcare</name> <insignia>P380000</insignia> </team> <program> <id>383</id> <version>3</version> <name>TEST LAB</name> <code>TEST_LAB</code> <image_info>{"resource_ref":3047,"lang":"EN","description":"","mime_type":"image\\/png","code":null,"scope":"PROGRAM","length":"240534","stream":"Rest.php?shared_key=9DBDC86A7C935513","modified":"2023-05-31 09:54:09"}</image_info> <double_blind>false</double_blind> <settings> <stratified>false</stratified> <locked>false</locked> </settings> </program>

    • diagnose: is an diagnosis XML node, with the information of the main diagnose

    • diagnoses: an array of secondary diagnoses

    • protocol: is the protocol XML node with all the information about the protocol

    • admission_date: date of the admission join (in the session’s local timezone)

    • discharge_date: the date of the discharge if it exists (in the session’s local timezone)

    • notes: notes about the discharged date or rejected date or suspended date

    • admin_admission_date: administrative date of the joined admission (in the session’s local timezone)

    • admin_discharge_date: administrative date of the discharge (in the session’s local timezone)

    • status: status of the admission

      • "INCOMPLETE": admission that does not have all the necessary data about the CASE

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

    • discharge_type: Type of the discharge

      • "DROPOUT"

      • "EXITUS"

      • "MOVED"

      • "TRANSFER"

      • "END"

    • suspended_date: the date of suspend (in the session’s local timezone)

    • rejected_date: the date of reject (in the session’s local timezone)

    • creation_date: Date of creation of the ADMISSION (in the session’s local timezone). Introduced in API Version 2.7.18

    • creation_mode: Indicates how the ADMISSION was created. Introduced in API Version 2.7.18. Possible values are:

      • "PROFESSIONAL": The ADMISSION was created by a PROFESSIONAL

      • "CASE": The ADMISSION was created by the CASE (self-registered)

      • "ASSOCIATE": The ADMISSION was created by an ASSOCIATE of the CASE

    • his_episode_ref: is the reference to the episode in the HIS (Hospital Information System)

    • editable: if current session user can change the details of the ADMISSION or delete it. This property is 'true' when the active user is member of the SUBSCRIPTION with roles CASE MANAGER or SERVICE. Removed in API Version 2.7.31. Moved to node “permissions”

    • trial: arm of protocol of trial program where patient joined (Intervention/Control/Null)

    • referrals/referral: List of referrals of the ADMISSION ordered by date descending. Introduced in API Version 2.7.12

      • date: date when the professional was assigned as 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

      • description: description of the custom field

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

      • value: value assigned to the custom field.

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

    • compliance: measure of the compliance.

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

      • validity: Limit date until the value is considered valid. If null, the value is always valid

    • adherence: measure of the adherence.

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

      • validity: Limit date until the value is considered valid. If null, the value is always valid

    • output: measure of the output.

      • value: Output 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)

      • validity: Limit date until the value is considered valid. If null, the value is always valid

  • reports: List of links to download REPORTS defined at ADMISSION level in the PROGRAM TEMPLATE (REPORTS defined at the stage “ADMISSION REPORTS”). Introduced in API version 2.8.1

    • ref: Reference of the Report.

    • name: Name (title) of the REPORT

    • url: url to generate the REPORT in PDF format. Only usable by the same session that generated this URL.

    • url_html: url to generate the REPORT in HTML format. Only usable by the same session that generated this URL.

• ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

• 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

ADMISSION.NOT_FOUND

The ADMISSION reference provided in parameter admission does not correspond to an existing ADMISSION