FHIR Module
- 17 Apr 2024
- 2 Minutes to read
- Print
- DarkLight
FHIR Module
- Updated on 17 Apr 2024
- 2 Minutes to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Module Details | |
Core or GitHub Module | GitHub Module |
Restart Required | No |
Step Location | Integration > FHIR |
Prerequisites | |
Modified in Version | 8.18 |
HL7® FHIR® is a standard for exchanging healthcare information among computer systems, ensuring secure access for authorized users. Developed by HL7®, it 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.
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.
Step ModificationIn Decisions v8.18 and later, users can select the FHIR version on the Step properties. The FHIR version includes STU3, R4, R4B, and R5.
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 data type. 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. 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 |
|---|---|
FHIRBundle | 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 |
|---|---|
FHIRBase 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 |
|---|---|
FHIRResource | 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 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 FHIRData | 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 data type, 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 FHIRData | 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 |
|---|---|---|
Introduced a new setting on the FHIR Module steps to set the FHIR Version | [DT-039012] |
Was this article helpful?
