Smile CDR v2022.08.PRE
On this page:
   37.87    Realtime Export 37.89    Search Parameter Seeding   

37.88Endpoint Validation: Request Validating

 

The Endpoint Validation: Request Validating configuration category includes the following configurable options:

  • Request Validating Bean Types

  • Request Validating Enabled

  • Fail On Severity

  • Validation Response Headers Enabled

  • Validation Tags Enabled

37.88.1Property: Request Validating Bean Types

 
Property Name Request Validating Bean Types
Property Key
Property Type STRING
Description A comma-separated list of subclasses of IValidationSupport to be added to the validation support chain.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.request_validating.bean_types = 

37.88.2Property: Request Validating Enabled

 
Property Name Request Validating Enabled
Property Key
Property Type BOOLEAN
Description If enabled, the official FHIR StructureDefinitions and ValueSets will be used to validate resources for incoming FHIR requests.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.request_validating.enabled = false

37.88.3Property: Fail On Severity

 
Property Name Fail On Severity
Property Key
Property Type ENUM
Values
  • WARNING
  • ERROR
  • FATAL
Description The severity at which to fail validated requests.

Request Validating must be enabled for this setting to take effect.

Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value ERROR
Example Property
module.[MODULE_ID].config.request_validating.fail_on_severity = ERROR

37.88.4Property: Validation Response Headers Enabled

 
Property Name Validation Response Headers Enabled
Property Key
Property Type BOOLEAN
Description If enabled, an informative header will be added to the response during validation.

Request Validating must be enabled for this setting to take effect.

Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.request_validating.response_headers.enabled = false

37.88.5Property: Validation Tags Enabled

 
Property Name Validation Tags Enabled
Property Key
Property Type BOOLEAN
Description If enabled, an informative tag will be added to a resource during validation. Existing Smile CDR validation tags will be stripped from the incoming resource.

Request Validating must be enabled for this setting to take effect.

Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.request_validating.tags.enabled = false
   37.87    Realtime Export 37.89    Search Parameter Seeding