Skip to main content

MLLP (HL7 over TCP)

The hospital standard for HL7 v2: a TCP socket with start and end framing, and an ACK per message.

Messaging↓ Inbound↑ Outbound
Type codeMLLP
Camel componentcamel-mllp
Formats carried
HL7 v2
Terms used on this page

HL7 - Health Level Seven - the standard family for exchanging healthcare messages · MLLP - Minimal Lower Layer Protocol - how HL7 v2 messages are framed on a TCP socket · ACK - acknowledgement - the receiver's reply that a message arrived · TLS - Transport Layer Security - the encryption behind https:// and secure sockets

See the Glossary for every term.

Inbound: the port is on this engine

For an inbound connection the port is the one this engine listens on. The sending system must be able to reach this machine on that port.

Both sides must agree on TLS

Inbound uses the keystore named by XE_MLLP_TLS_KEYSTORE; outbound trusts the truststore named by XE_MLLP_TLS_TRUSTSTORE.

Test connection never sends HL7

The other side would take any message written to an MLLP socket as a real one, so the test only checks that the port accepts a connection (or, inbound, that it is free).

Worked example​

Demo HL7 listener (MLLP) · Inbound · HL7 v2 · Test passes on any engine: Yes

Listens on port 2576 of this engine. Test checks the port is free; a sending system would connect to it.

Values entered by Fill example
{
"direction": "Inbound",
"format": "HL7 v2",
"settings": {
"port": "2576",
"ackTimeoutSeconds": "15"
}
}

This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.

Settings​

Required fields are marked Yes. This connector has no secret fields. A field marked inbound only or outbound only appears just for that direction.

SettingTypeRequiredDefaultWhat to enter
host
Host
textYes—outbound only. Required to send: the receiver's address, e.g. 10.0.4.21 or lis.hospital.local.
port
Port
numberYes2575Required: the TCP port, e.g. 2575 (the usual MLLP port). Inbound: the port this engine listens on.
tls
Use TLS
checkboxNofalseEncrypt the socket. Both sides must agree. Inbound uses XE_MLLP_TLS_KEYSTORE; outbound trusts XE_MLLP_TLS_TRUSTSTORE.
ackTimeoutSeconds
ACK timeout (seconds)
numberNo15How long to wait for the HL7 ACK, e.g. 15. No ACK in time = tried again.

What "Test connection" checks​

Outbound: the host and port accept a connection. Inbound: the port is free on this engine. No message is sent.

Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.