About Sun Adapter for TCP/IP HL7

The Sun Adapter for TCP/IP HL7 enables the Sun Java CAPS ESB system to exchange data with an external TCP/IP application, using the HL7 data protocol. The Sun Java CAPS ESB with the TCP/IP HL7 Adapter provides:

• Macro functionality, providing ease of use and productivity.

• Prebuilt Standards-compliant Inbound and Outbound Template Collaborations that work “as is” or can be modified for your specific needs.

• Customization of functionality, by configuring the Adapter properties and/or modifying the Collaborations.

• Journaling and error messaging to JMS queues and topics. This is in addition to Sun Java CAPS ESB’s standard alert and debug logging.

• Support for HL7 Standard versions 2.1, 2.2, 2.3, 2.3.1, 2.4, and 2.5.

  ---

  Note –

  Throughout this document the term “JMS queue” is used in the generic sense and actually denotes JMS queues or topics.

  ---

TCP/IP HL7 Features

The TCP/IP HL7 Adapter includes the following features:

• Bi-directional, including Client or Server mode in either direction (to or from Sun Java CAPS ESB).

• Handles both HL7 HLLP and MLLP protocols and envelopes.

• Provides a wide variety of recourse action configurations.

• Non-blocking I/O.

• Recovery and retry logic.

• Debug levels.

• Error logging.

• Journaling of HL7 messages and associated ACKs

• HL7 Acknowledgement levels

• Fully supports the HL7 sequence numbering protocol.

• Full support for HL7 ACK, NAK generation and validation.

• Supports Delayed ACK in both directions.

TCP/IP HL7 Adapter Components

The TCP/IP HL7 Adapter incorporates three components:

• The HL7 TCP/IP Resource Adapter that implements the lower layer HL7 protocol over TCP/IP.

• Default inbound and outbound Collaborations that implement the HL7 messaging protocol, sequence numbering and recourse actions.

• Generic HL7 OTDs that provide the structures necessary to parse and create the data messages and ACKs used by the protocol.

The TCP/IP HL7 Object Type Definition (OTD) enables the creation of HL7 interfaces capable of running over TCP/IP, and also utilizes the common Adapter services available in Sun Java CAPS ESB. The TCP/IP HL7 Adapter works hand in hand with the Sun Java CAPS HL7 OTD Libraries, versions 2.1 through 2.5.

The TCP/IP HL7 Adapter properties allow the user to easily configure the operation of the TCP/IP HL7 Adapter. These properties are adopted into the OTD’s functions.

The OTD handles all of the lower-layer protocol. The OTD’s behavior is customized using the Adapter configuration properties. These Adapter properties are used by the resource adapter, but are also accessed and used by the prebuilt Collaborations.