Aidbox User Docs
Run Aidbox locallyRun Aidbox in SandboxTalk to us Ask community
  • Aidbox FHIR platform documentation
    • Features
    • Architecture
  • Getting Started
    • Run Aidbox in Sandbox
    • Run Aidbox locally
    • Run Aidbox on AWS
    • Upload Sample Data
  • Tutorials
    • CRUD, Search Tutorials
      • Delete data
      • Set up uniqueness in Resource
      • Search Tutorials
        • Custom SearchParameter tutorial
        • Create custom Aidbox Search resource
        • Multilingual search tutorial
        • Migrate from Aidbox SearchParameter to FHIR SearchParameter
        • Change sort order by locale collation
    • Bulk API Tutorials
      • 🎓Synthea by Bulk API
      • 🎓$dump-sql tutorial
    • Security & Access Control Tutorials
      • Authentication Tutorial
      • Allow patients to see their own data
      • Restrict operations on resource type
      • Relationship-based access control
      • Creating user & set up full user access
      • Restricting Access to Patient Data
      • Create and test access control
      • RBAC
        • Flexible RBAC built-in to Aidbox
        • RBAC with JWT containing role
        • RBAC with ACL
      • Set-up token introspection
      • Prohibit user to login
      • Debug access control
      • Managing Admin Access to the Aidbox UI Using Okta Groups
      • Run Multibox locally
      • How to enable labels-based access control
      • How to enable patient data access API
      • How to enable SMART on FHIR on Patient Access API
      • How to enable hierarchical access control
      • How to configure Audit Log
    • Terminology Tutorials
      • Load ICD-10 terminology into Aidbox
      • Uploading IG terminology content to external FHIR terminology server
    • Validation Tutorials
      • Upload FHIR Implementation Guide
        • Environment Variable
        • Aidbox UI
          • IG Package from Aidbox Registry
          • Public URL to IG Package
          • Local IG Package
        • Aidbox FHIR API
        • UploadFIG Tool
      • ISiK
      • Carin BB
      • US Core
      • Davinci Pdex
      • mCode
    • Integration Toolkit Tutorials
      • Postmark integration tutorial
      • Mailgun integration tutorial
    • Subscriptions Tutorials
      • AidboxTopicSubscription NATS tutorial
    • Other tutorials
      • Run Aidbox with FHIR R6
      • Migrate from Multibox to Aidbox
      • SDC with Custom Resources
      • How to create FHIR NPM package
      • Migrate from legacy licence portal to Aidbox portal
      • How to run Aidbox in GCP Cloud Run
  • Overview
    • Licensing and Support
    • Aidbox user portal
      • Projects
      • Licenses
      • Members
    • Aidbox UI
      • Aidbox Notebooks
      • REST Console
      • Database Console
      • Attrs stats
      • DB Tables
      • DB Queries
    • Versioning
    • Release Notes
    • Contact us
  • Configuration
    • Settings
    • Configure Aidbox and Multibox
    • Init Bundle
  • API
    • REST API
      • CRUD
        • Create
        • Read
        • Update
        • Patch
        • Delete
      • FHIR Search
        • SearchParameter
        • Include and Revinclude
        • Chaining
      • Aidbox Search
      • Bundle
      • History
      • $everything on Patient
      • Other
        • Aidbox & FHIR formats
        • Capability Statement
        • $document
        • Observation/$lastn
        • $validate
        • SQL endpoints
        • $matcho
        • $to-format
        • Aidbox version
        • Health check
    • Bulk API
      • Configure Access Policies for Bulk API
      • $dump
      • $dump-sql
      • $dump-csv
      • $export
      • $load & /fhir/$load
      • $import & /fhir/$import
      • aidbox.bulk data import
      • Bulk import from an S3 bucket
    • Batch/Transaction
    • GraphQL API
    • Other APIs
      • Plan API
        • Provider Directory API
          • Practitioner
          • PractitionerRole
          • Organization
          • OrganizationAffiliation
        • Plan API Overview
      • Archive/Restore API
        • create-archive
        • restore-archive
        • prune-archived-data
        • delete-archive
      • ETAG support
      • Cache
      • Changes API
      • RPC API
      • Sequence API
      • Encryption API
      • Batch Upsert
  • Modules
    • Profiling and validation
      • FHIR Schema Validator
        • Aidbox FHIR IGs Registry
        • Setup Aidbox with FHIR Schema validation engine
      • Skip validation of references in resource using request header
      • Asynchronous resource validation
    • Security & Access Control
      • Authentication Flows
        • Basic Auth
        • Client Credentials Grant
        • Resource Owner Grant
        • Authorization Code Grant
        • Implicit Grant
        • Two Factor Authentication
        • External OAuth 2.0 Providers
        • Token Exchange
      • External identity providers
        • Aidbox
        • Okta
        • Azure AD
        • Azure AD with certificate authentication
        • Keycloak
        • GitHub
        • Microsoft AD FS
        • Apple
      • Access Control
        • AccessPolicy
        • Evaluation engines
        • Role-Based Access Control (/RBAC)
        • Attribute-based Access Control (/ABAC)
        • Multitenancy
        • Access control lists (/ACL)
        • Access policy dev tool
        • AccessPolicy best practices
      • Audit
        • Audit Log
    • Observability
      • Getting started
        • Run Aidbox with OpenTelemetry locally
        • How to export telemetry to the OTEL collector
      • Logs
        • How-to guides
          • OpenTelemetry logs
          • Elastic Logs and Monitoring Integration
          • Datadog Log management integration
          • Loki Log management integration
        • Tutorials
          • Log analysis and visualization tutorial
          • Export logs to Datadog tutorial
        • Extending Aidbox Logs
        • Technical reference
          • Log appenders
          • Log transformations
          • Log Schema
          • OTEL logs exporter parameters
      • Metrics
        • How-to guides
          • How to export metrics to the OTEL collector
          • Use Aidbox Metrics Server
          • Set-up Grafana integration
        • Technical reference
          • OpenTelemetry Metrics
          • OTEL metrics exporter parameters
      • Traces
        • How to use tracing
        • OTEL traces exporter parameters
    • Subscriptions
      • Aidbox topic-based subscriptions
        • Kafka AidboxTopicDestination
        • Webhook AidboxTopicDestination
        • GCP Pub/Sub AidboxTopicDestination
        • Tutorial: produce QuestionnaireResponse to Kafka topic
      • Aidbox SubSubscriptions
    • Aidbox Forms
      • Getting started
      • Aidbox Forms Interface
      • Aidbox UI Builder
        • UI Builder Interface
        • Form creation
          • Form Settings
          • Widgets
          • Components
          • Versioning
          • Form customisation in Theme Editor
          • Form signature
          • How-to guides
            • How to: populate forms with data
            • How to extract data from forms
            • How to calculate form filling percentage
          • Multilingual forms
          • FHIRPath Editor
        • Import Questionnaire
        • Form sharing
        • Printing forms
          • Template-based PDF generation
        • FHIR versions
        • Offline forms
        • Embedding
          • Request Interception
        • Configuration
        • Forms multitenancy
        • Building reports using SQL on FHIR
        • Integration with external terminology servers
        • External FHIR servers as a data backend
        • Store attachments in S3-like storages
      • Access Control in Forms
      • Audit Logging in Forms
      • Aidbox Form Gallery
    • Define extensions
      • Extensions using StructureDefinition
      • Extensions using FHIRSchema
    • Custom Resources
      • Custom resources using FHIR Schema
      • Custom resources using StructureDefinition
      • Migrate to FHIR Schema
        • Migrate custom resources defined with Entity & Attributes to FHIR Schema
        • Migrate custom resources defined with Zen to FHIR Schema
    • Aidbox terminology module
      • Concept
        • $translate-concepts
        • Handling hierarchies using ancestors
      • ValueSet
        • ValueSet Expansion
        • ValueSet Code Validation
        • Create a ValueSet
      • CodeSystem
        • CodeSystem Concept Lookup
        • CodeSystem Subsumption testing
        • CodeSystem Code Composition
      • Import external terminologies
        • Import flat file (/CSV)
        • $import operation
        • Ready-to-use terminologies
      • $translate on ConceptMap
    • SQL on FHIR
      • Defining flat views with View Definitions
      • Query data from flat views
      • Reference
    • Integration toolkit
      • C-CDA / FHIR Converter
        • List of supported templates
          • Admission Diagnosis Section (/V3)
          • Advance Directives Section (/entries optional) (/V3)
          • Advance Directives Section (/entries required) (/V3)
          • Allergies and Intolerances Section (/entries optional) (/V3)
          • Allergies and Intolerances Section (/entries required) (/V3)
          • Assessment Section
          • Chief Complaint Section
          • Chief Complaint and Reason for Visit Section
          • Complications Section (/V3)
          • Course of Care Section
          • DICOM Object Catalog Section - DCM 121181
          • Default Section Rules
          • Discharge Diagnosis Section (/V3)
          • Document Header
          • Encounters Section (/entries optional) (/V3)
          • Encounters Section (/entries required) (/V3)
          • Family History Section (/V3)
          • Functional Status Section (/V2)
          • General Status Section
          • Goals Section
          • Health Concerns Section (/V2)
          • History of Present Illness Section
          • Hospital Consultations Section
          • Hospital Course Section
          • Hospital Discharge Instructions Section
          • Hospital Discharge Physical Section
          • Hospital Discharge Studies Summary Section
          • Immunizations Section (/entries optional) (/V3)
          • Immunizations Section (/entries required) (/V3)
          • Medical (/General) History Section
          • Medical Equipment Section (/V2)
          • Medications Administered Section (/V2)
          • Medications Section (/entries optional) (/V2)
          • Medications Section (/entries required) (/V2)
          • Mental Status Section (/V2)
          • Notes
          • Nutrition Section
          • Objective Section
          • Operative Note Fluids Section
          • Operative Note Surgical Procedure Section
          • Past Medical History (/V3)
          • Payers Section (/V3)
          • Plan of Treatment Section (/V2)
          • Postprocedure Diagnosis Section (/V3)
          • Preoperative Diagnosis Section (/V3)
          • Problem Section (/entries optional) (/V3)
          • Problem Section (/entries required) (/V3)
          • Procedure Description Section
          • Procedure Disposition Section
          • Procedure Estimated Blood Loss Section
          • Procedure Implants Section
          • Procedure Specimens Taken Section
          • Procedures Section (/entries optional) (/V2)
          • Procedures Section (/entries required) (/V2)
          • Reason for Visit Section
          • Results Section (/entries optional) (/V3)
          • Results Section (/entries required) (/V3)
          • Review of Systems Section
          • Social History Section (/V3)
          • Vital Signs Section (/entries optional) (/V3)
          • Vital Signs Section (/entries required) (/V3)
        • How to deploy the service
        • Producing C-CDA documents
        • How to customize conversion rules
      • HL7 v2 Integration
        • HL7 v2 integration with Aidbox Project
        • Mappings with lisp/mapping
      • X12 message converter
      • Analytics
        • Power BI
      • Mappings
      • Email Providers integration
        • Setup SMTP provider
    • SMARTbox | FHIR API for EHRs
      • Get started
        • Set up Smartbox locally
        • Deploy Smartbox with Kubernetes
      • (/g)(/10) Standardized API for patient and population services
      • The B11 Decision Support Interventions
        • Source attributes
        • Feedback Sections
      • How-to guides
        • Pass Inferno tests with Smartbox
        • Perform EHR launch
        • Pass Inferno Visual Inspection and Attestation
        • Revoke granted access
        • Set up EHR-level customization
        • Check email templates
        • Setup email provider
        • Register users
        • Set up SSO with Auth0
        • Publish Terms of Use link onto the documentation page
        • Find out what resources were exported during the $export operation
        • Find documentation endpoint
      • Background information
        • Considerations for Testing with Inferno ONC
        • Adding Clients for Inferno tests
        • Multitenancy approach
        • What is Tenant
        • Email templating
    • ePrescription
      • Getting started
      • Authentication with mTLS
      • Pharmacies synchronization
      • Prescribing
        • NewRx Message
        • CancelRx Message
        • How to test Callback
      • Directory
        • DirectoryDownload Message
        • GetProviderLocation Message
        • AddProviderLocation Message
        • UpdateProviderLocation Message
        • DisableProviderLocation Message
      • Medications
        • FDB
      • References
        • Environment Variables
      • Frequently Asked Questions
    • Other modules
      • MDM
        • Train model
        • Configure MDM module
        • Find duplicates: $match
        • Mathematical details
      • MCP
  • Database
    • Database schema
    • PostgreSQL Extensions
    • AidboxDB
      • HA AidboxDB
    • Tutorials
      • Migrate to AidboxDB 16
      • Working with pgAgent
  • File storage
    • AWS S3
    • GCP Cloud Storage
    • Azure Blob Storage
    • Oracle Cloud Storage
  • Deployment and maintenance
    • Deploy Aidbox
      • Run Aidbox on Kubernetes
        • Deploy Production-ready Aidbox to Kubernetes
        • Deploy Aidbox with Helm Charts
        • Highly Available Aidbox
        • Self-signed SSL certificates
      • Run Aidbox on managed PostgreSQL
      • How to inject env variables into Init Bundle
    • Backup and Restore
      • Crunchy Operator (/pgBackRest)
      • pg_dump
      • pg_basebackup
      • WAL-G
    • Indexes
      • Get suggested indexes
      • Create indexes manually
  • App development
    • Use Aidbox with React
    • Aidbox SDK
      • Aidbox JavaScript SDK
      • Apps
      • NodeJs SDK
      • Python SDK
    • Examples
  • Reference
    • FHIR Schema reference
    • Settings reference
      • General
      • FHIR
      • Security & Access Control
      • Modules
      • Database
      • Web Server
      • Observability
      • Zen Project
    • Environment variables
      • Aidbox required environment variables
      • Optional environment variables
      • AidboxDB environment variables
    • System resources reference
      • IAM Module Resources
      • SDC Module Resources
      • Base Module Resources
      • Bulk Module Resources
      • AWF Module Resources
      • Cloud Module Resources
      • HL7v2 Module Resources
      • SQL on FHIR Module Resources
    • Email Providers reference
      • Notification resource reference
      • Mailgun environment variables
      • Postmark environment variables
    • Aidbox Forms reference
      • FHIR SDC API
      • Aidbox SDC API
      • Generating Questionnaire from PDF API
    • Aidbox SQL functions
  • Deprecated
    • Deprecated
      • Zen-related
        • RPC reference
          • aidbox
            • mdm
              • aidbox.mdm/update-mdm-tables
              • aidbox.mdm/match
        • FTR
        • Aidbox configuration project
          • Run Aidbox locally using Aidbox Configuraiton project
          • Aidbox configuration project structure
          • Set up and use configuration projects
          • Enable IGs
          • Repository
          • Seed Import
          • Manage Indexes in Zen Project
          • Seed v2
          • 🎓Migrate to git Aidbox Configuration Projects
          • Aidbox Configuration project reference
            • Zen Configuration
            • Aidbox project RPC reference
            • aidbox.config/config
          • Custom resources using Aidbox Project
          • First-Class Extensions using Zen
          • Zen Indexes
        • US Core IG
          • US Core IG support reference
        • Workflow Engine
          • Task
            • Aidbox Built-in Tasks
            • Task Executor API
            • Task User API
          • Workflow
            • Workflow User API
          • Services
          • Monitoring
        • FHIR conformance Deprecated guides
          • Touchstone FHIR 4.0.1 basic server
          • Touchstone FHIR USCore ClinData
          • How to enable US Core IG
            • Start Aidbox locally with US Core IG enabled
            • Add US Core IG to a running Aidbox instance
          • HL7 FHIR Da Vinci PDex Plan Net IG
        • Terminology Deprecated Tutorials
          • Inferno Test-Suite US Core 3.1.1
        • API constructor (/beta)
        • zen-lang validator
          • Write a custom zen profile
          • Load zen profiles into Aidbox
        • FHIR topic-based subscriptions
          • Set up SubscriptionTopic
          • Tutorial: Subscribe to Topic (/R4B)
          • API Reference
            • Subscription API
        • 🏗️FHIR Terminology Repository
          • FTR Specification
          • Create an FTR instance
            • FTR from CSV
            • FTR from FHIR IG
            • FTR from FTR — Direct Dependency
            • FTR from FTR — Supplement
          • FTR Manifest
          • Load SNOMED CT into Aidbox
          • Load LOINC into Aidbox
          • Load ICD-10-CM into Aidbox
          • Load RxNorm into Aidbox
          • Load US VSAC Package to Aidbox
          • Import via FTR
        • Zen Search Parameters
      • Entity / Attribute
        • Entities & Attributes
        • First-Class Extensions using Attribute
        • Custom Resources using Entity
        • Working with Extensions
        • Aidbox Search Parameters
      • Forms
      • Other
        • Custom Search
        • SearchQuery
        • Subscribe to new Patient resource
        • App Development Deprecated Tutorials
          • Receive logs from your app
            • X-Audit header
          • Working with Aidbox from .NET
          • Patient Encounter notification Application
        • Other Deprecated Tutorials
          • Resource generation with map-to-fhir-bundle-task and subscription triggers
          • APM Aidbox
          • Automatically archive AuditEvent resources in GCP storage guide
          • HL7 v2 pipeline with Patient mapping
          • How to migrate to Apline Linux
          • How to migrate transaction id to bigint
          • How to fix broken dates
          • Configure multi-tenancy
        • AidboxProfile
        • GCP Pub/Sub
Powered by GitBook
On this page
  • Overview
  • QuestionnaireTheme
  • SDCAddendum
  • SDCConfig
  • SDCDocument
  • SDCFormMetadata
  • SDCFormVersion
  • SDCPrintTemplate
  • SDCWorkflow
  • SDCWorkflowVersion

Was this helpful?

Edit on GitHub
  1. Reference
  2. System resources reference

SDC Module Resources

Resources for configuration and management Aidbox SDC module.

Overview

SDC module includes the following resource types:

  • QuestionnaireTheme

  • SDCAddendum

  • SDCConfig

  • SDCDocument

  • SDCFormMetadata

  • SDCFormVersion

  • SDCPrintTemplate

  • SDCWorkflow

  • SDCWorkflowVersion

QuestionnaireTheme

Path
Card.
Type
Description

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)

base-font-size

0..1

number

Minimal text size (px)

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

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)

font-family

0..1

string

Font-Family

Allowed values: Product Sans | Metropolis | Inter

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)

theme-name

0..1

string

Theme Title

SDCAddendum

Addednum Resource. Contains additional information abount SDCDocument/SDCWorkflow

Path
Card.
Type
Description

date

1..1

dateTime

target

1..1

target.id

0..1

string

target.resourceType

0..1

string

target.display

0..1

string

type

1..1

string

user

1..1

user.id

0..1

string

user.resourceType

0..1

string

user.display

0..1

string

SDCConfig

Path
Card.
Type
Description

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

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)

default

0..1

boolean

Set's config as default for system/tenant

description

0..1

string

Human readable config 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

form.hide-title

0..1

boolean

Hide title in the form

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)

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

storage.account

0..1

Reference

Storage Account

Allowed references: AwsAccount, GcpServiceAccount, AzureContainer

storage.bucket

0..1

string

Storage bucket (required for GCP and S3)

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)

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

Path
Card.
Type
Description

author

0..1

Reference to user which create document

author.id

0..1

string

author.resourceType

0..1

string

author.display

0..1

string

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

encounter

0..1

Reference to encounter

encounter.id

0..1

string

encounter.resourceType

0..1

string

encounter.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

patient

0..1

The subject of the question

patient.id

0..1

string

patient.resourceType

0..1

string

patient.display

0..1

string

source

0..1

The person who answered the questions

source.id

0..1

string

source.resourceType

0..1

string

source.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/version of form, with which document was captured

unit-system

0..1

string

What unit system was used in this document at launch

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

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

Path
Card.
Type
Description

content

0..1

string

Template for SDC print

SDCWorkflow

Path
Card.
Type
Description

cancel-reason

0..1

string

Define why workfow is canceled

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

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: `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

number

Workflow version

workflow

0..1

string

Workflow symbolic name for storing in DB

SDCWorkflowVersion

Snapshotted workflow template with incremental versioning.

Path
Card.
Type
Description

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

PreviousIAM Module ResourcesNextBase Module Resources

Last updated 7 hours ago

Was this helpful?