case_get ( session , case, {admission})

All

SOAP, REST (Since API Version 2.7.32)

2.7.25

Notification channels preferences are not divided in "events" and "tasks". From version 2.7.25 there is a single "channels" property to indicate the preferred communication channels for receiving notifications.

See Changes in version 2.7.25 for more details

0.0.0

Initial version

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

Input parameters:

• session: is the token obtained in the session_init call

• case: Reference of the case. It is possible to indicate a reference of the patient in an external system if the format of the reference meets the rules defined in External user references

• admission: Reference to an ADMISSION. If provided, the information returned will be generated according to the FORMAT SETTINGS defined for the SUBSCRIPTION

Output parameters:

• result/case: an XML with all the information about a case

  • ref: the reference to the ID of the case, can be in a HIS connected to a Linkcare, a  Linkcare_ID or an external label (i.e. PASSPORT}.

  • personal_qr: QR representation of the personal data of the CASE. Can be used in other API functions instead of the case reference (see QR OBJECT ). Introduced in API Version 2.7.28

  • pictures: list of pictures associated to the CASE

  • identifiers: list of IDENTIFIERS associated to the CASE

  • data: Contact information

    • full_name: Concatenation of the name and surnames of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name

    • informal_name: Normally consists on name of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name. Introduced in API Version 2.7.24

    • name

    • surname

    • nickname: is the  nickname of the case/patient in Linkcare System

    • bdate: birth date

    • age: age in years

    • gender: M for male, F for female

    • status: is the status of the case, the possible status is commented in the function case_list();

    • timezone: Regional timezone code (e.g. “Europe/Madrid”) of the CASE. Introduced in API version 2.7.20

    • preferences

      • editable_by_case: (true/false) indicates whether the CASE can edit his own profile details or not

      • editable_by_user: (true/false) indicates whether a PROFESSIONAL can edit the CASE profile details or not

      • password_expire: (true/false) indicates whether the current password has expired. If true, in the next login it will be requested a password change

      • map_service: Used to define the default map service that should be used when presenting geolocated locations. Introduced in API version 2.7.7

        • code: one of the GEOLOCATION.PROVIDER CODES

        • description: Name of the map service translated to the active session language

      • notifications: preferences about communication channels to receive messages from the system when something happens (e.g. when an Event is sent to this patient)

        • channels: (email, phone, webalert, push) comma separated string with preferred communication channels to receive notifications about TASKS and EVENTS

        • event_priority: (all, flagged). Indicates which EVENTs should be notified based on their priority. The default value is "all", which means that all EVENTs will be notified to the CASE through the selected notification channels. Otherwise, only EVENTs with priority will be notified. Introduced in API version 2.7.15

        • from_time: Minimum time to receive notifications about pending TASKS when the TASK is not scheduled for a specific time (can be done at any time of the day). The expected format is 'hh:mm:ss'. Introduced in API version 2.7.25

  • has_health_profile: (true/false) Indicates if the CASE has health profile information that can be retrieved using case_get_health_profile (). If the active user does not have 'read' privileges over the health profile information of the patient, then the value of this field will always be 'false'. Introduced in API version 2.7.19

• 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 session user does not have the necessary privileges to request the information