ITEM TYPE

OVERVIEW

One of the most important properties of an ITEM is its type. The ITEM TYPE defines what kind of value will be stored (a string, number, list of options...)

Note that depending on the ITEM TYPE, some properties of the ITEM TEMPLATE OBJECT make sense while others do not.

The following table shows the different ITEM TYPES, which properties  ITEM TEMPLATE OBJECT make sense, and the possible values for them

(*1) Any ITEM with a FORMULA property other than null cannot be edited. The formula sentence is calculated at form open and each time referred an ITEM value is changed

(*2) If an ITEM's DEF_VAL property may be defined by a default value or formula, the field will have a predefined value. But the actual ITEM value can be edited by the user. The DEF_VALUE property is ignored if the FORMULA property is not null. If default has the suffix "?set(true)" means that the value will already be informed the first time the form is opened, so the value will retain the 

The default value is only generated on form open and is not possible to recalculate, therefore, if a form B which contains a formula "DATA_CODE" that exists in form A, If by any chance the form B is opened before A is closed, the information containing the formula DATA_CODE will never be updated.

(*3) FILE formulas only allow to return a mime type

(*4) The formula must be GRAPH_SPIRO() or GRAPH_EVOLUTION()

(*5) To filter the files we need to decide were to place the valid extensions. If a FILE ITEM has the DATA_CODE = "FILE.SPIRO.PBD" or "FILE.SPIRO.BAS" the file is considered a spirometry.

(*6) The HTML stored in the ANSWER VALUE will be show as the ITEM's DESCRIPTION in browse mode form_get_summary () and cannot be edited

(*7) HIDDEN property indicates whether n ITEM should be displayed. This property affects the behavior of form_get_summary (), which will only return the ITEM if this property states that it is not hidden. There are 4 possible values:

• NULL / 0: The ITEM is always visible
• 1: The ITEM is always hidden
• 2: The ITEM is visible if the FORM has been closed
• 3: The ITEM is visible if the FORM is still open

(*8) In choice objects such as  V_CHECK, H_CHECK, H_RADIO, V_RADIO and COMBO "default value" or "formula" will determine the "Order of option" of the option that should be selected by default. Only V_CHECK and H_CHECK accepts several values as "default" (separated by "|").

(*9) JSON type is internal and used for creating questions and building templates 

(*10) FORM type is used to represent the summary of an existing FORM (defined by a FORM_CODE that is stored in the ITEM's DATA_CODE property). If multiple FORMs with the same FORM_CODE exist, the most recent will be used to show the summary

(*11) VAS stands for "Variable Analog Scale", which a value represented graphically as a slider and which can take values between a minimum and maximum value. The value can be incremented by a predefined 'VALUE INCREMENT' amount. For example, the temperature of a patient may be a number between 32º and 43º, and can be incremented in steps of 0.1º

(*12) VISIBILITY allows to enter a value or formula to control if this item is visible. This property is different from "CONDITIONED", because a conditioned question don't exists if the condition is "false" (there may be several ITEMS with the same DATA_CODE and some of the exists or not). The visibility only affects if the item is shown to the user. One possible application of visibility is to use the formula "SESSION.ROLE.REF = 39" (this will only show the question to a user with role "Patient"). In the VISIBILITY property the value "null" is interpreted as "true".

(*13) BARCODE_SCAN: This property is used to indicate that it may be possible for the user to enter the value of the ITEM by scanning a barcode. This is only a suggestion for the client APP because the API has no control on the way the items are presented to the user. Accepted values for this property are:

• NULL / 0: Do not allow barcode scan
• 1: Allow barcode scan and manual input
• 2: Allow only barcode scan