FHIR Connector

Back Next

Request message

In the Source transformation, you can configure the request message to specify request headers, path parameters, and query parameters to access a resource on a FHIR server.

You can configure the following headers and parameters in the request message:

requestHeaders: Request headers are additional headers that the connection requires.

Define headers in JSON format. For example:

[{"Name":"Content-Type","Value":"application/fhir+json"},{"Name":"accept","Value":"text/xml"}]

You can configure request headers in the request message, the FHIR connection properties, and the advanced properties of the Source transformation. When you define a header in the request message, it overrides the request headers in the connection properties and in the advanced properties.
pathParams: Path parameters are a sequence of values that replace the values in the path of the request message.

For example, you might want to access a FHIR resource at the following path:

https://hapi.fhir.org/baseR4/Patient/593251/_history/2

In the advanced properties, configure the following path:

/Patient/{id}/{history}/{version}

Then, in the request message, configure the following value for pathParams:

<pathParams>59321,_history,2<pathParams/>
queryParams: Query parameters are used to query resources on the FHIR server using search criteria that are available for the resource.

For example, you can use the following query parameters to access a patient in
https://hapi.fhir.org/baseR4/Patient
:

<queryParams>given=Benjamin;identifier=bcook74;gender=male <queryParams/>

At run time, the query parameters resolve to
https://hapi.fhir.org/baseR4/Patient?given=Benjamin&identifier=bcook74&gender=male
.

You can find examples of search parameters and modifiers in the FHIR Specification documentation. However, not all search criteria and modifiers are available in mappings.

Rename Saved Search

Table of Contents

FHIR Connector

FHIR Connector

Request message

Request message