docs.healthdata.beHD DCD XLSForm Overview
Last updated: 2025-10-07 15:43
This page is a work-in-progress reference for all available functions in XLS Forms used by healthdata.be to create Data Collection Definitions. It is divided into the three possible sheets: survey, choices, and settings.
survey
This sheet is mandatory in all XLSForms.
| Category | Item | Description |
|---|---|---|
| Column headers | ||
| type | Sets the question type, see below. | |
| name | Unique variable name | |
| label::[language] | Label visible in the form. Currently English, French and Dutch are supported. | |
| hint::[language] | Providing a help text description. | |
| guidance_hint::[language] | Providing a help text tooltip. | |
| constraint | Specifying additional validations on the provided data. | |
| constraint_message::[language] | The message a user is shown if the response was not valid | |
| required | Whether a variable is mandatory to be provided. | |
| required_message::[language]] | Allows to customize the error message if required question is not answered | |
| default | A default value that is pre-filled before the user gets to the question | |
| relevant | Skip logic condition (the relevant condition that needs to be fulfilled in order for the present question to be displayed) | |
| read_only | Whether a question response can be edited | |
| calculation | For specific calculations. | |
| appearance | Includes variable specifics. | |
| Supported question types | ||
| select_one [choices] [or_other] | User can choose one of several choices | |
| select_multiple [choices] [or_other] | User can choose one or more of several choices | |
| select_one_from_file [file] | User can choose one of several choices from an external file | |
| select_multiple_from_file [file] | User can choose one or more of several choices from an external file | |
| text | User can enter a text response | |
| integer | User can enter an integer | |
| decimal | User can enter a decimal number | |
| date | User can enter a date | |
| time | User can enter a time of day | |
| datetime | User can enter date and time together | |
| note | User is shown a note (no response possible) | |
| calculate | Specifically calculated parameter | |
| Groups | Groups contain one or more questions, or other nested groups, which may loop (repeat) | |
| begin_group | Sets the beginning of a group | |
| end_group | Ends the group | |
| begin_repeat | Sets the beginning of a repeat group | |
| end_repeat | Ends the repeat group | |
| Form variable references | ||
| ${variable_name} | Reference another question (can be used in skip logic condition [relevant], validation, inside another question or hint label | |
| . | Current question |
choices
The choices sheet contains the options for the select_one or select_multiple questions in the file.
| Item | Description |
|---|---|
| list_name | A unique name for each set of choices |
| name | Identifier or code of the specific choice. |
| label::[language] | Choice label,visible in the form. Currently English, French and Dutch are supported. |
| name::system | Possibility to refer to which naming or coding system is used . |
| mdm:xxxxx | References for internal healthdata.be purposes |
settings
The settings sheet and all of its items are optional.
| Item | Description |
|---|---|
| form_title | Title displayed at beginning of form, in form list |
hd
The hd sheet contains healthdata.be specific data and/or metadata related to the project.