Configuring an Existing FHIR Server

You cannot edit the data organization strategy for an existing FHIR server. To use a different strategy, create a new server.

You cannot edit the database locations from the FHIR Server Management page once the databases contain resources.

To route FHIR requests through an interoperability production before they reach the FHIR server, select the package and name of the business service that will receive the requests. Unless the business service has a custom name, this entry is HS.FHIRServer.Interop.Service.

For more details, see

• Interoperability Productions

• Adding Business Hosts

The FHIR server is an OAuth resource server. From the point of view of the OAuth 2.0 authorization server, it is a client. Specify the application (client) name for the FHIR server resource server to use when contacting the OAuth 2.0 authorization server. Select the desired OAuth client name from the dropdown list. For more information about OAuth 2.0 support, see Using OAuth 2.0 with a FHIR Server under FHIR Security.

To configure the FHIR server such that a FHIR client requires a particular resource in order to send a request, select that resource from the dropdown.

To add a security resource for your FHIR client, see Adding Authorization Requirements.

Search result page size to use when a search does not contain a _count parameter.

Maximum search result page size to prevent an excessive user-specified page size.

Maximum number of resources that can be selected by a search before the server responds to the query with an error. This number only includes resources selected by the actual search; it does not include resources included using an _include search parameter. This value does not affect the size of pages returned by a search. Overly broad searches that select large numbers of resources take a lot of system resources to fulfill, and are probably more broad than the client actually needs.

Specifies what happens by default when a search request contains an unknown parameter:

• To ignore an unknown parameter in a search request and return a bundle in which the OperationOutcome resource identifies the issue, specify lenient.

• To reject a search request with an unknown parameter and return an error, specify strict.

A FHIR search request that includes the “prefer headerOpens in a new tab” overrides this default.

Maximum allowable number of resources to delete using conditional delete. If the conditional delete search finds more than this number of resources, then the conditional delete as a whole is rejected with an HTTP 412 “Precondition Failed” error.

Maximum number of seconds between requests to the service before any session data is considered stale.

Specify the server’s SMART on FHIR capabilities by entering them as a comma-delimited list into this field. This list does not control the functionality of the endpoint; rather, it specifies the capabilities that are returned in the JSON document when a client appends /.well-known/smart-configuration to the endpoint’s URL. For example:

launch-ehr, context-ehr-patient, permission-patient, client-public, client-confidential-symmetric

For more details about SMART on FHIR capabilities retrieved with Well-Known URIs, see FHIR Authorization Endpoint and Capabilities Discovery using Well-Known Uniform Resource Identifiers (URIs)Opens in a new tab.

Select this option to prevent search parameter indexing errors from aborting FHIR resource save.

Select this option to make FHIR search queries more efficient by adding a SQL operation TOP N where N is the value of the _maxresults search result parameter.

Allows a user with permissions to suppress FHIR auditing.

In a HealthShare ODS, select this option to create Provenance resources for each new record in the ODS.

Comma-delimited string of configurations for functional lists. Each list element is a colon-delimited string of three items:

• functional list name — the names available in the default interactions strategy are:

  • $current-problems

  • $current-medications

  • $current-allergies

  • $current-drug-allergies

• list subject search parameter — can be patient, subject, or source

• list subject resource type — for example, Patient

The default value is:

$current-problems:patient:Patient, 
$current-medications:patient:Patient, 
$current-allergies:patient:Patient, 
$current-drug-allergies:patient:Patient