/
"PROTOCOL" OBJECT CODE

"PROTOCOL" OBJECT CODE

Introduced in API version 2.8.1

Object code format

[parent_object.]PROTOCOL[{selector}].property

Possible parent objects

Example

Comments

Possible parent objects

Example

Comments

ADMISSION

ADMISSION.PROTOCOL.VERSION

Returns the PROTOCOL the parent ADMISSION object

PROGRAM

PROGRAM{XX}.PROTOCOL{YY}.NAME

Returns the name of the PROTOCOL with code YY of the PROGRAM with code XX.

Returns information about a PROTOCOL OBJECT. If no selector is provided, then the PROGRAM is obtained from the ADMISSION in the context (ADMISSION where the OBJECT CODE is evaluated).

Otherwise the selector must be a valid PROTOCOL CODE or PROTOCOL reference.

Context information

Required context objects

Required context objects

ADMISSION

When this OBJECT CODE is used independently (no parent), the context information used to evaluate its value is determined by the ADMISSION where the OBJECT CODE is evaluated.

Otherwise the context information is inherited from the parent OBJECT.

If no selector has been provided in the OBJECT CODE (e..g. PROTOCOL.REF), then the PROTOCOL used to calculate the properties is the one where the OBJECT CODE is evaluated. Otherwise the PROTOCOL/s that correspond to the desired selector (e.g. PROGRAM{ACTIVITY_COACHING}.PROTOCOL.REF) will be used.

PRIVACY CONSIDERATIONS: The

if(evaluation of this OBJECT CODE only allows to access information where the active user has privileges:

  • If the active USER is a professional, then only the information in SUBSCRIPTIONS where the professional is member and the CASE has and ADMISSION will be considered.

  • If the active USER is a CASE, then all PROTOCOLS of PROGRAMS where the CASE has an ADMISSION will be considered.

Properties

PROPERTY

DESCRIPTION

PROPERTY

DESCRIPTION

PROTOCOL{protocol_code / protocol_ref}.REF

PROTOCOL reference.

PROTOCOL{protocol_code / protocol_ref}.CODE

PROTOCOL code.

PROTOCOL{protocol_code / protocol_ref}.NAME.*

An object of type "DESCRIPTION" OBJECT CODE that contains the name of the PROTOCOL.

PROTOCOL{protocol_code / protocol_ref}.DESC.*

An object of type "DESCRIPTION" OBJECT CODE that contains the description of the PROTOCOL.