Function prototype	admission_create ( session, case, subscription , date, [team=null], [allow_incomplete=false], [setup_values=null] )
API Version	2.6.14 and higher

This function enrolls a CASE in a SUBSCRIPTIONCreates a new ADMISSION for the selected case. The ADMISSION will have a life cycle where its status will evolve until a final status (usually "DISCHARGED"). See ADMISSION life cycle If parameter team is not specified, the admission will be created in the ACTIVE TEAM related with session. There are some requirements to create a valid ADMISSION: *case: the reference of the CASE associated to the ADMISSION. 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. subscription* is a valid SUBSCRIPTION *team* is a valid TEAM (if indicated). If null, the ACTIVE TEAM will be used. Furthermore, the TEAM must be member of the SUBSCRIPTION with role CASE MANAGER Active user has the required privileges: The active user is CASE MANAGER as a direct member of the SUBSCRIPTION Or team is CASE MANAGER member of the SUBSCRIPTION and the active user is CASE MANAGER into team Or the active user also the same person than CASE, and the SUBSCRIPTION belongs to one of the optional PROGRAMS of the CASE (see case_get_optional_programs()) Or the active user is an ASSOCIATE of the CASE with the permission to edit TASKS, and the SUBSCRIPTION belongs to one of the optional PROGRAMS of the CASE (see case_get_optional_programs()) The case provided has all the information required by the FORMAT SETTINGS assigned to the SUBSCRIPTION (see FORMAT SETTINGS Considerations below) It doesn't exist a previous ADMISSION in the same SUBSCRIPTION that prevents the creation of a new ADMISSION. See Multiple ADMISSIONS in the same SUBSCRIPTION for mor details.
Input parameters:	session: is the session id obtained in the session_init call case: is a case reference ID obtained by the URL or with the calls: case_list(), case_search() or case_get() subscription: ID of subscription in program where new admission will be created, if is null subscription should be set previously with /wiki/spaces/DES/pages/16974337 date: The date to be reported as “enrollment date”. The date is expected to be expressed in the session's local timezone. team: the TEAM that will be assigned to the ADMISSION. If not provided, the active session's TEAM will be used *allow_incomplete: (default = false). Added in API Version 2.7.12. If true, the ADMISSION will be created even when not all information required by the FORMAT SETTINGS of the ADMISSION are present. In this situation, the ADMISSION will be created with status "INCOMPLETE" and it will not become active until all the missing information is entered (using case_set_contact () function). See FORMAT SETTINGS Considerations below setup_values*: JSON string with values that should be assigned to TASKS defined in STAGE "ADMISSION_SETUP". If provided, the ITEMS of the TASKS will be initialized with the values provided. Introduced in API Version 2.7.18. The JSON string must represent a simple object with a list of property names and values. For example: `'{"setup_field": 1, "other_setup_field": "example value"}'`
Output parameters:	result: Basic information about the new ADMISSION ref: Reference to the new ADMISSION type: (NEW / EXIST) Indicates if a new ADMISSION was created or an existing one was returned. When there exist an active ADMISSION for the selected subscription, admission_create() will not insert a new ADMISSION, and instead it will return the reference to the existing one. Introduced in API Version 2.7.15 status: Status of the ADMISSION. Introduced in API Version 2.7.12 data: full ADMISSION information. The contents is the same than the generated by admission_get (). Introduced in API Version 2.7.18 next_task: First TASK in the new ADMISSION that is assigned to the session user next_form: First FORM of the TASK referenced by next_task next_question: First question o the first FORM referenced by next_task/next_form that needs to be answered in the new ADMISSION next_question_strict: First question o the FORM referenced by next_task/next_form in the new ADMISSION (no matter if it needs to be answered, e.g. a STATIC TEXT question) ErrorMsg: If an error occurs, returns the error message translated to the session language ErrorCode: If an error occurs, one of the possible ERROR CODES
Request sample:	admission_create ( 'LCAAAAAAAAAAAAAAAA', 1234, 543, '2012-01-01 00:00:00', null, false, '{"setup_field": 1, "other_setup_field": "example value"}');
Response sample:	<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result> <admission> <ref>3213</ref> <type>NEW</type> <status>ENROLLED</status> <data> ... </data> <next_question>{form_id/}12</next_question> <next_question_strict>11</next_question_strict> <next_form></next_form> <next_task></next_task> </admission> </result> <ErrorMsg><ErrorMsg> <ErrorCode><ErrorCode>
Notes:

Return Error codes

ERROR CODE
INVALID_TOKEN	The session token provided is not valid
CASE.NOT_FOUND	The CASE reference provided does not correspond to an existing CASE
SUBSCRIPTION.NOT_FOUND	The SUBSCRIPTION reference provided does not correspond to an existing SUBSCRIPTION
TEAM.NOT_FOUND	The TEAM reference provided does not correspond to a valid TEAM
INSUFFICIENT_PRIVILEGES	The session user does not have the necessary privileges to create an ADMISSION in the SUBSCRIPTION or the TEAM reference provided is not a member of the SUBSCRIPTION
ADMISSION.INSERT_ERROR	An error occurred when inserting the ADMISSION in the database
CONTACT.DATA_VALIDATION	The case provided does not have all the information required by the FORMAT SETTINGS associated to the SUBSCRIPTION

FORMAT SETTINGS considerations

When the system tries to create an ADMISSION, it must check whether the CASE selected has all the information required or not. This verification is done looking for the FORMAT SETTINGS that correspond to the ADMISSION and checking if all the required properties of the CASE are present.

For example, if FORMAT SETTINGS indicate that it is necessary an email address but the CASE does not have one informed, the function will return a validation error.

Multiple ADMISSIONs in the same SUBSCRIPTION

It is not allowed to create a new ADMISSION in a SUBSCRIPTION if already exists an active one (ADMISSION status is 'INCOMPLETE', 'ENROLL', 'ACTIVE' or 'PAUSE'). If an active ADMISSION exists, admission_create() will return the information of the existing ADMISSION.

It is not allowed to create a new ADMISSION in a SUBSCRIPTION if already exists a finished ADMISSION ('DISCHARGED') and the SUBSCRIPTION defines some setting that prevent the creation of new ADMISSIONs during certain time lapse from the creation of the previous ADMISSION. These parameters are defined as SUBSCRIPTION PARAMETERS and are the following:

INVITATION_REF: Contains a value used as an invitation reference. If this value is not empty, when a new ADMISSION is created, the platform will search other ADMISSION of the same patient in the same SUBSCRIPTION that have the same value for INVITATION_REF (this value is stored along with the ADMISSION when it is created). Depending on the value of the following parameter (INVITATION_TERM), the new ADMISSION can be created (or not).
INVITATION_TERM: A value expressed in hours. If not empty, this value indicates the minimum time that must pass from the creation of a previous ADMISSION for the same patient and with the same INVITATION_REF in the same SUBSCRIPTION

Incomplete ADMISSIONS

When the parameter allow_incomplete is "true", it is possible to create the ADMISSION even when not all the information required by the FORMAT SETTINGS is valid or present.

Nevertheless, FORMAT SETTINGS may define a set of minimum conditions that are always mandatory, and if that information is not present then the ADMISSION will never be created. See FORMAT SETTINGS to discover how to define this conditions.

Browser not supported