Aidbox Forms Library

The article outlines how to setup and use Aidbox Forms library

The Aidbox Forms Library offers forms in two formats: Aidbox format (DSL-based) and FHIR format (FHIR Questionnaire). These forms can be loaded into Aidbox using various methods:

  1. Using Aidbox SDC configuration project while creating a license on the Aidbox portal

  2. Using the Aidbox Community Notebook (FHIR Format Forms Only)

  3. Through the the Aidbox zen project

By offering multiple loading methods, the Aidbox Forms Library provides flexibility for users to choose the most suitable method for their needs.

1. Setup Aidbox Forms Library using Aidbox SDC configuration project on the Aidbox portal

When creating a license on the Aidbox portal, you need to select the Aidbox SDC configuration project. Then the forms from the library will be loaded into your instance

2. Setup Aidbox Forms Library using Aidbox Notebooks

This way you can only upload forms in the FHIR format (FHIR Questionnaire)

The Aidbox Forms Library has been updated to include the following forms in the FHIR format:

  • ROS (Review of System)

  • Physical Exam

  • Cough

  • Vitals Sign (coded in the LOINC code system)

  • PHQ2 / PHQ9 Depression form (coded in the LOINC code system)

Users can upload these forms using the fhir/$load operation and then open them in the Aidbox Forms module for editing according to their requirements.

Use Aidbox Forms Library notebook (community) for this purpose that is available in the Aidbox console of your instance.

3. Setup Aidbox Forms Library using Aidbox zen project

When you use aidbox-zen-sdc project as your project configuration - it already has aidbox-forms-library depency and several forms enabled.

Use library forms

To use Aidbox forms library you need to add it to your project dependencies and enable needed forms.

Add library to project dependencies


{:deps {aidbox-forms ""}}

Enable forms

To enable forms you need add them to import section of your project-entrypoint namespace (or some different namespace which will be loaded)

a) You can import them all by importing library root namespace

{ns sdc-box
 import #{aidbox.forms}

b) Or for more precise control - you can add them one by one.

{ns sdc-box
 import #{aidbox.forms.vitals 

After that, you can go to Aibox Forms UI and see

Change Library Forms

If you need to change one of the library form - you should copy it (as file) from library to your project /zrc directory and edit it there. To preserve your changes you commit them to git and push to remote git-repo.

Library Forms should not be edited manually - only used. Because these changes will not be pushed to upstream. And after restart you will get clean state of these forms.

Last updated