HL7 Fast Healthcare Interoperability Resources
Export Configuration#
Exporting a FHIR service via a Tranquil Data peer extends the configuration object with the following fields:
| Field Name | Type | Required | Default |
|---|---|---|---|
| endpoint | string | ||
| frontendPath | string | ||
| rewriteURLs | boolean | true |
The value of type must be fhir.
The value of endpoint is of the form http://HOST:PORT/TARGET_BASE where TARGET_BASE is the service base URL of the backing FHIR server.
The value of frontendPath is of the form /TRANQUIL_BASE where TRANQUIL_BASE is the base URL that Tranquil Data will use (which may be different than TARGET_BASE). If TARGET_BASE is non-empty then frontendPath must be given a value.
As an example, if a FHIR server is running at http://XXX:YY/fhir, then fhir would be the TARGET_BASE. To have tranquil use the same service base URL, you would specify the frontendPath as /fhir. If the desired behavior was for tranquil to use a different service base than the backing FHIR service, you'd specify the alternative in frontendPath.
If the value of rewriteURLs is true then the service will process each resource and re-write each URL in that resource that points to the backing FHIR service to instead point to the endpoint exported through Tranquil Data.
Security Support#
The FHIR standard recommends the use of Oauth to authenticate users and clients. Tranquil supports the Oauth mechanism of the backing FHIR server, if it implements one. That is, the client-provided authentication in the HTTP headers (typically an Oauth2 token) is passed on to the backing server. The backing server verifies the authenticity and, if successful, serves the request. In this regime, no additional configuration of Tranquil is necessary.
Context Interaction#
Anonymous context is created from any FHIR documents read from a FHIR service. Tranquil Data can form context from either JSON or XML encoded documents.
Each FHIR request will return a bundle of results, and each request will be considered its own session, so every context value created from a response bundle will be in the same session.
Context and policy evaluation are supported for the following REST calls:
GET /BASE- any GET query, including by resource type as well as using search query parameters
FHIR responses include URLs for the resources returned (as well as URLs for getting additional results when paging). Those returned URLs will be relative to Tranquil Data's exported endpoint and NOT the backing FHIR service's endpoint.