case_get_program_list (session, case = NULL, filter = NULL})

2.7.13 and higher

SOAP, REST (Since API Version 2.7.31)

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

• filter: JSON structure with optional filters. See Optional filters for more information

Output parameters:

• result/program_list: root node of the response

• health_profile: Contains a list of the Health Profile records of the patient. This is only returned if the active user has enough privileges to view the Health Profile of the patient. Form more detailed information about the Health Profile records, see case_get_health_profile (). Introduced in API version 2.7.25

  • profile: there is an entry for each HEALTH PROFILE CODES

• total: summary of open and closed TASKs and EVENTs

  • tasks: summary about the TASKs of the CASE.
    Note that when the active user is the CASE, this count only includes TASKS scheduled up to the next hour (i.e. it doesn’t count TASKS scheduled past 1 hour in the future).
    TASKs that are “CANCELED”, “EXPIRED” or “PAUSED” are not included in the count

    • open: total number of TASKs that the CASE has not completed yet

    • closed: total number of TASKs that the CASE has completed

  • events: summary about the EVENTs of the CASE

    • open: total number of EVENTs that the CASE has not completed yet

    • closed: total number of EVENTs that the CASE has completed

    • flagged: Number of EVENTs with a flag set (PRIORITY <> 0). Introduced in API version 2.7.15

  • alerts: number of unread alerts. Introduced in API version 2.7.24

  • educational: Number of available EDUCATIONAL MATERIALS. Introduced in API version 2.7.25

  • appointments: Number of APPOINTMENTS planned for today and other future dates. Introduced in API version 2.7.32

    • today: Number of APPOINTMENTS planned for today (in the local timezone of the active SESSION). This number will not include any APPOINTMENT planned before one hour in the past.

    • week: Number of APPOINTMENTS planned of the next week (not including the APPOINTMENTS planned for today)

• programs/program: Node with information about the PROGRAM

  • ref: reference to the PROGRAM

  • name: Name of the program

  • description: Description of the program (translated to the current session language)

  • image_info: Picture associated to the PROGRAM expressed as a LIBRARY RESOURCE INFO (JSON)

  • tasks: summary about the TASKs of the PATIENT

    • open: number of TASKs that the PATIENT has not completed yet in this PROGRAM

    • closed: number of TASKs that the PATIENT has completed in this PROGRAM

    • has_optional: (true/false) Indicates whether the PATIENT can add optional TASKs to this PROGRAM or not

  • events: summary about the EVENTs of the PATIENT

    • open: number of EVENTs that the PATIENT has not completed yet in this PROGRAM

    • closed: number of EVENTs that the PATIENT has completed in this PROGRAM

    • flagged: Number of EVENTs with a flag set (PRIORITY <> 0). Introduced in API version 2.7.15

    • has_optional: (true/false) Indicates whether the PATIENT can create new EVENTs in this PROGRAM or not

  • educational: number of EDUCATIONAL MATERIAS in this PROGRAM. Introduced in API version 2.7.25

  • teams: List of TEAM OWNERS of the subscriptions where the patient has an ADMISSION. Introduced in API Version 2.7.14

    • ref: Reference of the TEAM

    • name: Name of the TEAM

  • medical_records: (true/false) Indicates whether the PATIENT has medical records generated from this PROGRAM or not

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

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