This component supports the following:
- HL7 MLLP codec for Mina
- HL7 MLLP codec for Netty4 from Camel 2.15 onwards
- Type Converter from/to HAPI and String
- HL7 DataFormat using the HAPI library
Maven users will need to add the following dependency to their
pom.xml for this component:
HL7 MLLP protocol
HL7 is often used with the HL7 MLLP protocol, which is a text based TCP socket based protocol. This component ships with a Mina and Netty4 Codec that conforms to the MLLP protocol so you can easily expose an HL7 listener accepting HL7 requests over the TCP transport layer. To expose a HL7 listener service, the camel-mina2 or camel-netty4 component is used with the
HL7MLLPCodec (mina2) or
HL7 MLLP codec can be configured as follows:
The start byte spanning the HL7 payload.
The first end byte spanning the HL7 payload.
The 2nd end byte spanning the HL7 payload.
|(as of Camel 2.14.1) If true, the codec creates a string using the defined charset. If false, the codec sends a plain byte array into the route, so that the HL7 Data Format can determine the actual charset from the HL7 message content.|
|Will convert |
Exposing an HL7 listener using Mina
In the Spring XML file, we configure a mina2 endpoint to listen for HL7 requests using TCP on port
sync=true indicates that this listener is synchronous and therefore will return a HL7 response to the caller. The HL7 codec is setup with codec=#hl7codec. Note that
hl7codec is just a Spring bean ID, so it could be named
mygreatcodecforhl7 or whatever. The codec is also set up in the Spring XML file:
The endpoint hl7MinaLlistener can then be used in a route as a consumer, as this Java DSL example illustrates:
This is a very simple route that will listen for HL7 and route it to a service named patientLookupService. This is also Spring bean ID, configured in the Spring XML as:
The business logic can be implemented in POJO classes that do not depend on Camel, as shown here:
Exposing an HL7 listener using Netty (available from Camel 2.15 onwards)
In the Spring XML file, we configure a netty4 endpoint to listen for HL7 requests using TCP on port
sync=true indicates that this listener is synchronous and therefore will return a HL7 response to the caller. The HL7 codec is setup with encoder=#hl7encoder and decoder=#hl7decoder. Note that
hl7decoder are just bean IDs, so they could be named differently. The beans can be set in the Spring XML file:
The endpoint hl7NettyListener can then be used in a route as a consumer, as this Java DSL example illustrates:
HL7 Model using java.lang.String or byte
The HL7 MLLP codec uses plain String as its data format. Camel uses its Type Converter to convert to/from strings to the HAPI HL7 model objects, but you can use the plain String objects if you prefer, for instance if you wish to parse the data yourself.
As of Camel 2.14.1 you can also let both the Mina and Netty codecs use a plain
byte as its data format by setting the
produceString property to false. The Type Converter is also capable of converting the
byte to/from HAPI HL7 model objects.
HL7v2 Model using HAPI
The HL7v2 model uses Java objects from the HAPI library. Using this library, you can encode and decode from the EDI format (ER7) that is mostly used with HL7v2.
The sample below is a request to lookup a patient with the patient ID
Using the HL7 model you can work with a
ca.uhn.hl7v2.model.Message object, e.g. to retrieve a patient ID:
This is powerful when combined with the HL7 listener, because you don't have to work with
String or any other simple object formats. You can just use the HAPI HL7v2 model objects. If you know the message type in advance, you can be more type-safe:
The HL7 component ships with a HL7 data format that can be used to marshal or unmarshal HL7 model objects.
marshal= from Message to byte stream (can be used when responding using the HL7 MLLP codec)
unmarshal= from byte stream to Message (can be used when receiving streamed data from the HL7 MLLP
To use the data format, simply instantiate an instance and invoke the marshal or unmarshal operation in the route builder:
In the sample above, the HL7 is marshalled from a HAPI Message object to a byte stream and put on a JMS queue.
The next example is the opposite:
Here we unmarshal the byte stream into a HAPI Message object that is passed to our patient lookup service.
As of HAPI 2.0 (used by Camel 2.11), the HL7v2 model classes are fully serializable. So you can put HL7v2 messages directly into a JMS queue (i.e. without calling
marshal() and read them again directly from the queue (i.e. without calling
As of Camel 2.11,
unmarshal does not automatically fix segment separators anymore by converting
\r. If you
need this conversion,
org.apache.camel.component.hl7.HL7#convertLFToCR provides a handy
Expression for this purpose.
As of Camel 2.14.1, both
marshal and unmarshal evaluate the charset provided in the field
MSH-18. If this field is empty, by default the charset contained in the corresponding Camel charset property/header is assumed. You can even change this default behavior by overriding the
guessCharsetName method when inheriting from the
There is a shorthand syntax in Camel for well-known data formats that are commonly used.
Then you don't need to create an instance of the
The unmarshal operation adds these fields from the MSH segment as headers on the Camel message:
(Camel 2.14) contains the HapiContext that
|(Camel 2.14.1) |
All headers except
String types. If a header value is missing, its value is
The HL7 Data Format supports the following options:
Whether the HAPI Parser should validate the message using the default validation rules. It is recommended to use the
|Camel 2.14: Custom HAPI context that can define a custom parser, custom ValidationContext etc. This gives you full control over the HL7 parsing and rendering process.|
To use HL7 in your Camel routes you'll need to add a dependency on camel-hl7 listed above, which implements this data format.
The HAPI library is split into a base library and several structure libraries, one for each HL7v2 message version:
- v2.1 structures library
- v2.2 structures library
- v2.3 structures library
- v2.3.1 structures library
- v2.4 structures library
- v2.5 structures library
- v2.5.1 structures library
- v2.6 structures library
camel-hl7 only references the HAPI base library. Applications are responsible for including structure libraries themselves. For example, if an application works with HL7v2 message versions 2.4 and 2.5 then the following dependencies must be added:
Alternatively, an OSGi bundle containing the base library, all structures libraries and required dependencies (on the bundle classpath) can be downloaded from the central Maven repository.
HAPI provides a Terser class that provides access to fields using a commonly used terse location specification syntax. The Terser language allows to use this syntax to extract values from messages and to use them as expressions and predicates for filtering, content-based routing etc.
HL7 Validation predicate
Often it is preferable to first parse a HL7v2 message and in a separate step validate it against a HAPI ValidationContext.
HL7 Validation predicate using the HapiContext (Camel 2.14)
The HAPI Context is always configured with a ValidationContext (or a ValidationRuleBuilder), so you can access the validation rules indirectly. Furthermore, when unmarshalling the HL7DataFormat forwards the configured HAPI context in the
CamelHL7Context header, and the validation rules of this context can be easily reused:
HL7 Acknowledgement expression
A common task in HL7v2 processing is to generate an acknowledgement message as response to an incoming HL7v2 message, e.g. based on a validation result. The
ack expression lets us accomplish this very elegantly:
In the following example, a plain
String HL7 request is sent to an HL7 listener that sends back a response:
In the next sample, HL7 requests from the HL7 listener are routed to the business logic, which is implemented as plain POJO registered in the registry as
Then the Camel routes using the
RouteBuilder may look as follows:
Note that by using the HL7 DataFormat the Camel message headers are populated with the fields from the MSH segment. The headers are particularly useful for filtering or content-based routing as shown in the example above.