Smile CDR v2022.11.PRE
On this page:
   38.37    Endpoint Terminology 38.39    FHIR Interceptors   

38.38FHIR Gateway Configuration

 

The FHIR Gateway Configuration configuration category includes the following configurable options:

  • FHIR Version

  • Gateway Configuration (File)

  • Show Underlying Errors

  • Gateway Configuration (Text)

  • Encryption JWKS (File)

  • Encryption JWKS (Text)

38.38.1Property: FHIR Version

 
Property Name FHIR Version
Property Key
Property Type ENUM
Values
  • DSTU2
  • DSTU3
  • R4
Description This is the FHIR Version supported by this gateway endpoint.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.fhir_version = 

38.38.2Property: Gateway Configuration (File)

 
Property Name Gateway Configuration (File)
Property Key
Property Type Resource Path
Description Supplies the JSON configuration for the gateway as file link. See FHIR Gateway Configuration Document for information on the format of this setting.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.gateway_configuration.file = classpath:/fhir_gateway/fhir_gateway_config.json

38.38.3Property: Show Underlying Errors

 
Property Name Show Underlying Errors
Property Key
Property Type BOOLEAN
Description On failures, all underlying errors will be included in the failure message.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.gateway_configuration.show_underlying_errors = false

38.38.4Property: Gateway Configuration (Text)

 
Property Name Gateway Configuration (Text)
Property Key
Property Type JSON
Description Supplies the JSON configuration for the gateway as raw text. See FHIR Gateway Configuration Document for information on the format of this setting.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.gateway_configuration.text = 

38.38.5Property: Encryption JWKS (File)

 
Property Name Encryption JWKS (File)
Property Key
Property Type Resource Path
Description Supplies the JWKS (Keystore) used to encrypt links supplied to the client.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.jwt_encryption.jwks_file = 

38.38.6Property: Encryption JWKS (Text)

 
Property Name Encryption JWKS (Text)
Property Key
Property Type JSON
Description Supplies the JWKS (Keystore) used to encrypt links supplied to the client.
Applies to Modules
  • FHIR Gateway REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.jwt_encryption.jwks_text = 
   38.37    Endpoint Terminology 38.39    FHIR Interceptors