For the complete documentation index, see llms.txt. This page is also available as Markdown.

HL7 Message Transformer

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

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

Parameters

Configure the connector using the parameters below. Fields that support Double Braces expressions are marked in the Supports DB column.

Parameter
Description
Data type
Supports DB
Default value
Visible when

Output Format

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

String

JSON

Message

The HL7 message or JSON object to convert.

String

N/A

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.

String

false

Raw Pass Through

When enabled, returns the original HL7 message unchanged under "data", bypassing the parse-encode cycle entirely: no escape normalization, no trimming of trailing empty fields/components, and no MSH-2 regeneration. Use this when the message must reach its destination byte-for-byte (e.g., the receiving system performs its own parsing). Leave disabled for the default behavior, which parses and re-encodes the message — a normalizing process that is not guaranteed to be byte-preserving.

false

Output Format is JSON

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

HL7 to JSON

Connector’s configuration:

  • Output Format: JSON

  • Data:

Connector’s output:

JSON to HL7

Connector’s configuration:

  • Output Format: HL7

  • Data:

Connector’s output:

HL7 message examples

ADT_A01

HL7 message:

JSON representation:

RDE_O01

HL7 message:

JSON representation:

VXU_V04

HL7 message:

JSON representation:

DFT_P03

HL7 message:

JSON representation:

Last updated

Was this helpful?