HL7 Trigger

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

The HL7 Trigger receives messages in HL7 format from healthcare systems into the Digibee Integration Platform. HL7 (Health Level 7) is a widely used communications protocol in the healthcare industry for exchanging data between systems and medical devices.

To send HL7 messages from the Platform to external systems, use the HL7 connector.

Parameters

Take a look at the configuration parameters for the trigger.

Parameter	Description	Default value	Data type
HL7 Pipeline Name	Name of the pipeline.	hl7-pipeline	String
HL7 Message Charset	Charset used to interpret the HL7 message received by the trigger.	UTF-8	String
Maximum Connection Timeout (in ms)	Maximum time allowed to establish a connection between the trigger and the client application, in milliseconds.	600000	Integer
Maximum Concurrent Connections	Maximum number of simultaneous connections the trigger can establish to receive HL7 messages from the client application.	5	Integer
Pipeline Execution Timeout (in ms)	Maximum time allowed for the pipeline execution before it times out, in milliseconds.	30000	Integer
Filter from Header (MSH-3)	Value from the HL7 header used to filter messages by type. This field is required and reads the MSH-3 header to identify different message types.	MSH-3	Header
Documentation	Optional field to describe the connector configuration and any relevant business rules.	N/A	String

HL7 Trigger in action

Filter from Header (MSH-3) parameter - Usage example

The header filters to be included must follow the standard single-word format, as shown in the example below.

Filters already enabled in the parameter settings will keep their original format:

Output

{
 "body": "<HL7_MESSAGE_CONTENT>"
}

Message example (anonymized):

{
"body": "MSH|^~\\&|TESTE|SFCT|RAPP|RFCT|20080312181835||ADT^A01|0D23ACC3-17CD-4FF4-BE66-AD4A6572079E|P|2.4\rEVN|A01|20080312181835\rPID|1||722347^^^^MR||PATIENT^TEST||19581221|F|||HIGH STREET 91^^SAINT PAUL^MN^55175^USA||[phone]^^PH|[phone]^^PH\rPV1|1|I|P166^R8^B4|R|||728625^WRIGHT^AMANDA^^MD^DR\rDG1|1|I9|472|CHRONIC PHARYNGITIS AND NASOPHARYNGITIS||A"
}