FHIR R4 Service

The FHIR R4 configuration panel is used to control the configuration of the FHIR API endpoint.

Setting Description Examples

Setting	Description	Examples
REST API Service Name	The name of the REST API service the FHIR interface should bind to. The default is FHIR however if you change the REST API name (in the panel section above) you should also change the name here.	`FHIR`
Landing Page	The HTML page where the FHIR service should use when a user accesses the FHIR base URL with no specific request.	`C:\foo\index.html`
Resource Handlers	When configured, the allowed resources which can be used on the FHIR server. If not set, then the FHIR handler will enable all installed resources on the server. This setting allows the administrator to reduce the number of resources which can be used.
Operation Handlers	When configured, the allowed operations (via `$operation`) on the FHIR API endpoints. When not set, the FHIR service will enable all operation handlers installed.
Message Handlers	When configured, the allowed FHIR messages on the API endpoints (via `$process-message`). When not set, the FHIR API will expose all message handlers installed on the SanteDB server.
Extension Handlers	When configured, the extensions which are permitted to be used on the FHIR server. When disabled, the SanteDB FHIR API will enable all FHIR extensions. Note: When an extension handler is disabled, it merely disables special treatment of that extension - the extensions being received will be placed into the `Extensions` property of the RIM.
Profile Handlers	When configured, the special profile validation services which should be used on the FHIR API.
Behavior Modifiers	When configured, the behavior modifiers for the FHIR service. Behavior modifiers allow the FHIR API to implement specific standards-based behaviors on the FHIR service.
Base Operation URL	The URL to expose to clients when a `Conformance` request or `StructureDefinition` request is received or when representing a full URL for a resource. This should be the publicly accessible URL for the FHIR service.	`https://public.com/fhir`
Default Format	The default format for FHIR requests.	JSON / XML

REST API Service Name

The name of the REST API service the FHIR interface should bind to. The default is FHIR however if you change the REST API name (in the panel section above) you should also change the name here.

FHIR

Landing Page

The HTML page where the FHIR service should use when a user accesses the FHIR base URL with no specific request.

C:\foo\index.html

Resource Handlers

When configured, the allowed resources which can be used on the FHIR server. If not set, then the FHIR handler will enable all installed resources on the server. This setting allows the administrator to reduce the number of resources which can be used.

Operation Handlers

When configured, the allowed operations (via $operation) on the FHIR API endpoints. When not set, the FHIR service will enable all operation handlers installed.

Message Handlers

When configured, the allowed FHIR messages on the API endpoints (via $process-message). When not set, the FHIR API will expose all message handlers installed on the SanteDB server.

Extension Handlers

When configured, the extensions which are permitted to be used on the FHIR server. When disabled, the SanteDB FHIR API will enable all FHIR extensions.

Note: When an extension handler is disabled, it merely disables special treatment of that extension - the extensions being received will be placed into the Extensions property of the RIM.

Profile Handlers

When configured, the special profile validation services which should be used on the FHIR API.

Behavior Modifiers

When configured, the behavior modifiers for the FHIR service. Behavior modifiers allow the FHIR API to implement specific standards-based behaviors on the FHIR service.

Base Operation URL

The URL to expose to clients when a Conformance request or StructureDefinition request is received or when representing a full URL for a resource. This should be the publicly accessible URL for the FHIR service.

https://public.com/fhir

Default Format

The default format for FHIR requests.

JSON / XML

PreviousHL7 Version 2 Service NextGS1 BMS XML Service

Last updated 2 years ago