Sun Adapter for TCP/IP HL7 User's Guide

Outbound Adapter Data Flow

In outbound mode, the Adapter receives HL7 messages from a JMS queue. Each message is verified to ensure it contains HL7 data only. Legitimate HL7 data is enveloped into its configured format and sent to the external system.

A message in the JMS queue triggers the outbound Collaboration. The outbound Collaboration is provided with an HL7 message to send to the external system

The Adapter waits for a configurable number of milliseconds for an incoming HL7 ACK or NAK from the external system. After receiving an HL7 response from the external system, the Adapter strips the message from its envelope and verifies its integrity.

Any non-HL7 acknowledgment received from the external system causes the Adapter to resend the same message. If the incoming response is an HL7 ACK or NAK, the Adapter might do either of the following, as dictated by its configuration:

If journaling is set, these messages and their ACKs are placed in the journal file.

Outbound Standard Messaging Mode

    The following steps describe the process for the Outbound Standard Message Mode:

  1. An HL7 message triggers the Collaboration. The outbound Collaboration is designed to accept the HL7 messages.

  2. The Collaboration maps the received message into the Generic Event Message Library and validates the MSH segment. If validation is enabled, the Collaboration checks the MSH segment of the outbound messages against MSH values configured in the Adapter properties file. If the validation fails or the message cannot be parsed, the message and its error are written to the error queue. Note that the HL7 message is always checked for structural correctness.

  3. The Collaboration sends the message to the RA.

  4. The RA envelopes the message and sends it to the External System and waits for an ACK.

  5. The Collaboration receives and validates the ACK, and then journals the ACK and the HL7 message (if journaling is enabled). If the Collaboration receives a NAK, the NAK and the HL7 message are sent to the error queue.

  6. Finally, the Collaboration commits the JMS receive.