The cxf: component provides integration with Apache CXF for connecting to JAX-WS services hosted in CXF.

+/*]]>*/

URI format

Options

The descriptions of the dataformats @@ -4854,7 +4854,7 @@ hibernate:[entityClassName][?options]

HL7 Component

The HL7 component is used for working with the HL7 MLLP protocol and HL7 v2 messages using the HAPI library.

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
Even more ease-of-use as it's integrated well with the camel-mina2 comp onent.

Maven users will need to add the following dependency to their pom.xml for this component:

HL7 Component

The HL7 component is used for working with the HL7 MLLP protocol and HL7 v2 messages using the HAPI library.

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
Even more ease-of-use as it's integrated well with the camel-mina2 component.

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 HL7MLLPConfig (Netty4) as codec.

The HL7 MLLP codec has the following options:

Name	Default Value	Description
`startByte`	`0x0b`	The start byte spanning the HL7 payload.
`endByte1`	`0x1c`	The first end byte spanning the HL7 payload.
`endByte2`	`0x0d`	The 2nd end byte spanning the HL7 payload.
`charset`	JVM Default	The encoding (a charset name) to use for the codec. If not provided, Camel will use the JVM default Charset.
`produceString`	`true`	(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.
`convertLFtoCR`	`false`	Will convert `\n` to `\r` (`0x0d`, 13 decimal) as HL7 stipulates `\r` as segment terminators. The HAPI library requires the use of `\r`.

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 8888:

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 hl7listener 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:

Exposing an HL7 listener using Netty (available as of Camel 2.15)

In the Spring XML file, we configure a netty4 endpoint to listen for HL7 requests using TCP on port 8888:

+
+

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 hl7encoder and hl7decoder are just bean IDs, so it could be named differently. The beans can be set in the Spring XML file:

+
+

The endpoint hl7listener 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 the codec use a plain byte[] as its data format. 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 0101701234.< /p>

HL7 MLLP protocol

The HL7 MLLP codec has the following options:

Name	Default Value	Description
`startByte`	`0x0b`	The start byte spanning the HL7 payload.
`endByte1`	`0x1c`	The first end byte spanning the HL7 payload.
`endByte2`	`0x0d`	The 2nd end byte spanning the HL7 payload.
`charset`	JVM Default	The encoding (a charset name) to use for the codec. If not provided, Camel will use the JVM default Charset.
`produceString`	`true`	(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.
`convertLFtoCR`	`false`	Will convert `\n` to `\r` (`0x0d`, 13 decimal) as HL7 stipulates `\r` as segment terminators. The HAPI library requires the use of `\r`.

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 8888:

The endpoint hl7listener 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:

Exposing an HL7 listener using Netty (available as of Camel 2.15)

In the Spring XML file, we configure a netty4 endpoint to listen for HL7 requests using TCP on port 8888:

+
+

+
+

The endpoint hl7listener can then be used in a route as a consumer, as this Java DSL example illustrates:

HL7 Model using java.lang.String or byte[]

As of Camel 2.14.1 you can also let the codec use a plain byte[] as its data format. 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 0101701234.

HL7 MLLP protocol

The HL7 MLLP codec has the following options:

Name	Default Value	Description
`startByte`	`0x0b`	The start byte spanning the HL7 payload.
`endByte1`	`0x1c`	The first end byte spanning the HL7 payload.
`endByte2`	`0x0d`	The 2nd end byte spanning the HL7 payload.
`charset`	JVM Default	The encoding (a charset name) to use for the codec. If not provided, Camel will use the JVM default Charset.
`produceString`	`true`	(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.
`convertLFtoCR`	`false`	Will convert `\n` to `\r` (`0x0d`, 13 decimal) as HL7 stipulates `\r` as segment terminators. The HAPI library requires the use of `\r`.

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 8888:

The endpoint hl7listener 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:

Exposing an HL7 listener using Netty (available as of Camel 2.15)

In the Spring XML file, we configure a netty4 endpoint to listen for HL7 requests using TCP on port 8888:

+
+

+
+

The endpoint hl7listener can then be used in a route as a consumer, as this Java DSL example illustrates:

HL7 Model using java.lang.String or byte[]

As of Camel 2.14.1 you can also let the codec use a plain byte[] as its data format. 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 0101701234.

See Also

HL7 Component

HL7 Component

HL7 MLLP protocol

Exposing an HL7 listener using Mina

Exposing an HL7 listener using Netty (available as of Camel 2.15)

HL7 Model using java.lang.String or byte[]

HL7v2 Model using HAPI

HL7 MLLP protocol

Exposing an HL7 listener using Mina

Exposing an HL7 listener using Netty (available as of Camel 2.15)

HL7 Model using java.lang.String or byte[]

HL7v2 Model using HAPI

HL7 MLLP protocol

Exposing an HL7 listener using Mina

Exposing an HL7 listener using Netty (available as of Camel 2.15)

HL7 Model using java.lang.String or byte[]

HL7v2 Model using HAPI