SDC Module Resources
Resources for configuration and management Aidbox SDC module.
OpenEHRTemplate
Template for SDC print functionality using OpenEHR format.
| Name | Card. | Type | Description |
|---|---|---|---|
OpenEHRTemplate | |||
content | 0..1 | string | Template for SDC print |
QuestionnaireTheme
Theme styling for SDC questionnaire forms including colors, fonts, and component styles.
| Name | Card. | Type | Description |
|---|---|---|---|
QuestionnaireTheme | |||
background | 0..1 | BackboneElement | Background styles |
main-color | 0..1 | string | Main background color (RGB hex) |
form-color | 0..1 | string | Background color for form (RGB hex) |
toolbar-color | 0..1 | string | Background color for toolbar that displays below the form (with submit button) (RGB hex) |
base-font-size | 0..1 | decimal | Minimal text size (px) |
brand-image | 0..1 | BackboneElement | Brand images |
top-right | 0..1 | BackboneElement | |
url | 0..1 | string | Web link to top-right image |
bottom-left | 0..1 | BackboneElement | |
url | 0..1 | string | Web link to bottom-left image |
button | 0..1 | BackboneElement | Button styles |
print-text | 0..1 | string | |
_print-text | 0..1 | Object | |
print-color | 0..1 | string | Background color for Print button |
print-text-color | 0..1 | string | Text color for Print button |
amend-text | 0..1 | string | |
_amend-text | 0..1 | Object | |
amend-color | 0..1 | string | |
amend-text-color | 0..1 | string | |
_redirect-text | 0..1 | Object | |
redirect-color | 0..1 | string | Background color for Save & Close button |
redirect-text | 0..1 | string | |
redirect-text-color | 0..1 | string | Text color for Save & Close button |
submit-color | 0..1 | string | Background color for Submit button |
submit-text-color | 0..1 | string | Text color for Submit button |
submit-text | 0..1 | string | |
_submit-text | 0..1 | Object | |
accent-color | 0..1 | string | Background color for filled buttons, border color for outlined buttons. Deprecated. |
text-color | 0..1 | string | |
design-system | 0..1 | string | Design System used in form components
Allowed values: aidbox-desktop | aidbox-mobile | NHS |
font-family | 0..1 | string | Font-Family
Allowed values: Product Sans | Metropolis | Inter |
input | 0..1 | BackboneElement | Input styles |
accent-color | 0..1 | string | Main color for inputs (border color for text inputs, background for checkbox, etc.) (RGB hex) |
text-color | 0..1 | string | Text color (RGB hex) |
background-color | 0..1 | string | Background color (RGB hex) |
font-size | 0..1 | decimal | Input font size (px) |
hierarchy-padding | 0..1 | decimal | Left padding showing hierarchy of nested items (rem) |
language | 0..1 | code | Theme Language |
main-color | 0..1 | string | Main accent color (RGB hex) |
theme-name | 0..1 | string | Theme Title |
SDCAddendum
Addendum resource. Contains additional information about an SDCDocument or SDCWorkflow.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCAddendum | |||
date | 1..1 | dateTime | Date of addendum creation |
target | 1..1 | BackboneElement | Reference to target resource |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
type | 1..1 | string | Type of addendum |
user | 1..1 | BackboneElement | Reference to user who created the addendum |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string |
SDCConfig
Configuration resource for SDC system settings including language, theme, storage, form settings, and builder options.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCConfig | |||
builder | 0..1 | BackboneElement | |
custom-renderers | 0..* | BackboneElement | Custom renderers that can be used to preview form in Form Builder |
name | 0..1 | string | Renderer name |
source | 0..1 | url | Web component source URL |
url | 0..1 | url | Web component URL |
title | 0..1 | string | Title in Builder |
default | 0..1 | boolean | Whether this is the default renderer for form preview |
form-url-prefix | 0..1 | url | URL prefix used in URL generation of new forms |
translation-languages | 0..* | string | List of languages that will be used for translation |
hide-back-button | 0..1 | boolean | Hide back button in builder |
hide-form-entry-mode | 0..1 | boolean | Hide entry mode control in builder settings |
hide-form-adaptive-form | 0..1 | boolean | Hide adaptive form control in builder settings |
hide-preview-renderer-selector | 0..1 | boolean | Hide preview renderer selector in builder toolbar |
hide-publish | 0..1 | boolean | Hide Publish button in builder |
disable-publish | 0..1 | boolean | Disable publish button |
hide-population | 0..1 | boolean | Hide population tab in debug instruments |
hide-extraction | 0..1 | boolean | Hide extraction tab in debug instruments |
hide-save | 0..1 | boolean | Hide save button |
collapse-debugger | 0..1 | boolean | Collapse debugger by default in builder |
disable-submit-button | 0..1 | boolean | Disable submit button in the builder's form preview footer |
hide-add-theme | 0..1 | boolean | Hide add theme button |
disable-use-blank-form | 0..1 | boolean | Disable initializing the builder with a sample form when no form is provided |
enable-share | 0..1 | boolean | Make share button visible in the builder and enable accepting a serialized questionnaire from query param |
hide-save-theme | 0..1 | boolean | Hide save theme button |
disable-save | 0..1 | boolean | Disable save button |
disable-load-fhir-version | 0..1 | boolean | Deprecated. Has no effect. |
hide-edit-theme | 0..1 | boolean | Hide edit theme button |
highlight-download-button | 0..1 | boolean | Highlight download button in the builder's debugger panel |
layout | 0..1 | string | Builder layout variant (default or v2) |
external-terminology-servers | 0..* | BackboneElement | Additional external terminology servers to show in the builder UI |
url | 0..1 | url | Terminology server URL |
name | 0..1 | string | Display name for the server |
default | 0..1 | boolean | Whether this is the default terminology server |
data-store | 0..1 | BackboneElement | |
endpoint | 0..1 | url | FHIR Server for storing responses, populating data, and extraction (defaults to Aidbox) |
headers | 0..1 | Object | Headers (with credentials) for accessing Service (optional) |
default | 0..1 | boolean | Sets config as default for system/tenant |
description | 0..1 | string | Human readable config description |
form | 0..1 | BackboneElement | |
redirect-on-submit | 0..1 | url | Redirect URI used on form sign/amend |
redirect-on-save | 0..1 | url | Redirect URI used on form save/close button |
auto-save-interval | 0..1 | integer | Form auto-save interval in milliseconds |
read-only | 0..1 | boolean | Whether the form should be read-only |
default-max-width | 0..1 | string | Default max width of the form |
app-name | 0..1 | string | App name that will be mentioned in AuditEvent logs |
hide-footer | 0..1 | boolean | Hide the footer in the renderer altogether |
hide-title | 0..1 | boolean | Hide title in the form |
non-sticky-footer | 0..1 | boolean | Non-sticky footer in the form |
hide-language-selector | 0..1 | boolean | Hide language selector in the form |
hide-print-button | 0..1 | boolean | Hide print button from the form |
enable-amend-button | 0..1 | boolean | Enable amend button |
enable-save-button | 0..1 | boolean | Enable save button |
allow-repopulate | 0..1 | boolean | Allow repopulate for all forms |
hide-download-attachment-button | 0..1 | boolean | Hide download button in attachment widget |
form-store | 0..1 | BackboneElement | FHIR Server settings for storing/getting Questionnaire |
endpoint | 0..1 | url | FHIR Server that will be used for storing/getting Questionnaire (if not set - use Aidbox) |
headers | 0..1 | Object | Headers with credentials (optional) |
language | 0..1 | code | Default language for UI |
name | 1..1 | string | Machine readable config name |
storage | 0..1 | BackboneElement | Storage configuration for attachments |
account | 0..1 | Reference | Storage Account
Allowed references: AwsAccount, GcpServiceAccount, AzureContainer |
bucket | 0..1 | string | Storage bucket (required for GCP and S3) |
storageAccount | 0..1 | string | Azure storage account name (for Azure Workload Identity) |
container | 0..1 | string | Azure container name (for Azure Workload Identity) |
store-absolute-url | 0..1 | boolean | Store absolute url to QuestionnaireResponse attachments |
term-server | 0..1 | BackboneElement | |
endpoint | 0..1 | url | FHIR Server that stores Terminology (ValueSet/expand$) (if not set - use Aidbox) |
headers | 0..1 | Object | Headers (with credentials) for accessing Service (optional) |
theme | 0..1 | Reference | Default theme
Allowed references: QuestionnaireTheme |
translations | 0..1 | Object | Custom translation strings for UI |
SDCDocument
Questionnaire document resource. Stores captured form responses with status tracking, patient and encounter references.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCDocument | |||
author | 0..1 | BackboneElement | Reference to the user who created the document |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
based-on | 0..1 | BackboneElement | Request that led to creation of this document |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
encounter | 0..1 | BackboneElement | Reference to the associated encounter |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
form | 1..1 | BackboneElement | |
form | 0..1 | string | Full name of the form used to capture the document |
version | 0..1 | decimal | Form version used to capture the document |
patient | 0..1 | BackboneElement | The patient who is the subject of the document |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
source | 0..1 | BackboneElement | The person who answered the questions |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
status | 0..1 | string | Status of the document
Allowed values: draft | in-progress | canceled | completed | in-amendment | amended |
type | 0..1 | string | Name and version of the form used to capture the document |
unit-system | 0..1 | string | Unit system used in this document at launch |
SDCFormMetadata
Form metadata with custom properties.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCFormMetadata | |||
properties | 0..1 | Object | Custom properties for the form. |
SDCFormVersion
Form metadata for dynamic updates with incremental versioning and hash.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCFormVersion | |||
form | 0..1 | string | Form identifier |
hash | 0..1 | decimal | Hash of snapshot with injected document/layout/rules |
snapshot | 0..1 | string | Serialized form snapshot |
version | 0..1 | decimal | Incremental number of form version. |
SDCPrintTemplate
Template content for SDC print functionality.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCPrintTemplate | |||
content | 0..1 | string | Template for SDC print |
SDCWorkflow
Workflow definition with status, params, and context for SDC forms.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCWorkflow | |||
cancel-reason | 0..1 | string | Reason why the workflow was canceled |
ctx | 0..1 | BackboneElement | Workflow context, also accessible from tasks |
encounter | 0..1 | BackboneElement | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
patient | 0..1 | BackboneElement | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
user | 0..1 | BackboneElement | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
items | 0..1 | Object | Workflow items |
order | 0..* | string | Order of items (array of item keys) |
params | 0..1 | Object | Workflow parameters schema definition |
status | 0..1 | string | Workflow lifecycle status. Change via RPC: cancel-wf, complete-wf, cancel-task, complete-task.
Allowed values: new | in-progress | canceled | completed | in-amendment | amended |
title | 0..1 | string | Title of the workflow |
version | 0..1 | decimal | Workflow version |
workflow | 0..1 | string | Workflow symbolic name |
SDCWorkflowVersion
Snapshotted workflow template with incremental versioning.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCWorkflowVersion | |||
hash | 1..1 | decimal | Hash of snapshot with injected document/layout/rules |
snapshot | 1..1 | string | Serialized workflow snapshot. |
version | 1..1 | decimal | Incremental number of workflow version. |
workflow | 1..1 | string | Workflow identifier. |