57.68 FHIR Storage Module Scheduled Tasks 57.70 FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption)

57.141.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: Client Connect Timeout (ms)
Remote Terminology Service: Client Pool Max
Remote Terminology Service: Client Pool Max Per Route
Remote Terminology Service: Client Socket Timeout (ms)
Remote Terminology Service: Enabled
Remote Terminology Service: Log HTTP Calls
Remote Terminology smart authentication client id
Force http audience in token requests
Remote Terminology smart authentication keystore
Remote Terminology Smart Authentication Scope
Accept All Codings Only
Code Display Mismatch Policy
Local Reference Policy
Skip Contained Resource Validation
Validation Support Cache Expiry (mins)
Validation Support Cache Size
Suppress Validation Message Patterns
Unknown CodeSystem Validation Policy

57.141.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`

57.141.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`

57.141.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 =`

57.141.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 =`

57.141.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 =`

57.141.7Property: Remote Terminology Service: Client Connect Timeout (ms)

Property Name	Remote Terminology Service: Client Connect Timeout (ms)
Property Key
Property Type	POSITIVE_INTEGER
Description	The amount of time that the initial FHIR client connection attempt network operation may block without failing.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`10000`
Example Property	`module.[MODULE_ID].config.remote_term_svc.client_connect_timeout_ms = 10000`

57.141.8Property: Remote Terminology Service: Client Pool Max

Property Name	Remote Terminology Service: Client Pool Max
Property Key
Property Type	POSITIVE_INTEGER
Description	The maximum number of connections allowed in the FHIR client connection pool.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`20`
Example Property	`module.[MODULE_ID].config.remote_term_svc.client_pool_max = 20`

57.141.9Property: Remote Terminology Service: Client Pool Max Per Route

Property Name	Remote Terminology Service: Client Pool Max Per Route
Property Key
Property Type	POSITIVE_INTEGER
Description	the maximum number of connections per route allowed in the FHIR client connection pool.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`20`
Example Property	`module.[MODULE_ID].config.remote_term_svc.client_pool_max_per_route = 20`

57.141.10Property: Remote Terminology Service: Client Socket Timeout (ms)

Property Name	Remote Terminology Service: Client Socket Timeout (ms)
Property Key
Property Type	POSITIVE_INTEGER
Description	The amount of time that a FHIR client read/ write network operation may block without failing.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`10000`
Example Property	`module.[MODULE_ID].config.remote_term_svc.client_socket_timeout_ms = 10000`

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

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

57.141.13Property: Remote Terminology smart authentication client id

Property Name	Remote Terminology smart authentication client id
Property Key
Property Type	STRING
Description	Name of the client id defined for the Remote Terminology Service Smart Authentication in the remote terminology authentication server
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.smart_authentication_client_id =`

57.141.14Property: Force http audience in token requests

Property Name	Force http audience in token requests
Property Key
Property Type	BOOLEAN
Description	Always use `http` schema for audience JWT parameter for token requests
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.smart_authentication_force_http_audience = false`

57.141.15Property: Remote Terminology smart authentication keystore

Property Name	Remote Terminology smart authentication keystore
Property Key
Property Type	STRING
Description	Name of the keystore used for Remote Terminology Service Smart authentication
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.smart_authentication_keystore_name =`

57.141.16Property: Remote Terminology Smart Authentication Scope

Property Name	Remote Terminology Smart Authentication Scope
Property Key
Property Type	STRING
Description	Scope included in authentication token requests sent to Remote Terminology Service Smart Authentication JWTs
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`system/*.read`
Example Property	`module.[MODULE_ID].config.remote_term_svc.smart_authentication_scope = system/*.read`

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

57.141.18Property: Code Display Mismatch Policy

Property Name	Code Display Mismatch Policy
Property Key
Property Type	ENUM
Values	`FATAL` `ERROR` `WARNING` `INFORMATION` `SUCCESS`
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`

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

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

57.141.21Property: Validation Support Cache Expiry (mins)

Property Name	Validation Support Cache Expiry (mins)
Property Key
Property Type	POSITIVE_INTEGER
Description	This is the number of minutes an entry should be allowed to live in the Validation Support Cache. the maximum number of entries to store in the Validation Support Cache.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`60`
Example Property	`module.[MODULE_ID].config.validator.support_cache.expiry_mins = 60`

57.141.22Property: Validation Support Cache Size

Property Name	Validation Support Cache Size
Property Key
Property Type	POSITIVE_INTEGER
Description	This is the maximum number of entries to store in the Validation Support Cache.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`10000`
Example Property	`module.[MODULE_ID].config.validator.support_cache.size = 10000`

57.141.23Property: 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 =`

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

57.68 FHIR Storage Module Scheduled Tasks 57.70 FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption)