Widgets

This page is under construction.

Aidbox Forms provides a set of widgets that allow you to build comprehensive and user-friendly medical forms. Widgets are pre-defined elements that you can add to your forms to capture various types of data from users.

This section details the various widgets available in Aidbox Forms and their corresponding settings.

Common Widget’s Settings

In the widget settings, you can define various parameters that determine its appearance and behavior. Here are the main settings you can configure for most widgets

General

LinkId

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

It is generated automatically, but the user can change it.

System / Code / Display

The user can manually add several codes from different terminology systems (use 'add code' option). Or import this data from terminologies (use 'import code' option).

Code - a terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

System - identity of the terminology system.

Display - representation defined by the system

Text

The Text field is used to define content for sections, questions, or display items within a form.

Short Text

The Short Text field provides an alternative, abbreviated version of the text. It is particularly useful when rendering forms on smaller screens, such as mobile devices, where space is limited.

Size

The Size parameter allows user to define the width of a widget and arrange multiple widgets horizontally within a form.

• The form layout is based on a 12-column grid system.

• By setting the size of a widget:

  • Maximum Size (12 columns): The widget will span the entire width of the form (by default)

  • Partial Size:

    • If one widget is set to a width of 6 columns and another to 6 columns, both widgets will be displayed side by side on the same line.

    • Similarly, setting widths like 4, 4, and 4 will arrange three widgets horizontally in a row.

Hidden, Required, Read Only, and Repeats Settings

• Hidden: Hides the form item from user view while still allowing it to be used internally or for conditional logic.

• Required: Ensures the user must provide input for the item before submitting the form.

• Read Only: Displays the form item as non-editable, allowing users to view but not modify its value.

• Repeats: Enables the user to dynamically add multiple instances of the same form item as needed.

Collapsible

Collapsible section is supported to enhance the usability and navigation of long questionnaires. This feature allows the child items of a group or question item to be displayed in a collapsible form, letting users toggle between showing and hiding nested items.

There are options:

1. Not Collapsible: The section is always fully expanded, and its child items are visible.

2. Collapsible (Open by Default): The section is collapsible and starts in an expanded state. Users can collapse it if desired.

3. Collapsible (Closed by Default): The section is collapsible and starts in a collapsed state. Users can expand it to view the child items.

User can set the desired collapsibility option for specific sections or items within the questionnaire.

Media

Image

Allows you to add an image next to a form item, enhancing its visual appeal or providing additional context. The user needs to provide a publicly available URL for the image.

Tooltip

Displays additional information when the user clicks the question mark icon in the top-right corner of a field, offering guidance or clarification.

Support Link

The Support Link option allows you to associate an external or internal link with a question, group, or display item within a form. This is particularly useful for providing users with additional descriptive details or reference material.

• When a support link is added, an icon appears immediately.

• Users can click on the icon to navigate to the linked resource, typically displayed in a separate page or browser tab.

Use Cases:

• Providing contextual help or instructions for complex questions.

• Linking to guidelines, manuals, or regulatory references.

• Adding reference material for specific sections or items in the form.

This feature enhances the usability of forms by ensuring users have access to additional information without cluttering the main form interface.

Attributes

Each widget in Aidbox Forms has its own set of customizable attributes that define its behavior, appearance, and functionality.

Rule

Data extraction

Aidbox Forms supports two options for data extraction: Observation-Based and Definition-Based. These options provide flexibility in how form data is transformed into different FHIR resources.

1. Observation-based extraction: It allows data collected through a Questionnaire Response (QR) to be extracted and stored in FHIR Observation resources.

Ensure that each item has both a code and a system defined.

Current Logic:

• A new Observation is created for each Questionnaire Response instance at the time of data extraction.

• If a QR is amended (modified after submission), the existing Observations linked to that QR are updated accordingly.

For detailed instructions and an example of extracting data into an Observation resource, visit the Observation-Based Extraction Guide.

1. Definition-based extraction: It maps form data dynamically to the corresponding FHIR resources.

When configuring extraction, you must specify a FHIR Path expression in the Path field. This expression defines the resource and field where the data should be extracted.

Current Logic:

Two Options for Resource Extraction:

• New Resource: If "new resource" is selected, a new resource is always created during extraction.Comment

• Existing Resource: If "existing resource" is selected, the system includes the questionnaire-itemExtractionContext extension. This extension can be added either at the root of the Questionnaire or at any item level. It identifies the resource that serves as the context for extraction.Comment

Using itemExtractionContext:

• Empty itemExtractionContext: When the itemExtractionContext is empty, the Questionnaire is used to create a new resource.

• Populated itemExtractionContext: If the itemExtractionContext contains a resource (or set of resources), the Questionnaire updates the existing resource.

For detailed instructions and an example of extracting data into a Patient resource, visit the Definition-Based Extraction Guide.

Population

Aidbox Forms provide three options for pre-filling the field:

1. Initial Value: For all fields except groups and display widgets, the user can set the default value. If the user does not change the value, this is what will appear in the completed QuestionnaireResponse.

2. Observation: Used to pre-fill a field with values ​​that are stored in the database in the Observation resources. To do this, the user needs to select the time period during which these observations could have been made. The mechanism is described in more detail in the FHIR SDC specification.

3. Expression: This approach to population is more generic. It supports retrieving data from any queryable FHIR resources available in the database. Those queries can be based on the context in which the QuestionnaireResponse is being generated and/or on the results of other queries. The user needs to use FHIRPath for this purpose. For more detail go to the FHIR SDC specification.

Description of widgets

Annotation Pad

The Annotation Pad widget allows users to draw or write annotations directly within a form. This is particularly useful for capturing visual information, sketches, or handwritten notes that cannot be easily captured through text inputs. The Annotation Pad widget provides a flexible and intuitive way to gather this type of data.

Settings:

• Background image: An image that will be displayed as the background of the annotation area.

• Pen Color: The color of the pen used for drawing or writing.

• Pen Thickness: The thickness of the pen used for drawing or writing.

• Erase Option: A tool for erasing parts of the drawing or writing.

The annotation will be saved as base64 encoded attachment in QuestionnaireResponse.

Speech to text

The Speech to Text widget allows users to input text by speaking, which is then automatically transcribed into the form. This is especially useful for capturing detailed information or notes, making the form-filling process faster and more efficient.

Settings:

• Language: The language in which the speech will be recognised and transcribed. The list of supported languages: Chinese, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, Hungarian, Italian, Japanese, Korean, Polish, Russian, Spanish.

Choice

The Choice widget allows users to select one or more options from a predefined list of options and it is displayed on the form as a drop-down list.

Settings:

• Multiple Selection: An option to allow the user to select more than one choice. To enable multiple selection, need to set repeats flag.

• Options: A list of values that the user can choose from.

  • Each option should have a display text, code and system. The user can fill in values ​​or use the import option. In this case, the user will be given the opportunity to select a terminology server, select a valueset in it and find the needed coded value, then the code, system and display will be automatically filled in.

  • Optionally, the user can include a score to each option and show the score if needed, which will be taken into account in the calculations. To do this, need to click on the include score and show score boxes.

  • Instead of inlining options into the form, the use can use a ValueSet that is stored in the Aidbox instance. To do this, the user need to click on the ValueSet box and select the ValueSet.

Open Choice

The Open Choice widget allows users to select from a predefined list of options or input their own custom answers. This is particularly useful in scenarios where the provided options may not cover all possible answers, giving users the flexibility to provide a more accurate response.

it is displayed on the form as a drop-down list.

Settings:

• Options: A list of values that the user can choose from.

  • Each option should have a display text, code and system. The user can fill in values ​​or use the import option. In this case, the user will be given the opportunity to select a terminology server, select a valueset in it and find the needed coded value, then the code, system and display will be automatically filled in.

  • Optionally, the user can include a score to each option and show the score if needed, which will be taken into account in the calculations. To do this, need to click on the include score and show score boxes.

  • Instead of inlining options into the form, the use can use a ValueSet that is stored in the Aidbox instance. To do this, the user need to click on the ValueSet box and select the ValueSet.

• Open choice label: By default the ability to choose your own option is displayed as "specify other..", but the user can redefine the label for this.

• Multiple Selection: Not supported yet, but can be supported on demand.

Checkbox

The Checkbox widget allows users to toggle between two states: checked (true) and unchecked (false). This widget is ideal for scenarios where a binary choice is needed, such as accepting terms and conditions or indicating a simple yes/no answer.

Settings:

• Required: When using this flag, the initial value for the checkbox is set to false automatically. If the user does not change it when filling out the form, this value is included in the completed QuestionnaireResponse.

• Repeats: This option is not available for checkbox.

Radio Button

The Radio Button widget allows users to select one option from a set of predefined choices. This widget is ideal for scenarios where only a single selection is permitted.

Settings:

• Options: A list of values that the user can choose from.

  • Each option should have a display text, code and system. The user can fill in values ​​or use the import option. In this case, the user will be given the opportunity to select a terminology server, select a valueset in it and find the needed coded value, then the code, system and display will be automatically filled in.

  • Optionally, the user can include a score to each option and show the score if needed, which will be taken into account in the calculations. To do this, need to click on the include score and show score boxes.

• Orientation: Display orientation of the options (vertical or horizontal).

• Column Count: The number of columns used to display the options.

Checkbox List

The Checkbox List widget allows users to select multiple options from a predefined list. This widget is ideal for scenarios where multiple selections are permitted or required.

Settings:

• Options: A list of values that the user can choose from.

  • Each option should have a display text, code and system. The user can fill in values ​​or use the import option. In this case, the user will be given the opportunity to select a terminology server, select a valueset in it and find the needed coded value, then the code, system and display will be automatically filled in.

  • Optionally, the user can include a score to each option and show the score if needed, which will be taken into account in the calculations. To do this, need to click on the include score and show score boxes.

  • Instead of inlining options into the form, the use can use a ValueSet that is stored in the Aidbox instance. To do this, the user need to click on the ValueSet box and select the ValueSet.

• Orientation: Display orientation of the options (vertical or horizontal).

• Column Count: The number of columns used to display the options.

• Multiple Selection: An option to allow the user to select more than one choice. To enable multiple selection, need to set repeats flag, by default, this flag is set.

Attachment

The Attachment widget allows users to upload files as part of their form submission. This widget is particularly useful for scenarios where users need to upload supporting documents, images, or other types of files.

Settings:

• Allowed file-types: You can limit the types of files that can be uploaded (image, audio, video, pdf, doc, csv etc or specify other).

• Max File Size: Set the maximum file size (in kilobytes) allowed for upload.

Additional Functionality:

• File Preview: When using the form, the attached file can be viewed by opening it in a separate page. To do this, the user needs to click on the eye icon.

Only MP4, WebM и Ogg video file formats are available for preview.

The attached file will be saved as base64 encoded attachment in QuestionnaireResponse.