Aller au contenu principal

HL7 Sender

Category: Healthcare Standards
Node id: hl7-sender

Standards: HIPAA, GDPR, SOC2

Sends HL7v2 messages via MLLP (Minimal Lower Layer Protocol), optionally over TLS, to downstream systems and optionally waits for ACK

What it does​

  • MLLP (Minimal Lower Layer Protocol) framing with VT/FS/CR bytes
  • Automatic line ending normalization to CR
  • Configurable TCP connection and read timeout
  • MLLP over TLS with private CA, server name override and mutual TLS
  • ACK response parsing with MSA segment extraction
  • ACK classification: accepted (AA), error (AE), rejected (AR)

Use cases​

  • Send ADT messages to downstream hospital systems
  • Forward lab results to clinical decision support engines
  • Transmit transformed HL7 messages to integration engines like Mirth Connect

Runtime​

  • Performance tier: variable

Input ports​

NameTypeRequiredDescription
hl7_messagetextYesHL7v2 message string to send

Output ports​

NameTypeRequiredDescription
resultjsonNoSend result (status, destination, message_size, ack_status, ack_code, ack_message)
successbooleanNoWhether the send succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
HosthoststringYesDestination hostname or IP address
PortportstringYesDestination MLLP port number

Security​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Use TLStlsbooleanNofalseSend MLLP over TLS (TLS 1.2+). The server certificate is always verified.
CA certificateca_certstringNoPEM CA bundle (content or file path) that signs the destination's certificate, e.g. a hospital private CA. Empty: the host trust store.
TLS server nameserver_namestringNoName the destination certificate must be valid for (and SNI), when it differs from host, e.g. connecting by IP. Empty: host.
Client certificateclient_certstringNoPEM client certificate (content or file path) for mutual TLS; set with client_key.
Client keyclient_keysecretNoPEM private key (content or file path; prefer a file mounted from a secret) for client_cert.

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Timeout (seconds)timeout_secondsnumberNo30min 1; max 300Connection and read timeout in seconds
Wait for ACKwait_for_ackbooleanNotrueWait for an acknowledgment response after sending

Errors​

CodeDescription
CONNECTION_FAILEDFailed to establish TCP connection to the destination
SEND_FAILEDFailed to write the HL7 message to the connection
ACK_TIMEOUTTimed out waiting for ACK response
ACK_REJECTEDReceiving system rejected the message (AR)
ACK_ERRORReceiving system reported an error (AE)

Runtime notes​

  • Line endings in hl7_message are normalized to CR before MLLP framing
  • ack_status/ack_code/ack_message are only present when wait_for_ack is true
  • ACK codes: AA=accepted, AE=error, AR=rejected — check ack_status for routing decisions
  • Timeout applies to both the TCP connection and the ACK read
  • tls=true sends MLLP over TLS 1.2+; the server certificate is always verified, against ca_cert (PEM content or file path) or the host trust store, for server_name (default: host). client_cert/client_key (PEM content or file path; prefer a mounted file for the key) present a client certificate for mutual TLS
  • result.tls says whether the message went over TLS

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Quelque chose n'est pas clair ? Envoyez vos commentaires sur la documentation par courriel.