SDC Module Resources
Resources for configuration and management Aidbox SDC module.
OpenEHRTemplate
| Name | Card. | Type | Description |
|---|---|---|---|
OpenEHRTemplate | |||
content | 0..1 | string | Template for SDC print |
QuestionnaireTheme
| Name | Card. | Type | Description |
|---|---|---|---|
QuestionnaireTheme | |||
background | 0..1 | Background styles | |
main-color | 0..1 | string | Main background color (RBG hex) |
form-color | 0..1 | string | Background color for form (RBG 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 | number | Minimal text size (px) |
brand-image | 0..1 | Brand images | |
top-right | 0..1 | ||
url | 0..1 | string | Web link to top-right image |
bottom-left | 0..1 | ||
url | 0..1 | string | Web link to bottom-left image |
button | 0..1 | Button styles | |
amend-text-color | 0..1 | string | |
print-color | 0..1 | string | Background color for "Print" button |
_amend-text | 0..1 | Object | |
_submit-text | 0..1 | Object | |
redirect-color | 0..1 | string | Background color for "Save & Close" button |
_redirect-text | 0..1 | Object | |
submit-text | 0..1 | string | |
print-text-color | 0..1 | string | Text color for "Print" button |
print-text | 0..1 | string | |
redirect-text-color | 0..1 | string | Text color for "Save & Close" button |
_print-text | 0..1 | Object | |
amend-color | 0..1 | string | |
text-color | 0..1 | string | |
submit-color | 0..1 | string | Background color for "Submit" button |
redirect-text | 0..1 | string | |
amend-text | 0..1 | string | |
submit-text-color | 0..1 | string | Text color for "Submit" button |
accent-color | 0..1 | string | Background color for filled buttons border color for outlined buttons (deprecated) |
design-system | 0..1 | string | Design System used in form components Allowed values: |
font-family | 0..1 | string | Font-Family Allowed values: |
input | 0..1 | Input styles | |
accent-color | 0..1 | string | Main color for inputs (border color for text inputs background for checkbox etc in RGB hex) |
text-color | 0..1 | string | text color (RGB hex) |
background-color | 0..1 | string | Background color (RGB hex) |
font-size | 0..1 | number | Input font size (px) |
language | 0..1 | code | Theme Language |
main-color | 0..1 | string | Main Accent color (RBG hex) |
theme-name | 0..1 | string | Theme Title |
SDCAddendum
Addednum Resource. Contains additional information abount SDCDocument/SDCWorkflow
| Name | Card. | Type | Description |
|---|---|---|---|
SDCAddendum | |||
date | 1..1 | dateTime | |
target | 1..1 | ||
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
type | 1..1 | string | |
user | 1..1 | ||
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string |
SDCConfig
| Name | Card. | Type | Description |
|---|---|---|---|
SDCConfig | |||
builder | 0..1 | ||
hide-extraction | 0..1 | boolean | Hide extraction tab in debug instruments |
highlight-download-button | 0..1 | boolean | Highlight download button in the builder's debugger panel |
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-save | 0..1 | boolean | Hide save button |
hide-publish | 0..1 | boolean | Hide Publish button in builder |
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-population | 0..1 | boolean | Hide population tab in debug instruments |
custom-renderers | 0..* | Map | Custom renderers that can be used to preview form in Form Builder |
name | 0..1 | string | Webcomponent tag name |
source | 0..1 | url | Webcomponent source url |
title | 0..1 | string | Title in Builder |
default | 0..1 | boolean | If this default renderer for form preview |
hide-save-theme | 0..1 | boolean | Hide save theme |
disable-save | 0..1 | boolean | Disable save |
disable-publish | 0..1 | boolean | Disable publish button |
form-url-prefix | 0..1 | url | URL prefix that used in url generation of new forms |
disable-load-fhir-version | 0..1 | boolean | Disable loading of FHIR version from the server. Deprecated: not used anymore and has no effect |
hide-edit-theme | 0..1 | boolean | Hide edit theme button |
data-store | 0..1 | ||
endpoint | 0..1 | url | FHIR Server that will be used for storing/getting reponses populate data from and extract to (if not set - use Aidbox) |
headers | 0..1 | Object | Headers (with credentials) for accessing Service (optional) |
default | 0..1 | boolean | Set's config as default for system/tenant |
description | 0..1 | string | Human readable config description |
form | 0..1 | ||
app-name | 0..1 | string | App name that will be mentioned in AuditEvent logs |
hide-print-button | 0..1 | boolean | Hide print button from the form |
enable-amend-button | 0..1 | boolean | Enable amend button |
read-only | 0..1 | boolean | Should form be read-only |
hide-language-selector | 0..1 | boolean | Hide language selector in the builder |
allow-repopulate | 0..1 | boolean | Allow repopulate for all forms |
hide-footer | 0..1 | boolean | Hide the footer in the renderer altogether |
default-max-width | 0..1 | string | Default max width of the form |
auto-save-interval | 0..1 | integer | Form auto save interval (in milliseconds) |
hide-download-attachment-button | 0..1 | boolean | Hide download button in attachment widget |
non-sticky-footer | 0..1 | boolean | Non-sticky footer in the form |
redirect-on-save | 0..1 | url | Redirect URI that used on form save/close button |
redirect-on-submit | 0..1 | url | Redirect URI that used on form sign/amend |
enable-save-button | 0..1 | boolean | Enable close button |
hide-title | 0..1 | boolean | Hide title in the form |
form-store | 0..1 | ||
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 | Link to storage to store attachments | |
account | 0..1 | Reference | Storage Account Allowed references: AwsAccount, GcpServiceAccount, AzureContainer |
bucket | 0..1 | string | Storage bucket (required for GCP and S3) |
term-server | 0..1 | ||
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 translations strings for UI |
SDCDocument
Base schema for questionnaire(document) definition. Also a resource in DB - SDCDocument
| Name | Card. | Type | Description |
|---|---|---|---|
SDCDocument | |||
author | 0..1 | Reference to user which create document | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
based-on | 0..1 | Request led to creation of this Document | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
encounter | 0..1 | Reference to encounter | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
form | 1..1 | ||
form | 0..1 | string | Full name of form, with which document was captured |
version | 0..1 | number | Used Form version |
patient | 0..1 | The subject of the question | |
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
source | 0..1 | 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: |
type | 0..1 | string | Name/version of form, with which document was captured |
unit-system | 0..1 | string | What unit system was used in this document at launch |
SDCFormMetadata
| Name | Card. | Type | Description |
|---|---|---|---|
SDCFormMetadata | |||
properties | 0..1 | Object |
SDCFormVersion
Form Metadata that can be used for Dynamic updates
| Name | Card. | Type | Description |
|---|---|---|---|
SDCFormVersion | |||
form | 0..1 | string | |
hash | 0..1 | number | Hash of snapshot with injected document/layout/rules |
snapshot | 0..1 | string | |
version | 0..1 | number | Incremental number of form version. |
SDCPrintTemplate
| Name | Card. | Type | Description |
|---|---|---|---|
SDCPrintTemplate | |||
content | 0..1 | string | Template for SDC print |
SDCWorkflow
| Name | Card. | Type | Description |
|---|---|---|---|
SDCWorkflow | |||
cancel-reason | 0..1 | string | Define why workfow is canceled |
ctx | 0..1 | Workflow context, which can be used from tasks as well | |
encounter | 0..1 | ||
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
patient | 0..1 | ||
id | 0..1 | string | |
resourceType | 0..1 | string | |
display | 0..1 | string | |
user | 0..1 | ||
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 params schema definition |
status | 0..1 | string | Status of WF lifecycle. Should be changed via rpc: Allowed values: |
title | 0..1 | string | Title of the workflow |
version | 0..1 | number | Workflow version |
workflow | 0..1 | string | Workflow symbolic name for storing in DB |
SDCWorkflowVersion
Snapshotted workflow template with incremental versioning.
| Name | Card. | Type | Description |
|---|---|---|---|
SDCWorkflowVersion | |||
hash | 1..1 | number | Hash of snapshot with injected document/layout/rules |
snapshot | 1..1 | string | |
version | 1..1 | number | Incremental number of workflow version. |
workflow | 1..1 | string |