On this page:
   35.43    FHIR Resource Types 35.45    FHIR Search   

35.44FHIR 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

35.44.1Property: Fixed Value for Endpoint Base URL

 
Property Name Fixed Value for Endpoint Base URL
Property Key
Property Type STRING
Description 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.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.base_url.fixed = https://apis.example.org/fhirBaseUrl

35.44.2Property: Default Encoding

 
Property Name Default Encoding
Property Key
Property Type ENUM
Values
  • JSON
  • XML
  • RDF
Description Specifies the default encoding (i.e. JSON/XML) to use if the client does not specify a preference in the request.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value JSON
Example Property
module.[MODULE_ID].config.default_encoding = JSON

35.44.3Property: Default Prefer Return

 
Property Name Default Prefer Return
Property Key
Property Type ENUM
Values
  • REPRESENTATION
  • MINIMAL
  • OPERATION_OUTCOME
Description 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.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value REPRESENTATION
Example Property
module.[MODULE_ID].config.default_prefer_return = REPRESENTATION

35.44.4Property: Pretty-Print by Default

 
Property Name Pretty-Print by Default
Property Key
Property Type BOOLEAN
Description 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 to they can have performance and size impacts.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value true
Example Property
module.[MODULE_ID].config.default_pretty_print = true

35.44.5Property: Process Header: Request Source

 
Property Name Process Header: Request Source
Property Key
Property Type BOOLEAN
Description If enabled, the server will respect the X-Request-Source header. See Capturing Source Information for more details.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.process_request_header.request_source_enabled = false

35.44.6Property: Serve Raw Media Resources

 
Property Name Serve Raw Media Resources
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.serve_raw_media_resource = false
   35.43    FHIR Resource Types 35.45    FHIR Search