Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/aidbox-forms/access-control-in-forms.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Configure access control for Aidbox Forms with roles like SDC Admin, Form Designer, Form Filler, and Response Manager.
description: Configure access control for Formbox with roles like SDC Admin, Form Designer, Form Filler, and Response Manager.
---

# Access control in forms
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/aidbox-forms/adaptive-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In SDC, adaptive forms are typically implemented through the **Questionnaire/$ne

### Aidbox Implementation

Aidbox supports **Adaptive Forms** as part of the **Aidbox Forms** product, following the SDC Adaptive Form workflow.
Aidbox supports **Adaptive Forms** as part of the **Formbox** product, following the SDC Adaptive Form workflow.

Aidbox implements the following key elements:

Expand Down Expand Up @@ -116,7 +116,7 @@ This ensures compatibility with both standard SDC adaptive forms and Aidbox-spec

### Forms Builder

In the **Aidbox Forms Builder**, form authors can enable **Adaptive Mode** for a Questionnaire:
In the **Formbox Builder**, form authors can enable **Adaptive Mode** for a Questionnaire:

* for demonstration purposes (select \***Adaptive Form** option)
* for specifying their assessment center (set URL for Adaptive form)
Expand All @@ -128,7 +128,7 @@ In the **Aidbox Forms Builder**, form authors can enable **Adaptive Mode** for a

### Form Renderer

The **Aidbox Form Renderer** provides a runtime engine for adaptive questionnaires.
The **Formbox Renderer** provides a runtime engine for adaptive questionnaires.

Key behaviors:

Expand Down
10 changes: 5 additions & 5 deletions docs/modules/aidbox-forms/aidbox-form-gallery.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: The article outlines how to use forms from Aidbox Form Gallery
description: The article outlines how to use forms from Formbox Gallery
---

# Aidbox Form Gallery

The Aidbox Form Gallery offers forms in FHIR format (FHIR Questionnaire). There are more than 3000 forms in the Aidbox Form Gallery. 
The Formbox Gallery offers forms in FHIR format (FHIR Questionnaire). There are more than 3000 forms in the Formbox Gallery. 

Previews of these forms are available [here](https://form-builder.aidbox.app/).

Expand All @@ -16,15 +16,15 @@ These forms can be loaded into Aidbox using various methods:

## 1. Using the Aidbox Community Notebook (limited set of forms for demo) 

The Aidbox Form Gallery includes the following forms in FHIR format:
The Formbox Gallery includes the following forms in 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. 
Users can upload these forms using the `fhir/$load` operation and then open them in the Formbox module for editing according to their requirements. 

Use the Aidbox Form Gallery notebook (community) available in the Aidbox console of your instance for this purpose.

Expand All @@ -41,7 +41,7 @@ Follow these steps:

## 3. Searching and importing a form from the Aidbox Form Gallery inside the Aidbox Instance

Open the Aidbox console and navigate to the Aidbox Forms page, you will find the Form Gallery section. There, you will discover over 3000 form templates. 
Open the Aidbox console and navigate to the Forms page, you will find the Form Gallery section. There, you will discover over 3000 form templates. 

These templates can be:

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/aidbox-forms/aidbox-forms-interface.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: Navigate Aidbox Forms UI including Form Templates, Responses, and Form Gallery with search, filter, and sharing features.
description: Navigate Formbox UI including Form Templates, Responses, and Form Gallery with search, filter, and sharing features.
---

# Aidbox Forms Interface
# Formbox Interface

The Forms UI consists of three main sections, accessible through tabs at the left side of the page:

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/aidbox-forms/aidbox-ui-builder-alpha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ This tool is based on the [FHIR SDC Implementation Guide ](https://build.fhir.or

In FHIR, forms are represented using the [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html) resource and completed forms are represented using the [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) resource. All these resources will be stored in the AIdbox FHIR Storage.

Aidbox Forms module provides available APIs:
Formbox module provides available APIs:

* [FHIR API](../../../api/rest-api/fhir-search/README.md) - to interact with FHIR Questionnaire, FHIR QuestionnaireResponse and other FHIR resources.
* [FHIR SDC API](../../../reference/aidbox-forms-reference/fhir-sdc-api.md)- a set of aditional operstions to interact with form and data.

## Getting started

* Open [http://localhost:8080/ ](http://localhost:8080/), using login / passwod - admin / admin
* Go to forms by pressing the button `Aidbox Forms` (or by visiting [http://localhost:8080/ui/sdc](http://localhost:8080/ui/sdc) )
* Go to forms by pressing the button `Formbox` (or by visiting [http://localhost:8080/ui/sdc](http://localhost:8080/ui/sdc) )
* Go to the `Forms` page
* Press on `Create Template` button
* Press on `Create in UI Builder` button
Expand All @@ -46,6 +46,6 @@ Go to this [page](./form-creation/README.md) to start designing a form.

## Create form from FHIR Questionnaire (Import Quetionnaire)

If you already have ready-made FHIR Questionnaires (your own or from external sources), you can load them into the Aidbox Forms module via `POST/` operation or using Import Questionnaire button on the Form Templates page, open them in the UI Builder, customise and save them.
If you already have ready-made FHIR Questionnaires (your own or from external sources), you can load them into the Formbox module via `POST/` operation or using Import Questionnaire button on the Form Templates page, open them in the UI Builder, customise and save them.

Go to this [page](./import-questionnaire.md) to start it.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Configure Aidbox Forms builder and renderer with language, themes, URL prefixes, redirects, and audit logging.
description: Configure Formbox builder and renderer with language, themes, URL prefixes, redirects, and audit logging.
---

# Configuration
Expand All @@ -8,15 +8,15 @@ description: Configure Aidbox Forms builder and renderer with language, themes,

### Overview

The Aidbox Forms implements a FHIR-compliant Configuration resource that enables fine-grained control over form builder and renderer behavior. This resource adheres to CRUD operations via the standard FHIR API endpoints. The Configuration resource schema encompasses parameters such as:
The Formbox implements a FHIR-compliant Configuration resource that enables fine-grained control over form builder and renderer behavior. This resource adheres to CRUD operations via the standard FHIR API endpoints. The Configuration resource schema encompasses parameters such as:

* User Interface Settings: Default language and theme preferences.
* Form Builder Configuration: Settings that control the behavior and appearance of the form creation interface.
* Form Renderer Configuration: Parameters that define how forms are displayed and interacted with by end-users.
* Navigation and Workflow Controls: Settings for redirects, button visibility, and form state (e.g., read-only mode).
* Logging and Auditing: Configurations related to event tracking and application identification.

A global Configuration resource can be instantiated to serve as the system-wide default, applying to all Questionnaire resources unless explicitly overridden. The system supports configuration inheritance and overriding. When generating a shared form link, developers can specify a custom Configuration resource reference. This allows for context-specific rendering behavior, ensuring that the form presentation adheres to the designated configuration parameters. This architecture facilitates flexible, hierarchical configuration management, enabling both system-wide defaults and use-case specific customizations within the Aidbox Forms ecosystem.
A global Configuration resource can be instantiated to serve as the system-wide default, applying to all Questionnaire resources unless explicitly overridden. The system supports configuration inheritance and overriding. When generating a shared form link, developers can specify a custom Configuration resource reference. This allows for context-specific rendering behavior, ensuring that the form presentation adheres to the designated configuration parameters. This architecture facilitates flexible, hierarchical configuration management, enabling both system-wide defaults and use-case specific customizations within the Formbox ecosystem.

### Configuration Resource Structure

Expand Down Expand Up @@ -217,7 +217,7 @@ GET /$sdc-config

## Theme

`QuestionnaireTheme` resource allows you to customize the appearance of the Aidbox Form Renderer. The theme resource can include the following properties:
`QuestionnaireTheme` resource allows you to customize the appearance of the Formbox Renderer. The theme resource can include the following properties:

```json5
{
Expand Down Expand Up @@ -263,19 +263,19 @@ All of these properties are optional, and you can customize the theme to suit yo

The design system defines the overall look and feel of a form, including common styles, fonts, colors, widgets, and layout.

Currently, Aidbox Forms supports three design systems:
Currently, Formbox supports three design systems:

- **aidbox-desktop** – The default Aidbox Forms design system. Widgets are adaptive and optimized for forms with many questions, suitable for both desktop and mobile devices.
- **aidbox-desktop** – The default Formbox design system. Widgets are adaptive and optimized for forms with many questions, suitable for both desktop and mobile devices.
- **aidbox-mobile** – Optimized for entry modes `sequential` and `prior-edit`, where only one question appears on screen at a time. Widgets are tailored for touch screens and mobile devices.
- **NHS** – Widgets and layouts fully follow the [NHS Design System](https://service-manual.nhs.uk/design-system/). Typically used for embedding forms into NHS applications. Supports only `sequential` and `prior-edit` entry modes.

You can set the design system using the `design-system` property.

## Translations

The translations object in the Configuration resource allows defining custom text for the Aidbox Form Builder and Renderer. It uses a structured, hierarchical format where each key corresponds to a feature or component, and the leaf nodes specify locale-based translations. This structure supports multiple languages and regional variations by enabling you to specify locale codes such as en for English, fr for French, or more granular options like en-US for American English and fr-CA for Canadian French.
The translations object in the Configuration resource allows defining custom text for Formbox Builder and Renderer. It uses a structured, hierarchical format where each key corresponds to a feature or component, and the leaf nodes specify locale-based translations. This structure supports multiple languages and regional variations by enabling you to specify locale codes such as en for English, fr for French, or more granular options like en-US for American English and fr-CA for Canadian French.

The example provided below represents a comprehensive translations object for English, covering all possible keys. You can extend this object by adding translations for additional languages. If a specific language (e.g., en for English or any other) is omitted, the Aidbox Form will use its standard default translations for that language.
The example provided below represents a comprehensive translations object for English, covering all possible keys. You can extend this object by adding translations for additional languages. If a specific language (e.g., en for English or any other) is omitted, the Formbox will use its standard default translations for that language.

```json
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
description: >-
Embedding the Aidbox Form Builder and Renderer into your application using web
Embedding the Formbox Builder and Renderer into your application using web
components.
---

# Embedding

## Embedding Aidbox Form Builder and Renderer
## Embedding Formbox Builder and Renderer

You can embed the **Builder** and **Renderer** into your application or website using web components.
The Renderer can also be embedded directly as an iframe using SDC SMART Web Messaging (SWM).

### Renderer in an iframe (SDC SWM)

The Aidbox Forms renderer also supports [SDC SMART Web Messaging](https://github.com/brianpos/sdc-smart-web-messaging). You can embed it directly in an iframe and communicate via `postMessage`, without the web component wrapper.
The Formbox renderer also supports [SDC SMART Web Messaging](https://github.com/brianpos/sdc-smart-web-messaging). You can embed it directly in an iframe and communicate via `postMessage`, without the web component wrapper.

* **Builder** allows users to create and manage forms directly within your application.
* **Renderer** enables users to fill out forms within your application without leaving your platform.
Expand Down Expand Up @@ -197,7 +197,7 @@ For more complex use cases, such as attaching authorization headers or storing q

Allows to preview attachments in an external editor or viewer.

Return `false` to use default Aidbox Forms attachment preview, or `true` to prevent default behavior and show your previewer.
Return `false` to use default Formbox attachment preview, or `true` to prevent default behavior and show your previewer.

```html
<aidbox-form-renderer id="aidbox-form-renderer" />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
description: This article outlines how to use Aidbox Forms with external FHIR servers.
description: This article outlines how to use Formbox with external FHIR servers.
---

# External FHIR servers as a data backend

## Overview

Aidbox Forms module uses Aidbox's FHIR API capabilities to store all it's data. But sometimes it's appropriate to use other FHIR backends. Aidbox Forms provides a simple and granular way to specify external FHIR servers for data management.
Formbox module uses Aidbox's FHIR API capabilities to store all it's data. But sometimes it's appropriate to use other FHIR backends. Formbox provides a simple and granular way to specify external FHIR servers for data management.

## Data Domains

Data used by `Aidbox Forms` has different nature and can have different storage requirements and strategies.
Data used by `Formbox` has different nature and can have different storage requirements and strategies.

We split data in 4 domains, and last 3 of them can have it's own FHIR backend:

> Because `system resources` are non FHIR resources - there is no FHIR backend configuration for them.

1. `System resources` - non-FHIR resources, used by `Aidbox Forms` for extended functionality.
1. `System resources` - non-FHIR resources, used by `Formbox` for extended functionality.
2. `Content resources` - `Questionnaire` resource (the main focus and result of `Forms Builder`).
3. `Terminology resources` - `ValueSets` and `Concepts`.
4. `Production resources` - `QuestionnaireResponse` resource and other FHIR resources that contain PHI/Production data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Build custom FHIR questionnaire renderers as standalone pages for Aidbox Forms Builder preview using SDC SMART Web Messaging.
description: Build custom FHIR questionnaire renderers as standalone pages for Formbox Builder preview using SDC SMART Web Messaging.
---

# External Form Renderer in Builder Preview
Expand Down Expand Up @@ -126,7 +126,7 @@ If your renderer emits updates, send [sdc.ui.changedQuestionnaireResponse](https
4) Provide a name and a renderer URL.
5) Save and select the renderer in the preview.

Local renderers are saved in your browser and are editable/removable. Do not use the **Aidbox Forms** name.
Local renderers are saved in your browser and are editable/removable. Do not use the **Formbox** and **Aidbox Forms** names.

### Managed renderer (via SDCConfig)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: Aidbox Forms supports FHIR 4.0.0 to 5.0.0 with automatic conversion for importing Questionnaires from FHIR 3.0.0+.
description: Formbox supports FHIR 4.0.0 to 5.0.0 with automatic conversion for importing Questionnaires from FHIR 3.0.0+.
---

# FHIR versions

Aidbox Forms module supports FHIR versions 4.0.0 to 5.0.0. FHIR version used is taken from the Aidbox. (Data can be stored only on that version)
Formbox module supports FHIR versions 4.0.0 to 5.0.0. FHIR version used is taken from the Aidbox. (Data can be stored only on that version)

However, you can load/import questionnaires with FHIR versions ranging from 3.0.0 to 5.x. Our module automatically checks the Questionnaire version and handles conversion as needed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here's how it works:

Users can create custom components that represent question or group of questions that they want to re-use.

These custom components can include any form elements supported by Aidbox Forms, such as text fields, checkboxes, or dropdowns and etc. including their attributes and rules.
These custom components can include any form elements supported by Formbox, such as text fields, checkboxes, or dropdowns and etc. including their attributes and rules.

When a user is designing a form in the UI builder, he can create a component:

Expand Down Expand Up @@ -167,7 +167,7 @@ There are some use cases with component editing:

## Assembling a Form from Other Forms

Aidbox Forms allows you to assemble a new form by reusing existing forms as components. This is a powerful feature that lets you build complex forms efficiently using pre-existing templates.
Formbox allows you to assemble a new form by reusing existing forms as components. This is a powerful feature that lets you build complex forms efficiently using pre-existing templates.

### **Steps to Assemble a Form from Ready-Made Forms:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ EntryMode setting can be configured via form builder `>` form settings panel `>`



> In Aidbox Forms `Random` - means show as is, because our implementaion make this a default approach. But other renderers may choose other direction and `Random` entryMode foreces them to show all questions at once.
> In Formbox `Random` - means show as is, because our implementaion make this a default approach. But other renderers may choose other direction and `Random` entryMode foreces them to show all questions at once.

Choose based on your clinical/business workflow requirements, user needs, and target device types.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Configure Questionnaire properties in Aidbox Forms including title, canonical URL, version, status, and metadata.
description: Configure Questionnaire properties in Formbox including title, canonical URL, version, status, and metadata.
---

# Form Settings
Expand All @@ -23,7 +23,7 @@ A short, descriptive, user-friendly title for the questionnaire.
This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. It is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier.

{% hint style="info" %}
URL is generated automatically. A custom prefix can be specified in the Aidbox Forms module settings.
URL is generated automatically. A custom prefix can be specified in the Formbox module settings.
{% endhint %}

### Version
Expand Down Expand Up @@ -140,7 +140,7 @@ For detailed instructions and example of extracting data visit the[ Data Extract

## Extensions

Aidbox Forms provide ability to add and edit extensions that are not covered in Forms Builder. Users can edit raw Questionnaire json.
Formbox provides ability to add and edit extensions that are not covered in Forms Builder. Users can edit raw Questionnaire json.

Extensions editor represents three fields for adding your own custom extension. To add extension you need follow three simple steps:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Step-by-step guides for Aidbox Forms creation, data extraction, population, and calculated expressions.
description: Step-by-step guides for Formbox creation, data extraction, population, and calculated expressions.
---

# How-to guides
Expand Down
Loading
Loading