Smile CDR v2024.02.PRE

On this page:

44.48 Endpoint Terminology 44.50 FHIR Interceptors

44.49.1FHIR 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)
The default page size
The maximum page size
Cache Expiration Seconds
Pagination cache provider

44.49.2Property: FHIR Version

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

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

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

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

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

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

44.49.8Property: The default page size

Property Name	The default page size
Property Key
Property Type	INTEGER
Description	The default number of resources per page when _count is not provided. If not specified, it will be set to 20.
Applies to Modules	FHIR Gateway REST Endpoint
Default Value	`20`
Example Property	`module.[MODULE_ID].config.pagination.default_page_size = 20`

44.49.9Property: The maximum page size

Property Name	The maximum page size
Property Key
Property Type	INTEGER
Description	The maximum allowable value for _count. Higher _count values will be reduced to this value. If not specified, it will be set to 100.
Applies to Modules	FHIR Gateway REST Endpoint
Default Value	`100`
Example Property	`module.[MODULE_ID].config.pagination.maximum_page_size = 100`

44.49.10Property: Cache Expiration Seconds

Property Name	Cache Expiration Seconds
Property Key
Property Type	INTEGER
Description	The number of second for cache expiration (Default 300)
Applies to Modules	FHIR Gateway REST Endpoint
Default Value	`300`
Example Property	`module.[MODULE_ID].config.pagination_cache.expiration.seconds = 300`

44.49.11Property: Pagination cache provider

Property Name	Pagination cache provider
Property Key
Property Type	ENUM
Values	`CAFFEINE` `INFINISPAN`
Description	The pagination cache provider: CAFFEINE (default) or INFINISPAN
Applies to Modules	FHIR Gateway REST Endpoint
Default Value	`CAFFEINE`
Example Property	`module.[MODULE_ID].config.pagination_cache.type = CAFFEINE`

44.48 Endpoint Terminology 44.50 FHIR Interceptors