HL7

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

HL7 sends information to healthcare systems using the HL7 (Health Level 7) communications protocol, a healthcare industry standard for exchanging data between different systems and medical devices.

Parameters

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

General

Parameter	Description	Data type	Supports DB	Default value	Visible when
Host	HL7 server host.	String	❌	hl7.server.com	—
Port	HL7 server port. The MLLP (Minimal Lower Layer Protocol) protocol typically runs on port 2575.	Integer	❌	2575	—
Connect Timeout (ms)	Time limit, in milliseconds, for the platform to connect to the server.	Integer	❌	3000	—
HL7 Message	Message field that contains the data to send.	String	✅	N/A	—
HL7 Message Charset	Charset used to encode the HL7 message.	String	❌	UTF-8	—
Advanced settings	When enabled, displays additional configuration options.	Boolean	❌	false	—
Connection Pool	Number of available connection pools.	Integer	❌	10	Advanced Settings is enabled
Enable Retries	When enabled, allows retries if execution fails.	Boolean	❌	false	Advanced Settings is enabled
Number of Retries	Number of retries to attempt if execution fails.	Integer	❌	0	Enable Retries is enabled
Time to Wait Between Retries (ms)	Time interval, in milliseconds, between retries.	Integer	❌	1000	Enable Retries is enabled
Fail on Error	When enabled, the pipeline execution stops if an error occurs. When disabled, the pipeline continues and the success property returns false.	Boolean	❌	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.	Boolean	❌	false	—

Documentation

Parameter	Description	Data type	Supports DB	Default value
Documentation	Optional field to describe the connector configuration and any relevant business rules.	String	❌	N/A

Messages flow

Output

When the HL7 connector runs, it generates the following JSON structure:

{
  "success": true,
  "exitCode": 200
}

• success: true if the operation completed successfully, false if it failed.

• exitCode: Exit code returned by the operation.