Smile CDR v2024.02.PRE
On this page:
   44.64    FHIR Storage Module Scheduled Tasks 44.66    FHIR Storage Package Registry   

44.65.1FHIR Validation Services

 

The FHIR Validation Services configuration category includes the following configurable options:

  • Concurrent Bundle Validation Thread Count

  • Concurrent Bundle Validation

  • Remote Terminology Service: Base URL

  • Terminology Basic Auth Password

  • Terminology Basic Auth Username

  • Remote Terminology Service: Enabled

  • Remote Terminology Service: Log HTTP Calls

  • Accept All Codings Only

  • Code Display Mismatch Policy

  • Local Reference Policy

  • Skip Contained Resource Validation

  • Suppress Validation Message Patterns

  • Unknown CodeSystem Validation Policy

44.65.2Property: Concurrent Bundle Validation Thread Count

 
Property Name Concurrent Bundle Validation Thread Count
Property Key
Property Type POSITIVE_INTEGER
Description This value is only used when Concurrent Bundle Validation property is enabled. It specifies the number of threads allocated to validating bundle resources.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 4
Example Property
module.[MODULE_ID].config.dao_config.bundle_validation_thread_count = 4

44.65.3Property: Concurrent Bundle Validation

 
Property Name Concurrent Bundle Validation
Property Key
Property Type BOOLEAN
Description If this is enabled, bundle resources will be validated in parallel threads. The number of threads is determined by the value of Concurrent Bundle Validation Thread Count property. Note that enabling this feature means bundle structure itself is not validated, only the resources within it are validated.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.concurrent_bundle_validation = false

44.65.4Property: Remote Terminology Service: Base URL

 
Property Name Remote Terminology Service: Base URL
Property Key
Property Type STRING
Description The Base URL for the FHIR server containing terminology services to use for validation.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value (no default)
Example Property
module.[MODULE_ID].config.remote_term_svc.base_url = 

44.65.5Property: Terminology Basic Auth Password

 
Property Name Terminology Basic Auth Password
Property Key
Property Type PASSWORD
Description Password used for the basic auth of the Remote Terminology Service
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value (no default)
Example Property
module.[MODULE_ID].config.remote_term_svc.base_url_password = 

44.65.6Property: Terminology Basic Auth Username

 
Property Name Terminology Basic Auth Username
Property Key
Property Type STRING
Description Username used for the basic auth of the Remote Terminology Service
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value (no default)
Example Property
module.[MODULE_ID].config.remote_term_svc.base_url_username = 

44.65.7Property: Remote Terminology Service: Enabled

 
Property Name Remote Terminology Service: Enabled
Property Key
Property Type BOOLEAN
Description If enabled, a FHIR REST-based terminology service will be used for validation. See Remote Terminology Services for more information on this feature.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.remote_term_svc.enabled = false

44.65.8Property: Remote Terminology Service: Log HTTP Calls

 
Property Name Remote Terminology Service: Log HTTP Calls
Property Key
Property Type BOOLEAN
Description If enabled, debugging HTTP logs for outbound terminology service calls will be added to smile.log. Note that this logging is very verbose and should only be used for troubleshooting.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.remote_term_svc.log_http_calls = false

44.65.9Property: Accept All Codings Only

 
Property Name Accept All Codings Only
Property Key
Property Type BOOLEAN
Description This setting enables the custom AND logic for multiple Coding validation, as opposed to the logical OR logic that is enabled by default. All codings must validate as OK as opposed to just a single one if this is enabled.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.validator.accept_all_codings_only = false

44.65.10Property: Code Display Mismatch Policy

 
Property Name Code Display Mismatch Policy
Property Key
Property Type ENUM
Values
  • FATAL
  • ERROR
  • WARNING
  • INFORMATION
Description This setting determines how the validator should behave if the display name for a Coding being validated does not agree with the expected display name from the CodeSystem. See Code Display Mismatch Policy for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value WARNING
Example Property
module.[MODULE_ID].config.validator.display_mismatch_policy = WARNING

44.65.11Property: Local Reference Policy

 
Property Name Local Reference Policy
Property Key
Property Type ENUM
Values
  • NOT_VALIDATED
  • VALIDATE_EXISTS
  • VALIDATE_TARGET
Description This property controls whether the validator should attempt to dereference/load resource references from the resource being validated to ensure that they exist, and are valid for the given reference. This type of validation is more thorough but also increases the time that an individual resource validation will take. See Validating References for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value NOT_VALIDATED
Example Property
module.[MODULE_ID].config.validator.local_reference_policy = NOT_VALIDATED

44.65.12Property: Skip Contained Resource Validation

 
Property Name Skip Contained Resource Validation
Property Key
Property Type BOOLEAN
Description This setting disables the validation of contained resources.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.validator.skip.contained.reference = false

44.65.13Property: Suppress Validation Message Patterns

 
Property Name Suppress Validation Message Patterns
Property Key
Property Type STRING_MULTILINE
Description This option can be used to specify regex patterns (one per line) for suppressing validation messages. See Suppressing Validation Messages for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value (no default)
Example Property
module.[MODULE_ID].config.validator.suppress_validation_message_patterns = 

44.65.14Property: Unknown CodeSystem Validation Policy

 
Property Name Unknown CodeSystem Validation Policy
Property Key
Property Type ENUM
Values
  • GENERATE_ERROR
  • GENERATE_WARNING
Description This setting controls how the validator will behave when a Coding contains a CodeSystem reference (Coding.system) that can not be resolved. See Handling Missing CodeSystems for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value GENERATE_ERROR
Example Property
module.[MODULE_ID].config.validator.unknown_codesystem_validation_policy = GENERATE_ERROR
   44.64    FHIR Storage Module Scheduled Tasks 44.66    FHIR Storage Package Registry