Chapter 9. Connecting to FHIR

Procedure

1. In Fuse Online, in the left panel, click Connections to display any available connections.
2. Click Create Connection to display connectors.

3. Click the FHIR connector and configure the connection as follows:

   1. In the FHIR version field, accept DSTU3, which is required.
   2. In the FHIR server URL field, enter the URL for the FHIR server that you want to access. While creating an integration, you might accept the default test server http://fhirtest.uhn.ca/baseDstu3.
   3. In the FHIR server username field, enter your username. This is required by FHIR servers that use basic authentication.
   4. In the FHIR server password field, enter your password, which is also required by FHIR servers that use basic authentication.
   5. In the FHIR server bearer token field, enter your token. This is required by FHIR servers that use OAuth authentication.
4. Click Validate. Fuse Online immediately tries to validate the connection and displays a message that indicates whether validation is successful. If validation fails, revise the input parameters and try again.
5. If validation is successful, click Next.
6. In the Name field, enter your choice of a name that helps you distinguish this connection from any other connections. For example, you might enter FHIR West.
7. In the Description field, optionally enter any information that is helpful to know about this connection.
8. Click Save to see that the connection you created is now available. If you entered the example name, you would see that FHIR West appears as a connection that you can choose to add to an integration.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection.
2. Click the FHIR connection that can access the resource that you want to obtain.
3. On the Choose an action page, select Read.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of resource that you want to obtain.

5. In the Contained Resource Types field, if the resource type that you want contains other resource types, select them. Use the Ctrl key if you need to select more than one.

   Identifying contained resource types lets the data mapper display the fields that are in the contained resources. If you do not specify a contained resource type then you cannot map from any fields that are in the contained resource. There is no harm in selecting a resource that is not actually contained.

6. In the Resource Id field, enter the ID of the resource that you want. Or, leave this field blank if you plan to map it from an earlier step that is in the flow.
7. In the Resource version field, optionally specify a version ID for the resource. Leave this field blank to obtain the most recent version of the resource or to map the version ID of the resource that you want to obtain from a previous step.
8. Click Next to add this connection to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection.
2. Click the FHIR connection that has the resources that you want to obtain.
3. On the Choose an action page, select Search.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of resource that you want to obtain.
5. In the Query field, specify a FHIR query or leave this field blank to map the query from a previous step. For details about forming a FHIR query, see FHIR Release 3 Search.
6. Click Next to add this connection to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection. Skip this step if Fuse Online is prompting you to choose the finish connection.
2. Click the FHIR connection to the server that you want to add a resource to.
3. On the Choose an action page, select Create.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of resource that you want to create.

5. In the Contained Resource Types field, if the resource type that you want to create contains other resource types, select them. Use the Ctrl key if you need to select more than one.

   Identifying contained resource types lets the data mapper display the fields that are in the contained resources. If you do not specify a contained resource type then you cannot map to or from any fields that are in the contained resource. There is no harm in selecting a resource that is not actually contained.

6. Click Next to add this connection to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection. Skip this step if Fuse Online is prompting you to choose the finish connection.
2. Click the FHIR connection that you want to use to update a resource on a FHIR server.
3. On the Choose an action page, select Update.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of resource that you want to update or create.

5. In the Contained Resource Types field, if the resource type that you want to update or create contains other resource types, select them. Use the Ctrl key if you need to select more than one.

   Identifying contained resource types lets the data mapper display the fields that are in the contained resources. If you do not specify a contained resource type then you cannot map to or from any fields that are in the contained resource. There is no harm in selecting a resource that is not actually contained.

6. Click Next to add this connection to the flow.
7. If this flow needs additional steps to obtain the data that you want the updated resource to contain, add them before this FHIR connection.
8. In the integration visualization, click the plus sign that is before the FHIR connection that updates a resource.
9. Click Data Mapper.

10. In the data mapper:

    1. Map a resource ID to the target resource ID. This is the only way to specify the resource ID for a new resource.
    2. Map to each resource field that you want the updated or new resource to contain. Be sure to map fields whose values are not changing, as well as fields whose values need to be updated.
    3. Click Done to add the data mapper step to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection. Skip this step if Fuse Online is prompting you to choose the finish connection.
2. Click the FHIR connection that you want to use to update the resource.
3. On the Choose an action page, select Patch.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of the resource whose fields you want to update.
5. In the Number of Operations field, specify the number of fields that you want to update.
6. Leave the Resource id field blank if you want to map the value from a previous step in the flow, which is typically what you want to do. Otherwise, specify the resource ID of the resource whose fields you want to update.

7. Specify a JSON patch that describes the updates. The JSON patch must have the format described in What is a JSON Patch?.

   Examples of patches for a Patient resource:

   Set the active field to true:

   [{ "op":"replace", "path":"/active", "value": true }]

   Replace the value of the name field, which is an array of the patient’s names. In this example, the patient has one name. If the patient had more than one name, a similarly formatted patch could replace all of the patient’s names:

   [{ "op":"replace", "path":"/name", "value": [{"given": ["Bob"]}] }]

   Replace the given name of a patient:

   [{ "op":"replace", "path":"/name/0/given/0", "value": "John" }]

   Add another name to a patient before the first name:

   [{ "op":"add", "path":"/name/0", "value": {"given": ["Anthony"]} }]

   For some updates, you must specify the JSON patch when you configure the Patch action. For example, if you want to copy the value of a resource field to another field. For other updates, you can leave the JSON Patch field blank and instead map values that define each update.

8. Click Next to add this connection to the flow.

9. If you did not specify a JSON patch and/or a resource ID, then add a data mapper step:

   1. In the flow visualization, click the plus sign that is before the FHIR connection that you just added.

   2. Click Data Mapper.

      The Target panel displays a numbered folder for each field that you want to update. When you configured the Patch action, you specified how many fields to update. The data mapper displays this number of folders in the Target panel. For example, if you specified 3 as the number of fields to update, you would see three target folders with the labels 1, 2, and 3.

   3. For each field that you want to update, map to the fields in one target folder:

      1. In the Target panel, expand a folder to display three fields for op, path, and value.
      2. Map a source field, constant, or property to the target path field. The path identifies the resource field that you want to update. In a path value, a number indicates the index of a list field, and a slash leads to a child field. For example, map this path /name/1/given/1/value to update the value of the given name field.
      3. Accept the default update operation, which replaces the current value of the field, or map a source field, constant, or property to the op field to indicate how you want to update the field. For details about possible operations, see JSON patch operations.
      4. If you are updating a field to have a new value, then map a source field, constant, or property to the target value. This is the new value that you want the field to contain.
   4. If you did not specify a resource ID when you configured the Patch action, then map the resource ID to the target id field.
   5. Click Done to add the data mapper step to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection. Skip this step if Fuse Online is prompting you to choose the finish connection.
2. Click the FHIR connection that you want to use to create and add new resources to a FHIR server.
3. On the Choose an action page, select Transaction.
4. In the Included Resource Types field, select the resource types that this connection creates. Use the Ctrl key to select multiple resource types. The connection creates one resource of each type that you select.
5. Click Next to add this connection to the flow.

6. To populate fields in the new resources, add a data mapper step before this connection:

   1. In the flow visualization, click the plus sign that is before the connection that you just added.
   2. Click Data Mapper.
   3. In the data mapper, map source fields to the target resource fields. The new resources contain only the target fields that you map to.
   4. Click Next to add the data mapper step to the flow.

Procedure

1. On the Add to Integration page, click the plus sign where you want to add the connection. Skip this step if Fuse Online is prompting you to choose the finish connection.
2. Click the FHIR connection that you want to use to delete the resource.
3. On the Choose an action page, select Delete.
4. Click in the Resource Type field to display a list of FHIR resource types. Select or enter the type of resource that you want to delete.
5. In the Resource Id field, specify the resource ID of the resource that you want to delete or leave this field blank if you plan to map the resource ID from an earlier step in the integration.
6. In the Resource version field, optionally specify a version ID for the resource. Leave this field blank to delete the most recent version of the resource or to map the version ID of the resource that you want to delete from a previous step.
7. Click Next to add this connection to the flow. .