subscription_suggested_program_list ( session, program, team [, subscription] )

2.7.28

SOAP, REST

Input

• session: Session token obtained by calling session_init ()

• program: Reference to the PROGRAM of the SUBSCRIPTION

• team: Reference of the TEAM OWNER of the SUBSCRIPTION

• subscription: id of subscription (optional). If this value is provided, then program and team are ignored. The most recent SUBSCRIPTION for the indicated program and team will be used

Output

• result: XML with information about the SUBSCRIPTION

  • ref: reference of the SUBSCRIPTION.

  • editable: (true/false) Indicates whether the active USER has permission to modify the list of suggested PROGRAMS

  • suggested_programs: List of PROGRAMS suggested to the patients that have an ADMISSION in this SUBSCRIPTION. Each element of the list is in fact another SUBSCRIPTION that a CASE can join. CASES are allowed to do a self-enroll (using the API function admission_create () ) in any of the suggested PROGRAMS, so it is not necessary a PROFESSIONAL to do the enroll

    • ref: reference of the suggested SUBSCRIPTION

    • program: basic information about the PROGRAM

      • ref: reference to the PROGRAM

      • code: PROGRAM CODE

      • name: Name of the program

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

    • team: basic information about the TEAM owner of the suggested SUBSCRIPTION

      • ref: the team reference

      • code: TEAM CODE

      • type: INDIVIDUAL/UNIT/CENTER/OTHER/ GEOGRAPHIC_ZONE…

      • name: the name of the team

    • condition: a FORM FORMULAS that will be evaluated to decide whether the suggested PROGRAM is available for a CASE (when invoking the function case_get_optional_programs () )

• 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

WRONG_PARAMS

It is necessary to provide the parameters (program and team) or subscription

SUBSCRIPTION.NOT_FOUND

The SUBSCRIPTION was not found