HL7 Formatter

convert structured JSON documents into binary HL7 v2.5 formatted messages

Overview

Use this Snap to convert structured JSON documents into binary HL7 v2.5 formatted messages. The Snap formats the data according to the HL7 v2.5 standard, and can validate the result before writing it to the output view.

This Snap processes JSON data and transforms it into pipe-delimited HL7 v2.5 messages for integration with healthcare systems and applications.


HL7 Formatter Snap dialog

  • This is a Format-type Snap.
  • Does not support Ultra Tasks

Prerequisites

Valid JSON document containing HL7 v2.5 message data.

Limitations and known issues

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input JSON document containing valid HL7 message data.
Output Binary stream containing the formatted HL7 data.
Learn more about Error handling.

Examples

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: HL7 Formatter

Example: HL7 ADT Formatter
Character encoding

Dropdown list/Expression

 Required. The character encoding scheme for the output content.
The available options are:
  • ISO-8859-1: A single-byte character encoding standard.
  • UTF-8: A variable-length encoding that can represent the most characters in the Unicode standard.
  • UTF-16: A 16-bit, variable-length character encoding.

Default value: UTF-8

Example: UTF-16
Segment terminator

Dropdown list/Expression

Required. The character sequence that terminates each segment in the formatted HL7 message. This terminator enables the receiving system to identify the segment boundaries in the message.

The available options are:
  • \r (Carriage Return): Terminates each segment with a carriage return, as specified by the HL7 standard.
  • \r\n (Carriage Return + Line Feed): Terminates each segment with a carriage return followed by a line feed. Use this option for systems that expect Windows-style line endings.

Default value: \r (Carriage Return)

Example: \r\n (Carriage Return + Line Feed)
Validation mode

Dropdown list/Expression

Required. The level of validation that the Snap applies to the formatted HL7 message.

The available options are:
  • None: The Snap does not validate the formatted message.
  • Lenient: The Snap validates the formatted message but tolerates deviations from the HL7 v2.5 structure, such as missing optional segments or fields.

Default value: None

Example: Lenient

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & Execute

Example: Execute only