Healthcare: HL7 to HL7 pattern

The Healthcare: HL7 to HL7 pattern integrates an application that can send Health Level Seven International (HL7) v2 messages with one or more applications that can receive HL7 messages. The applications must be capable of sending and receiving HL7 messages by using Minimal Lower Layer Protocol (MLLP) over TCP/IP.

Note: The Healthcare: HL7 to HL7 pattern was made available in IBM WebSphere Message Broker Connectivity Pack for Healthcare version 7 and is still available and supported in IBM WebSphere Message Broker Connectivity Pack for Healthcare version 8. However, it is recommended that you use the Healthcare: HL7 to HL7 DFDL pattern instead if possible. The Healthcare: HL7 to HL7 DFDL pattern uses the DFDL message model instead of MRM and the HL7v25P message set. The DFDL message model has the following benefits:

DFDL is an open-standard format whereas MRM and the HL7v25P message set are proprietary to IBM Integration Bus
The DFDL editor provides simpler tools for developing and testing extensions to the HL7 schema, compared to MRM and the HL7v25P message set
The DFDL message model supports HL7 versions 2.7, 2.6, 2.5.1 and earlier whereas MRM and the HL7v25P message set only support HL7 version 2.5.1 and earlier

Important!

You must deploy the HL7 message set to your integration node before deploying a pattern instance. The message set is used to parse HL7 messages as they are processed by the message flows. Message flows generated by the pattern cannot be deployed to your integration node until the message set has been deployed.

You can import the HL7 message set into your workspace from the Resources for the pattern page.

The HL7 message set takes a long time to build and can significantly slow down your workspace - you are therefore recommended to do the following:

Import the HL7 message set into your workspace
Add the HL7 message set to a broker archive (BAR) file
Deploy the BAR file to your integration node
Delete the HL7 message set and BAR file from your workspace

If you want to use the Graphical Mapper for message transformations, you will need to leave the HL7 message set in your workspace. You can reduce the time it takes to build the message set by deleting the HL7 chapters from the message set. Leave the segments.mxsd , fields.mxsd and datatypes.mxsd message definition files in the message set as they are required by the pattern.

Options

The Receiver flow in the Healthcare: HL7 to HL7 pattern supports the following options:

Receiving HL7 messages by using MLLP over TCP/IP
Validating and parsing of messages
Auditing incoming messages
Checking and processing of duplicate messages
Supporting sequencing options
Publishing or sending to a queue, each incoming message for processing outside the pattern
Sending output to a transform and route queue
Handling exceptions

The TransformAndRoute flow in the Healthcare: HL7 to HL7 pattern supports the following options:

Transforming to canonical XML format
Publishing or sending to a queue, the canonical incoming message for processing outside the pattern
Reporting on additional fields found in HL7 segments
Distributing messages to multiple, separately configurable, destinations
Filtering the messages to send to each destination
Filtering the segments to include for each destination
Customizing points to enable the inclusion of non-standard, destination-specific changes
Transforming back to HL7 and sending the output to the queue for the sender flow for each destination
Handling exceptions

Each Sender flow in the Healthcare: HL7 to HL7 pattern supports the following options:

Reading transformed messages for this destination
Validating transformed messages
Ensuring that messages are delivered in sequence according to the sequencing options
Notifying when messages arrive out of sequence
Delivering HL7 messages to the destination application by using MLLP over TCP/IP
Handling exceptions

Further information

Design of the pattern

Managing a pattern instance

Monitoring the pattern

Pattern parameters

Resources for the pattern

Running the pattern

Testing the pattern