FHIR Resource

The component allows you to perform CRUD operations on FHIR resources. The component's output is a FHIR resource that was created, updated, read, or deleted.

Overview Tab

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

Settings Tab

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

Resource

Field Description
Use connection settings from component

Select this option to unbind the component from the currently used XEServer FHIR Service and use the component-level connection settings. If you choose to select this option, you should enter the connection settings on the Connection tab.

Service name

Select the XEServer FHIR service to use. If a service is not available, click Create New. Click View to go to the service configuration page.

Operation

Select one of the following operations to perform on a FHIR resource:

  • CREATE: Creates a new resource on the FHIR server based on the component's input XEServer message. The body of the input message should either be JSON or XML data.
  • DELETE: Removes a FHIR resource identified by the Path field.
  • PATCH: Updates an existing resource by posting a set of changes to it.
  • READ: Retrieves the contents of a FHIR resource identified by the Path field. For each resource retrieved by the operation, the component wraps the retrieved data into an XEServer message and sends the data to the component's output.
  • UPDATE: Replaces the contents of an existing FHIR resource identified by the Path field based on the component's input XEServer message. The body of the input message should either be JSON or XML data.
Resource

Select from the drop-down list the type of FHIR resource on which the operation is performed.

Response Type

Specify a data format in which the FHIR server should return the 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.

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.