PackagesCanonicalsLogsProblems
    Packages
    io.health-samurai.sdc.r5@0.2609.1
    http://health-samurai.io/fhir/sdc/StructureDefinition/SDCConfig
description: Configuration resource for SDC system settings including language, theme, storage, form settings, and builder options.
package_name: io.health-samurai.sdc.r5
derivation: specialization
name: SDCConfig
type: SDCConfig
elements:
  description: {type: string, short: Human readable config description, index: 1}
  default: {type: boolean, short: Sets config as default for system/tenant, index: 2}
  name: {type: string, short: Machine readable config name, index: 0}
  form-store:
    type: BackboneElement
    short: FHIR Server settings for storing/getting Questionnaire
    index: 13
    elements:
      endpoint: {type: url, short: FHIR Server that will be used for storing/getting Questionnaire (if not set - use Aidbox), index: 14}
      headers: {short: Headers with credentials (optional), index: 15}
      auth:
        type: BackboneElement
        short: OAuth2 client_credentials credentials for accessing Service (optional)
        index: 16
        elements:
          token-endpoint: {type: url, short: OAuth2 token endpoint issuing the access token, index: 17}
          client-id: {type: string, short: OAuth2 client id, index: 18}
          client-secret: {short: OAuth2 client secret; stored encrypted or referenced from the vault, index: 19}
          scope: {type: string, short: OAuth2 scope requested with the token (optional), index: 20}
  builder:
    type: BackboneElement
    index: 45
    elements:
      hide-publish: {type: boolean, short: Hide Publish button in builder, index: 57}
      hide-preview-renderer-selector: {type: boolean, short: Hide preview renderer selector in builder toolbar, index: 56}
      translation-languages: {type: string, short: List of languages that will be used for translation, array: true, index: 52}
      disable-save: {type: boolean, short: Disable save button, index: 68}
      layout: {type: string, short: Builder layout variant (default or v2), index: 72}
      fhirpath-profile:
        constraint:
          fhirpath-profile-1: {human: 'Value must be one of: spec/v2.0.0, engine/browser, engine/server', severity: error, expression: $this in ('spec/v2.0.0' | 'engine/browser' | 'engine/server')}
        short: spec/v2.0.0 | engine/browser | engine/server
        type: code
        binding: {strength: extensible, valueSet: 'http://health-samurai.io/fhir/sdc/ValueSet/fhirpath-profile'}
        index: 51
      disable-load-fhir-version: {type: boolean, short: Deprecated. Has no effect., index: 69}
      hide-form-adaptive-form: {type: boolean, short: Hide adaptive form control in builder settings, index: 55}
      hide-back-button: {type: boolean, short: Hide back button in builder, index: 53}
      disable-submit-button: {type: boolean, short: Disable submit button in the builder's form preview footer, index: 63}
      form-url-prefix: {type: url, short: URL prefix used in URL generation of new forms, index: 50}
      disable-use-blank-form: {type: boolean, short: Disable initializing the builder with a sample form when no form is provided, index: 65}
      disable-publish: {type: boolean, short: Disable publish button, index: 58}
      collapse-debugger: {type: boolean, short: Collapse debugger by default in builder, index: 62}
      custom-renderers:
        type: BackboneElement
        short: Custom renderers that can be used to preview form in Form Builder
        array: true
        index: 46
        elements:
          name: {type: string, short: Renderer name, index: 47}
          url: {type: url, short: Web component URL, index: 48}
          default: {type: boolean, short: Whether this is the default renderer for form preview, index: 49}
      hide-add-theme: {type: boolean, short: Hide add theme button, index: 64}
      hide-edit-theme: {type: boolean, short: Hide edit theme button, index: 70}
      hide-population: {type: boolean, short: Hide population tab in debug instruments, index: 59}
      hide-extraction: {type: boolean, short: Hide extraction tab in debug instruments, index: 60}
      hide-form-entry-mode: {type: boolean, short: Hide entry mode control in builder settings, index: 54}
      hide-save-theme: {type: boolean, short: Hide save theme button, index: 67}
      highlight-download-button: {type: boolean, short: Highlight download button in the builder's debugger panel, index: 71}
      external-terminology-servers:
        type: BackboneElement
        short: Additional external terminology servers to show in the builder UI
        array: true
        index: 73
        elements:
          url: {type: url, short: Terminology server URL, index: 74}
          name: {type: string, short: Display name for the server, index: 75}
          default: {type: boolean, short: Whether this is the default terminology server, index: 76}
      hide-save: {type: boolean, short: Hide save button, index: 61}
      enable-share: {type: boolean, short: Make share button visible in the builder and enable accepting a serialized questionnaire from query param, index: 66}
  term-server:
    type: BackboneElement
    index: 21
    elements:
      endpoint: {type: url, short: FHIR Server that stores Terminology (ValueSet/expand$) (if not set - use Aidbox), index: 22}
      headers: {short: Headers (with credentials) for accessing Service (optional), index: 23}
      auth:
        type: BackboneElement
        short: OAuth2 client_credentials credentials for accessing Service (optional)
        index: 24
        elements:
          token-endpoint: {type: url, short: OAuth2 token endpoint issuing the access token, index: 25}
          client-id: {type: string, short: OAuth2 client id, index: 26}
          client-secret: {short: OAuth2 client secret; stored encrypted or referenced from the vault, index: 27}
          scope: {type: string, short: OAuth2 scope requested with the token (optional), index: 28}
  smart-connect:
    type: Reference
    short: Smart on FHIR connection to 3rd party server
    refers: ['http://health-samurai.io/fhir/sdc/StructureDefinition/SDCSmartConnect']
    index: 6
  theme:
    type: Reference
    short: Default theme
    refers: ['http://health-samurai.io/fhir/sdc/StructureDefinition/QuestionnaireTheme']
    index: 4
  language:
    type: code
    short: Default language for UI
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages'}
    index: 3
  data-store:
    type: BackboneElement
    index: 29
    elements:
      endpoint: {type: url, short: 'FHIR Server for storing responses, populating data, and extraction (defaults to Aidbox)', index: 30}
      headers: {short: Headers (with credentials) for accessing Service (optional), index: 31}
      auth:
        type: BackboneElement
        short: OAuth2 client_credentials credentials for accessing Service (optional)
        index: 32
        elements:
          token-endpoint: {type: url, short: OAuth2 token endpoint issuing the access token, index: 33}
          client-id: {type: string, short: OAuth2 client id, index: 34}
          client-secret: {short: OAuth2 client secret; stored encrypted or referenced from the vault, index: 35}
          scope: {type: string, short: OAuth2 scope requested with the token (optional), index: 36}
  dtr-service:
    type: BackboneElement
    short: External Da Vinci DTR service serving $questionnaire-package and $next-question (if not set - use built-in implementation)
    index: 37
    elements:
      endpoint: {type: url, short: Base URL of the external DTR service, index: 38}
      headers: {short: Headers (with credentials) for accessing Service (optional), index: 39}
      auth:
        type: BackboneElement
        short: OAuth2 client_credentials credentials for accessing Service (optional)
        index: 40
        elements:
          token-endpoint: {type: url, short: OAuth2 token endpoint issuing the access token, index: 41}
          client-id: {type: string, short: OAuth2 client id, index: 42}
          client-secret: {short: OAuth2 client secret; stored encrypted or referenced from the vault, index: 43}
          scope: {type: string, short: OAuth2 scope requested with the token (optional), index: 44}
  storage:
    type: BackboneElement
    short: Storage configuration for attachments
    index: 7
    elements:
      account:
        type: Reference
        short: Storage Account
        refers: ['http://health-samurai.io/fhir/core/StructureDefinition/AwsAccount', 'http://health-samurai.io/fhir/core/StructureDefinition/AzureContainer', 'http://health-samurai.io/fhir/core/StructureDefinition/GcpServiceAccount']
        index: 8
      bucket: {type: string, short: Storage bucket (required for GCP and S3), index: 9}
      storageAccount: {type: string, short: Azure storage account name (for Azure Workload Identity), index: 10}
      container: {type: string, short: Azure container name (for Azure Workload Identity), index: 11}
      store-absolute-url: {type: boolean, short: Store absolute url to QuestionnaireResponse attachments, index: 12}
  form:
    type: BackboneElement
    index: 77
    elements:
      default-max-width: {type: string, short: Default max width of the form, index: 82}
      auto-save-interval: {type: integer, short: Form auto-save interval in milliseconds, index: 80}
      hide-language-selector: {type: boolean, short: Hide language selector in the form, index: 87}
      allow-repopulate: {type: boolean, short: Allow repopulate for all forms, index: 92}
      hide-title: {type: boolean, short: Hide title in the form, index: 85}
      hide-download-attachment-button: {type: boolean, short: Hide download button in attachment widget, index: 93}
      redirect-on-submit: {type: url, short: Redirect URI used on form sign/amend, index: 78}
      enable-amend-button: {type: boolean, short: Enable amend button, index: 90}
      app-name: {type: string, short: App name that will be mentioned in AuditEvent logs, index: 83}
      hide-footer: {type: boolean, short: Hide the footer in the renderer altogether, index: 84}
      enable-save-button: {type: boolean, short: Enable save button, index: 91}
      read-only: {type: boolean, short: Whether the form should be read-only, index: 81}
      redirect-on-save: {type: url, short: Redirect URI used on form save/close button, index: 79}
      non-sticky-footer: {type: boolean, short: Non-sticky footer in the form, index: 86}
      hide-print-button: {type: boolean, short: Hide print button from the form, index: 88}
      enable-scriber: {type: boolean, short: Enable the voice agent in the renderer (disabled by default), index: 89}
  translations: {short: Custom translation strings for UI, index: 5}
package_version: 0.2609.1
class: resource
kind: resource
url: http://health-samurai.io/fhir/sdc/StructureDefinition/SDCConfig
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 0.2609.1
required: [name]