About Sun Adapter for TCP/IP HL7 (Sun Adapter for TCP/IP HL7 User's Guide)

Sun Adapter for TCP/IP HL7 User's Guide

About Sun Adapter for TCP/IP HL7

The Sun Adapter for TCP/IP HL7 is a component of the Sun Java Composite Application Suite (Java CAPS) that enables the 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 you can use as is or that you can modify for your specific needs.
A complete set of configurable properties that allow you to customize the functionality of the Adapter. The functions can further be customized by 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, 2.5, 2.5.1, 2.6 and V3.

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:

Bidirectional processing, 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 and error logging.
Journaling of HL7 messages and associated acknowledgements.
HL7 acknowledgement levels.
Fully supports the HL7 sequence numbering protocol.
Full support for HL7 ACK and 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 Message Libraries that provide the structures necessary to parse and create the data messages and ACKs used by the protocol.

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

The TCP/IP HL7 Adapter properties allow the user to easily configure the operation of the TCP/IP HL7 Adapter. The Adapter includes a set of properties that are configured in the Connectivity Map and only apply to that Adapter in the Project. It also includes a set of properties that are configured in the Environment and apply to all TCP/IP HL7 Adapters in the Project. These properties are adopted into the Message Library’s functions.

The Message Library handles all of the lower-layer protocol. The Message Library’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.