/
"FORM" OBJECT CODE

"FORM" OBJECT CODE

Owned by Pedro Jose Sanchez Luling
Last updated: Dec 04, 2024
4 min read

Object code format

[parent_object.]FORM[{selector}][:scope].property

Possible parent objects

Example

 

Possible parent objects

Example

 

<none>

FORM.REF

Returns the reference of the same FORM where the OBJECT CODE is being evaluated

CASE

CASE.FORM{ELEGIBILITY}.REF

Returns the reference of all FORMs with FORM_CODE="ELEGIBILITY".

The FORMs will be searched in all ADMISSIONS that belong to the CASE the context ADMISSION (the ADMISSION where the OBJECT CODE is being evaluated)

Introduced in API Version 2.7.3

PROGRAM

PROGRAM.FORM{ELEGIBILITY}.REF

Returns the reference of a FORM with FORM_CODE="ELEGIBILITY".

The FORMs will be searched in all ADMISSIONS that belong to the PROGRAM of the context ADMISSION (the ADMISSION where the OBJECT CODE is being evaluated)

SUBSCRIPTION

SUBSCRIPTION.FORM{ELEGIBILITY}.REF

Returns the reference of a FORM with FORM_CODE="ELEGIBILITY".

The FORMs will be searched in all ADMISSIONS that belong to the SUBSCRIPTION of the context ADMISSION (the ADMISSION where the OBJECT CODE is being evaluated)

ADMISSION

ADMISSION.FORM{ELEGIBILITY}.REF

Returns the reference of a FORM with FORM_CODE="ELEGIBILITY".

The FORMs will be searched in all FORMs of the context ADMISSION (the ADMISSION where the OBJECT CODE is being evaluated)

TASK

TASK.FORM{ELEGIBILITY}.REF

Returns the reference of a FORM with FORM_CODE="ELEGIBILITY".

The FORMs will be searched in all FORMs of the parent TASK object

Returns information about a FORM

Scope options

This OBJECT CODE accepts the following scope expressions:

  • FIRST: The first FORM of a TASK (according to the order of the FORMs in the TASK)

  • LAST: The last FORM in a TASK (according to the order of the FORMs in the TASK)

  • A valid DATE SCOPE to define a date range for evaluating the OBJECT CODES. Note that the scope is referred to the TASK in which the OBJECT CODE has been invoked.

Note that when using the scopes FIRST and LAST, though apparently the expected output should be a unique FORM (the first or last FORM), in some circumstances may return more than one result. This happens when a parent object is explicitly specified and corresponds to more than one object.

For example, when you use the following expression: ADMISSION.TASK{ttt}.FORM{xxx}:LAST it could happen that multiple TASKS with TASK_CODE=”xxx” exist in the ADMISSION. In that situation, the evaluation of the OBJECT CODE will return an array composed by the last FORM included in each of those TASKS.

The following table shows some examples to understand the behavior:

 

Object Code

Returns

Object Code

Returns

ADMISSION.FORM{xxx}:LAST.REF

The reference of the last FORM with FORM_CODE=”xxx” in the last TASK (that contains that FORM) of the ADMISSION.

The evaluation returns only one value.

Before the fix applied in this issue the evaluation could return multiple values if there existed multiple TASKS with that FORM

ADMISSION.TASK.FORM{xxx}:LAST.REF

The reference of the last FORM in the current TASK

The evaluation returns only one value

ADMISSION.TASK:FIRST.FORM{xxx}:LAST.REF

The reference of the last FORM in the first TASK of the ADMISSION

The evaluation returns only one value

ADMISSION.TASK{ttt}.FORM{xxx}:LAST.REF

The last FORM in the all TASKs with TASK_CODE=”ttt” of the ADMISSION.

The evaluation may return a single value or an array (one per TASK)

Examples

OBJECT CODE EXPRESSION

Description

OBJECT CODE EXPRESSION

Description

TASK.FORM:FIRST.REF

returns the reference of the first FORM in the context TASK (the one in which the OBJECT CODE is being evaluated)

TASK{HEART_INFO}.FORM:LAST.REF

returns the reference of the last FORM in the TASK with TASK CODE = “HEART_INFO”

FORM{HEART_RATE}:7DAYS.REF

returns the reference of all FORMS with FORM CODE = “HEART_RATE” that have been closed in the last 7 days

Context information

Required context objects

Required context objects

TASK or ADMISSION or SUBSCRIPTION or PROGRAM or CASE

When this OBJECT CODE is used independently (no parent), only FORMs in the current TASK (the one where the OBJECT CODE is evaluated) are considered

Otherwise the FORM is searched in the scope defined by the parent OBJECT.

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

Properties

PROPERTY

DESCRIPTION

PROPERTY

DESCRIPTION

FORM.__SELF__

Returns an object that represents the FORM. This object is intended to be used in REPORT TEMPLATES

The properties of the object can retrieved from a REPORT TEMPLATE by means of the TWIG function ocGet() REPORT function

This is the default property if no one is specified

  • Introduced in API version 2.8.1

FORM{form_code / form_id}[:scope]

FORM object. The selector (optional) can be:

  • form_code: an alphanumeric string representing a FORM CODE

  • form_id: a numeric string representing a specific FORM_ID (Introduced in API version 2.7.11)

FORM{form_code / form_id}[:scope].REF

Form reference

FORM{form_code / form_id}[:scope].NAME.*

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

FORM{form_code / form_id}[:scope].DESC.*

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

FORM{form_code / form_id}[:scope].DATE

Date of last modification of the FORM

FORM{form_code / form_id}[:scope].STATUS

Status. It returns:

  • "OPEN"

  • "CLOSED"

  • "HIDDEN"

  • "CANCELLED": This status correspond to FORMs that were open when the TASK was cancelled. Introduced in API version 2.7.20

  • "EXPIRED": This status correspond to FORMs that were open when the TASK was cancelled. Introduced in API version 2.7.21

TASK{selector}[:scope].ARRAY{X}.*

ARRAYs with CODE=”X” of the FORM

Introduced in API version 2.8.1

FORM{form_code / form_id}[:scope].ITEM.*

An ITEM in the FORM. Only ITEMS in closed FORMS are considered unless no selector is specified for the FORM (i.e. the ITEM referenced is part of the current FORM)

FORM{form_code / form_id}[:scope].DATA.[data_code]

A DATA_CODE in the FORM

 

Related content