FHIR Search

This component allows you to perform a Search operation on the FHIR server to search for resources. To perform a Search on the FHIR server, you should select the type of Resource that you want retrieved and use the FHIR URI query parameters to specify the Search criteria. The result of a Search operation is a FHIR bundle containing resources that match the Search criteria.

A Search operation may return resources as a series of pages, when the resource collection returned by search is too long. In this case, the resources in the response are chunked into pages where each page has a reference to the next one (if any). Typically, the maximum number of resources in each page is defined on the FHIR server. The component's Pages Limit option allows you to control the number of pages to read from the response.

Overview Tab

The Overview tab gives you basic information about the selected component on a route.

Settings Tab

In addition to common FHIR components settings, this component has the following specific settings:

Field	Description
Resource	Specify the type of the FHIR resource on which the operation is performed.
Response Type	Specify a data format for the FHIR server response (XML or JSON). The data format on the component's output is the same as the response from the FHIR server. In the auto mode, the format of the response is automatically defined based on the XEServer message received as the component's input. In this case, the format of the response from the FHIR server (and the component's output) is the same as the component's input message. Tip If the data received as input is in any format other than XML, the component asks the target FHIR server to return the response as JSON.
Pages limit	This option defines how many pages of the search results the component should process. A Search operation on the FHIR server may return a collection of resources as a series of pages, when the number of searched resources is too big. The bundle with the searched resources contains a first page with resources and a reference to the next page which in turn has a reference to the next. For example, a list of patients can be represented as a series of linked pages as shown in the image below. When the FHIR component receives this multi-page response, the component automatically traverses the linked pages and for each page in the response, the component generates an XEServer exchange with one message. This option defines the maximum number of references between the pages the component has to traverse in the response. Setting a value lower than 1 removes the limit (the component reads all the pages).
URI query parameters	Specify the URI query parameters which are appended to the FHIR server's base URL at the time of request building. You can specify up to 100 query parameters. For detailed information on supported FHIR parameters, click here.

Outputs Tab

On this tab, you can direct data to the subsequent components on the route after the current component's processing is complete. Depending on the component's processing results, data is submitted to one or more of the component's outputs.

You can also set the XEServer properties for each output. XEServer allows you to pass additional metadata within the XEServer messages. For more information, see Component Output Properties.

QoS Tab

The Quality of Service (QoS) tab allows you to specify the behavior of the service if there are errors. You can specify Retry parameters by enabling Custom Retry Strategy.

Events Tab

On this tab, you can configure the component to send events to Edifecs XProcess Management. For more information, see Component Events Tab.

Breakpoints Tab

On this tab, you can set breakpoints for a selected component to debug the route. For more information, see Component Breakpoints Tab.