FHIR REST Endpoint
The FHIR REST Endpoint configuration category includes the following configurable options:
Fixed Value for Endpoint Base URL
Default Encoding
Default Prefer Return
Pretty-Print by Default
Process Header: Request Source
Serve Raw Media Resources
|
|
Fixed Value for Endpoint Base URL |
|
|
|
| STRING | |
If specified, the server will always use this base URL for FHIR responses (e.g. in Location headers, Bundle paging links, etc.). Note that changing this setting does not actually change the port or address that Smile CDR will use to serve up this endpoint. This setting merely changes the URL that will be advertised in responses. This feature is typically used in Smile CDR installations where network infrastructure in place between the publicly accessible FHIR API network endpoint and Smile CDR prevents Smile CDR from being aware of what address end users are actually using to access the FHIR APIs. This generally means reverse proxies and load balancers that are not able to correctly supply a Forwarded header, or equivalent as described here.
|
|
|
|
| (no default) | |
|
|
|
Default Encoding |
|
|
|
| ENUM | |
| Values |
|
| Specifies the default encoding (i.e. JSON/XML) to use if the client does not specify a preference in the request. | |
|
|
JSON
|
|
|
|
|
Default Prefer Return |
|
|
|
| ENUM | |
| Values |
|
This setting controls the default HTTP response payload for FHIR create/update/patch/transaction operations. By default the body of the resource as it was stored is returned (REPRESENTATION), but this default behavior can be changed to return an OperationOutcome resource (OPERATION_OUTCOME) or no payload at all (MINIMAL) by modifying this setting. Note that clients may override the default behavior on individual requests using the HTTP Prefer header as described in the FHIR Specification.
|
|
|
|
REPRESENTATION
|
|
|
|
|
Pretty-Print by Default |
|
|
|
| BOOLEAN | |
| If enabled, responses will be pretty-printed by default unless the client request explicitly requests non-pretty-printed responses. Pretty-printed responses are useful for debugging and human readability but they contain extra spaces so they can have performance and size impacts. | |
|
|
true
|
|
|
|
|
Process Header: Request Source |
|
|
|
| BOOLEAN | |
If enabled, the server will respect the X-Request-Source header. See Capturing Source Information for more details.
|
|
|
|
false
|
|
|
|
|
Serve Raw Media Resources |
|
|
|
| BOOLEAN | |
| If enabled, clients may request a FHIR Read on a Media resource using either an Accept header or an additional parameter that requests the raw contents of the resource be served directly instead of the complete FHIR resource. See Serving Raw Media Resources for more information. | |
|
|
false
|
|
|