FHIR Module
  • 02 Apr 2024
  • 3 Minutes to read
  • Dark
    Light

FHIR Module

  • Dark
    Light

Article summary

Module Details

Core or GitHub Module

GitHub Module

Restart Required

No

Step Location 

Integration > FHIR

Prerequisites

Modified in Version

8.16

HL7 FHIR is a standard for exchanging healthcare information among computer systems, ensuring secure access for authorized users. Developed by HL7, FHIR enables interoperability by defining how clinical and administrative data can be shared. The collaborative approach of HL7 supports ongoing development and upgrades of FHIR for the benefit of patient care.

The Module provides users with pre-built Flow steps that can help users access and manipulate FHIR data objects. For FHIR, any entities using SimpleQuantities now use Quantities.


Breaking Changes

  • Version 4 of the FHIR Module has now been added to the platform for v8 for v8.16 and earlier.

  • Please note that the FHIR and FHIRv4 Modules are NOT compatible. For applicable versions, the FHIR Module will need to be uninstalled in order for the FHIRv4 Module to be functional.

  • Users may reach out to support@decisions.com for assistance with uninstalling Modules.


Available Steps

The following section lists all the available steps that are exposed after installing the FHIR Module. These steps can be found in the Toolbox > Integration > FHIR.

Add Resource to Bundle

This step allows users to add a FHIR resource to a FHIR Bundle. A FHIR Bundle is a collection of resources that can be transmitted or processed together. The step takes in an  FHIR Bundle, Resource, and the Resource URL as inputs and outputs a new FHIR Bundle Object.

Inputs

Description

FHIR Bundle

The FHIR Bundle.

Resource to ADD

The additional resource being added to the bundle.

Resource URL

The Resource URL.

Outputs

Description

FHIR Bundle Result

The updated FHIR Bundle.

Cast FHIR Resource to FHIR Type

This step involves converting a FHIR Resource to its corresponding FHIR Datatype. FHIR Types define the structure and format of data elements within a resource.

Settings

Description

FHIR Type Name

The FHIR Resource is being cast into another resource Type.

FHIR Version

Select the desired FHIR Version from the drop-down.

Inputs

Description

FHIR Resource

The FHIR Resource is being cast into another resource Type.

For Each Resource in FHIR Bundle

The step functions similarly to a ForEach step. It iterates through each FHIR Resource within an FHIR Bundle, allowing users to perform actions or operations on individual resources within the bundle.

Inputs

Description

FHIR Bundle

The FHIR Bundle used by the step.

Get JSON for FHIR Bundle

This step retrieves the JSON representation of a FHIR Bundle in the output.

Inputs

Description

FHIR Bundle

The FHIR Bundle used as an input.

Version

Select the desired FHIR Version from the drop-down.

Outputs

Description

Output

The JSON formatted string of the datatype.

Get JSON for FHIR Object

This step retrieves the JSON representation of a FHIR Object in the output.

Inputs

Description

FHIR Base Object

The FHIR Object used as an input.

Version

Select the desired FHIR Version from the drop-down.

Outputs

Description

Output

The JSON formatted string of the input.

Get JSON For FHIR Resource

This step retrieves the JSON representation of a specific FHIR Resource.

Inputs

Description

FHIR Resource

The FHIR Bundle used as an input.

Version

Select the desired FHIR Version from the drop-down.

Outputs

Description

Output

The JSON formatted string of the input.

Get Resources from Bundle

This step retrieves a list of Resources used in the FHIR Bundle.

Inputs

Description

FHIR Bundle

The inputted FHIR Bundle.

Outputs

Description

Resource List

A list of Objects contained in the Bundle.

Read Bundle From JSON Data

This step takes in a JSON formatted string and outputs an FHIR Bundle.

Inputs

Description

JSON FHIR Data

A JSON-formatted string.

Version

Select the desired FHIR Version from the drop-down.

Outputs

Description

Output

The outputted FHIR Bundle.

Read JSON and Cast to FHIR Type

This step reads JSON data representing an FHIR Type and converts it to the corresponding FHIR Datatype, allowing for structured data processing.

Settings

Description

FHIR Type Name

The FHIR resource is being cast into another resource Type.

FHIR Version

Select the desired FHIR Version from the drop-down.

Inputs

Description

FHIR Resource JSON

A JSON-formatted string.

Read Resource From JSON

This step reads and interprets an FHIR Resource from its JSON representation. This step facilitates the conversion of JSON data back into a FHIR Resource.

Inputs

Description

JSON FHIR Data

A JSON-formatted string.

Version

Select the desired FHIR Version from the drop-down.

Outputs

Description

Output

The outputted resource.


Feature Changes

Description

Version

Developer Task


Was this article helpful?