HL7 Message Transformer (Beta)

Discover more about the HL7 Message Transformer connector and how to use it on the Digibee Integration Platform.

circle-info

The HL7 Message Transformer connector is currently in beta phase. Learn more about the Beta Program.

HL7 Message Transformer converts HL7 messages to and from JSON format, enabling efficient data transformation in healthcare integrations.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter
Description
Default value
Data type

Output Format

The format to which the message or object will be converted. Options: JSON or HL7.

JSON

String

Message (DB)

The HL7 message or JSON object to convert.

N/A

String

Fail On Error

If the option is active, the execution of the pipeline with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

String

Documentation tab

Parameter
Description
Default value
Data type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Additional information

Supported versions

The supported HL7 message versions are:

  • 2.1

  • 2.2

  • 2.3

  • 2.3.1

  • 2.4

  • 2.5

  • 2.5.1

  • 2.6

  • 2.7

  • 2.8

  • 2.8.1

Format changes in HL7-JSON conversions

When converting an HL7 message to JSON and back to HL7, the final message may differ from the original.

For example, a segment ending in |ABC|||| will appear as |ABC. Similarly, fields with values like |^^| or |ABCˆˆ will be represented as || and |ABC, respectively.

This happens because these characters serve as field separators (|) or encoding characters (^^), not actual values. This behavior follows HL7 standards and doesn’t affect message integrity. The JSON structure used in conversion also adheres to HL7 standards.

Usage examples

chevron-rightHL7 to JSONhashtag

Connector’s configuration:

  • Output Format: JSON

  • Data:

Connector’s output:

chevron-rightJSON to HL7hashtag

Connector’s configuration:

  • Output Format: HL7

  • Data:

Connector’s output:

HL7 message examples

chevron-rightADT_A01hashtag

HL7 message:

JSON representation:

chevron-rightRDE_O01hashtag

HL7 message:

JSON representation:

chevron-rightVXU_V04hashtag

HL7 message:

JSON representation:

chevron-rightDFT_P03hashtag

HL7 message:

JSON representation:

Last updated

Was this helpful?