Function prototype	case_get_optional_programs (session, [case])
API Version	2.7.3 and higher
Supported interfaces	SOAP, REST

Description

Returns a list of PROGRAMS where the selected CASE can do an auto-enroll (create an ADMISSION for himself)

Required permissions:

The CASE corresponds to the same session's user
The session's user is a PROFESSIONAL
The session's user is an ASSOCIATE of the CASE and the permission #PERMISSIONS.TASK_DELEGATE is granted for editing

Input parameters:

session: is the session token obtained in the session_init() call
case: A CASE reference. If no case is specified, the current session user will be assumed

Output parameters:

result/programs: Root node of the response: a list of PROGRAMS where the patient can auto-enroll.
- program: The information about each PROGRAM
  - ref: reference to the PROGRAM
  - code: PROGRAM CODE
  - 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)
  - teams: List of TEAMS with a SUBSCRIPTION to the PROGRAM. Each TEAM contains the following information
    - ref: the team reference
    - code: TEAM CODE
    - type: INDIVIDUAL/UNIT/CENTER/OTHER/ GEOGRAPHIC_ZONE…
    - name: the name of the team
    - description: the description of the team
    - subscription_ref: Reference of the SUBSCRIPTION where the CASE can enroll. Necessary for calling admission_create()
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

Request example

case_get_optional_programs( “LCAAAAAAAAAAAA”, 32131)

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

ERROR CODE

ERROR CODE
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 optional PROGRAMS for the selected CASE
CASE.NOT_FOUND	The CASE reference provided does not correspond to an existing CASE