SDC Module Resources

Resources for configuration and management Aidbox SDC module.

Overview

SDC module includes the following resource types:

• QuestionnaireTheme

• SDCConfig

• SDCPrintTemplate

• SDCDocument

• SDCFormMetadata

• SDCFormVersion

• SDCWorkflow

• SDCWorkflowVersion

• SDCAddendum

QuestionnaireTheme

Path	Card.	Type	Description
font-family	0..1	string	Font-Family Allowed values: Product Sans | Metropolis | Inter
brand-image	0..1		Brand images
brand-image.top-right	0..1
brand-image.top-right.url	0..1	string	Web link to top-right image
brand-image.bottom-left	0..1
brand-image.bottom-left.url	0..1	string	Web link to bottom-left image
base-font-size	0..1	number	Minimal text size (px)
input	0..1		Input styles
input.accent-color	0..1	string	Main color for inputs (border color for text inputs background for checkbox etc in RGB hex)
input.text-color	0..1	string	text color (RGB hex)
input.background-color	0..1	string	Background color (RGB hex)
input.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)
background	0..1		Background styles
background.main-color	0..1	string	Main background color (RBG hex)
background.form-color	0..1	string	Background color for form (RBG hex)
background.toolbar-color	0..1	string	Background color for toolbar that displays below the form (with submit button) (RGB hex)
theme-name	0..1	string	Theme Title
button	0..1		Button styles
button.amend-text-color	0..1	string
button.print-color	0..1	string	Background color for "Print" button
button._amend-text	0..1	Object
button._submit-text	0..1	Object
button.redirect-color	0..1	string	Background color for "Save & Close" button
button._redirect-text	0..1	Object
button.submit-text	0..1	string
button.print-text-color	0..1	string	Text color for "Print" button
button.print-text	0..1	string
button.redirect-text-color	0..1	string	Text color for "Save & Close" button
button._print-text	0..1	Object
button.amend-color	0..1	string
button.text-color	0..1	string
button.submit-color	0..1	string	Background color for "Submit" button
button.redirect-text	0..1	string
button.amend-text	0..1	string
button.submit-text-color	0..1	string	Text color for "Submit" button
button.accent-color	0..1	string	Background color for filled buttons border color for outlined buttons (deprecated)

SDCConfig

Path	Card.	Type	Description
form	0..1
form.app-name	0..1	string	App name that will be mentioned in AuditEvent logs
form.hide-print-button	0..1	boolean	Hide print button from the form
form.enable-amend-button	0..1	boolean	Enable amend button
form.read-only	0..1	boolean	Should form be read-only
form.hide-language-selector	0..1	boolean	Hide language selector in the builder
form.hide-footer	0..1	boolean	Hide the footer in the renderer altogether
form.default-max-width	0..1	string	Default max width of the form
form.non-sticky-footer	0..1	boolean	Non-sticky footer in the form
form.redirect-on-save	0..1	url	Redirect URI that used on form save/close button
form.redirect-on-submit	0..1	url	Redirect URI that used on form sign/amend
form.enable-save-button	0..1	boolean	Enable close button
translations	0..1	Object	Custom translations strings for UI
storage	0..1		Link to storage to store attachments
storage.account	0..1	Reference	Storage Account Allowed references: AwsAccount, GcpServiceAccount, AzureContainer
storage.bucket	0..1	string	Storage bucket (required for GCP and S3)
form-store	0..1
form-store.endpoint	0..1	url	FHIR Server that will be used for storing/getting Questionnaire (if not set - use Aidbox)
form-store.headers	0..1	Object	Headers with credentials (optional)
builder	0..1
builder.hide-extraction	0..1	boolean	Hide extraction tab in debug instruments
builder.highlight-download-button	0..1	boolean	Highlight download button in the builder's debugger panel
builder.translation-languages	0..*	string	List of languages that will be used for translation
builder.hide-back-button	0..1	boolean	Hide back button in builder
builder.hide-save	0..1	boolean	Hide save button
builder.hide-publish	0..1	boolean	Hide Publish button in builder
builder.collapse-debugger	0..1	boolean	Collapse debugger by default in builder
builder.disable-submit-button	0..1	boolean	Disable submit button in the builder's form preview footer
builder.hide-add-theme	0..1	boolean	Hide add theme button
builder.disable-use-blank-form	0..1	boolean	Disable initializing the builder with a sample form when no form is provided
builder.enable-share	0..1	boolean	Make share button visible in the builder and enable accepting a serialized questionnaire from query param
builder.hide-population	0..1	boolean	Hide population tab in debug instruments
builder.hide-save-theme	0..1	boolean	Hide save theme
builder.disable-save	0..1	boolean	Disable save
builder.disable-publish	0..1	boolean	Disable publish button
builder.form-url-prefix	0..1	url	URL prefix that used in url generation of new forms
builder.disable-load-fhir-version	0..1	boolean	Disable loading of FHIR version from the server. Deprecated: not used anymore and has no effect
builder.hide-edit-theme	0..1	boolean	Hide edit theme button
name	1..1	string	Machine readable config name
data-store	0..1
data-store.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)
data-store.headers	0..1	Object	Headers (with credentials) for accessing Service (optional)
theme	0..1	Reference	Default theme Allowed references: QuestionnaireTheme
language	0..1	code	Default language for UI
term-server	0..1
term-server.endpoint	0..1	url	FHIR Server that stores Terminology (ValueSet/expand$) (if not set - use Aidbox)
term-server.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

SDCPrintTemplate

Path	Card.	Type	Description
content	0..1	string	Template for SDC print

SDCDocument

Base schema for questionnaire(document) definition. Also a resource in DB - SDCDocument

Path	Card.	Type	Description
based-on	0..1		Request led to creation of this Document
based-on.id	0..1	string
based-on.resourceType	0..1	string
based-on.display	0..1	string
author	0..1		Reference to user which create document
author.id	0..1	string
author.resourceType	0..1	string
author.display	0..1	string
form	1..1
form.form	0..1	string	Full name of form, with which document was captured
form.version	0..1	number	Used Form version
encounter	0..1		Reference to encounter
encounter.id	0..1	string
encounter.resourceType	0..1	string
encounter.display	0..1	string
unit-system	0..1	string	What unit system was used in this document at launch
status	0..1	string	Status of the document Allowed values: draft | in-progress | canceled | completed | in-amendment | amended
source	0..1		The person who answered the questions
source.id	0..1	string
source.resourceType	0..1	string
source.display	0..1	string
type	0..1	string	Name/version of form, with which document was captured
patient	0..1		The subject of the question
patient.id	0..1	string
patient.resourceType	0..1	string
patient.display	0..1	string

SDCFormMetadata

Path	Card.	Type	Description
properties	0..1	Object

SDCFormVersion

Form Metadata that can be used for Dynamic updates

Path	Card.	Type	Description
form	0..1	string
version	0..1	number	Incremental number of form version.
hash	0..1	number	Hash of snapshot with injected document/layout/rules
snapshot	0..1	string

SDCWorkflow

Path	Card.	Type	Description
params	0..1	Object	Workflow params schema definition
cancel-reason	0..1	string	Define why workfow is canceled
items	0..1	Object	Workflow items
workflow	0..1	string	Workflow symbolic name for storing in DB
status	0..1	string	Status of WF lifecycle. Should be changed via rpc: `cancel-wf`, `complete-wf` `cancel-task`, `complete-task` Allowed values: new | in-progress | canceled | completed | in-amendment | amended
order	0..*	string	Order of items (array of item keys)
title	0..1	string	Title of the workflow
version	0..1	number	Workflow version
ctx	0..1		Workflow context, which can be used from tasks as well
ctx.encounter	0..1
ctx.encounter.id	0..1	string
ctx.encounter.resourceType	0..1	string
ctx.encounter.display	0..1	string
ctx.patient	0..1
ctx.patient.id	0..1	string
ctx.patient.resourceType	0..1	string
ctx.patient.display	0..1	string
ctx.user	0..1
ctx.user.id	0..1	string
ctx.user.resourceType	0..1	string
ctx.user.display	0..1	string

SDCWorkflowVersion

Snapshotted workflow template with incremental versioning.

Path	Card.	Type	Description
workflow	1..1	string
version	1..1	number	Incremental number of workflow version.
hash	1..1	number	Hash of snapshot with injected document/layout/rules
snapshot	1..1	string

SDCAddendum

Addednum Resource. Contains additional information abount SDCDocument/SDCWorkflow

Path	Card.	Type	Description
type	1..1	string
target	1..1
target.id	0..1	string
target.resourceType	0..1	string
target.display	0..1	string
user	1..1
user.id	0..1	string
user.resourceType	0..1	string
user.display	0..1	string
date	1..1	dateTime