FORM TEMPLATE OBJECT

ID

Id

INTEGER

Local identifier of the FORM TEMPLATE

A unique identifier local to the DB instance. TASK TEMPLATES exported to another instance will not share the same ID.

REF

Ref

TEXT

FORM TEMPLATE reference

This value has been designed as a Universal Unique Identifier (UUID) to allow sharing TASK TEMPLATES with other instances.

Note that different versions of the same TASK TEMPLATE share the same REF value, and only changes the #TASK_TEMPL:VERSION value

VERSION

Version

DATE

Can have two values:

• NULL if the FORM TEMPLATE is a DRAFT version and it is not published yet

• UTC Date: Value assigned when a FORM TEMPLATE is published.

FORM_CODE

Form Code

TEXT

Code assigned to this FORM TEMPLATE

Is a code identifying the particular purpose of a form template. The description of the different available FORM_CODE can be found in the CODES library under the FORM_CODE codification. For example: code_search (session, "FORM_CODE", "SF36") will return the multilingual description of a TEMPLATE with FORM_CODE = SF36 in the active language of the session.

Some FORM_CODE are reserved for system use. System FORM_CODE are identified by a hash before the code (for example #NOTE)

NAME

Name

DESCRIPTION

Name of the FORM TEMPLATE

Is a short-name used to be displayed in the interface. The TEMPLATE name is of type DESCRIPTION and can be retrieved for all available languages or just for the active session languages

The name may include {{OBJECT CODE}} that will be replaced by by the value of an ITEM with this DATA_CODE when calling form_get_summary (), , mobile_form_get_summary  () and task_activity_list ().

DESCRIPTION

Description

DESCRIPTION

Description of the FORM TEMPLATE

Extended information about the purpose, potential uses, etc. of this particular TEMPLATE.

For example: "The Short Form (36) Health Survey is a patient-reported survey of patient health. The SF-36 is a measure of health status and an abbreviated variant of it, the SF-6D, is commonly used in health economics as a variable in the quality-adjusted life year calculation to determine the cost-effectiveness of a health treatment.

OWNER

Owner

TEXT or TEAM OBJECT

Indicates who is the owner of this FORM TEMPLATE. It can have two types of value:

• "PROGRAM": Indicates that this FORM TEMPLATE belongs only to the PROGRAM and is not a shared object (cannot be used by other PROGRAMS)

• A TEAM OBJECT: assigned when the FORM TEMPLATE is part of a library of objects that can be shared by multiple PROGRAMs

REF

Ref

TEXT

FORM TEMPLATE reference

This value has been designed as a Universal Unique Identifier (UUID) to allow sharing TASK TEMPLATES with other instances.

Note that different versions of the same TASK TEMPLATE share the same REF value, and only changes the #TASK_TEMPL:VERSION value

CREATION_DATE

Created

DATE

Date of creation of the FORM TEMPLATE

MODIFICATION_DATE

Modified

DATE

Date of last modification of the FORM TEMPLATE

PUBLISH_DATE

Publish Date

DATE

Indicates the publication status of a particular FORM TEMPLATE version. Possible values are:

• NULL: Indicating a "DRAFT" (unpublished) version

• DATE: The date when the TEMPLATE was published

ACCESS_TYPE

Access Type

TEXT

Indicates if this particular which team or user can access this TEMPLATE. Possible values:

• NULL: Indicating the privacy setting to this TEMPLATE will be set by the privacy settings of the LIBRARY the TEMPLATE belongs too.

• PUBLIC: If the TEMPLATE can be shared to everyone in different instances and TEAMS

• SHARED: If the TEMPLATE can be shared only with the PERSONS/TEAMS who OWNER wants

• PRIVATE: If the TEMPLATE is only for TEAM/PERSON private purposes in a instance

REVIEW

Review

BOOL

Indicates if it is required to display a summary when the active USER completes a FORM created from this FORM TEMPLATE

NAV_MODE

Navigation mode

Used to define how a client application should display the ITEMS contained in this FORM TEMPLATE. Possible values are:

• 0: Default. Show all the ITEMS of the FORM as a continuous list of ITEMs. The user can see all the ITEMs in the list

• 1: Step by Step. Show only one ITEM at a time. The User should be able to navigate through the ITEMs, but only one is visible.

• 2: Step by Step when FORM is open. Works like Step by Step, but only when a FORM generated from this FORM TEMPLATE is open. When the FORM is closed, it should behave as 'default' (show the complete list of ITEMS

• 3: Step by Step when FORM is closed. Works like Step by Step, but only when a FORM generated from this FORM TEMPLATE is closed. When the FORM is open, it should behave as 'default' (show the complete list of ITEMS)

SYNC_DATE

Sync Date

DATE

Used in FORM TEMPLATEs imported from another instance. Is the date of the last synchronization (update) of the local FORM TEMPLATE

SOURCE

Source

SOURCE

Used in FORM TEMPLATES imported from another instance. Provides the information about the procedence

ITEMS

Items

List of ITEM TEMPLATE OBJECT

List of ITEMS contained in this FORM TEMPLATE

An ITEM is generally a question to be asked to a USER, but can also be other type of object like an informative message, a FORMULA, an image, etc...

library_form_action_list ()

Returns a list of possible choices related with a program screen

library_form_delete_question()

Deletes a question from a FORM TEMPLATE

library_form_delete ()

Remove activity (form template) from a task.

library_form_get_question ()

This function get a XML with information of specific question in a template.

library_form_get ()

Gets FORM TEMPLATE details

library_form_owner_list ()

Obtain a list of possible owners ( teams or programs) of a FORM TEMPLATE where current user has access

library_form_question_move ()

Sets new order for questions of a FORM TEMPLATE

library_form_set_answer ()

Sets a value of specific field in a template. This specific field is determined in datacode of question in template.

library_form_set ()

Sets FORM TEMPLATE data

library_form_unlock_edit ()

Unlocks a FORM TEMPLATE from previous version to edit in draft

template_delete ()

Deletes an existing FORM TEMPLATE. When a FORM TEMPLATE is deleted, the existing FORMS using this template are preserved, but they are “detached” from the original FORM TEMPLATE

template_export ()

Downloads a FORM TEMPLATE into an XML file

template_get_summary ()

Gets the main information from a FORM TEMPLATE. It’s used by action_list to show a previsualization of the template

template_get ()

Retrieves an xml description of a FORM TEMPLATE

template_import ()

Loads an XML file containing a FORM TEMPLATE

template_insert ()

Creates a new FORM TEMPLATE from an XML file obtained from template_import ()

template_update ()

Updates a FORM TEMPLATE