Sun Microsystems Sun Adapter forTCP/IPHL7 Manuale utente

Sun Adapter for TCP/IP HL7

User's Guide

Sun Microsystems, Inc.

4150 Network Circle

Santa Clara, CA 95054

U.S.A.

Part No: 821–0377–10

October 2009

Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without

limitation, these intellectual property rights may include one or more U.S. patents or pending patent applications in the U.S. and in other countries.

U.S. Government Rights – Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions

of the FAR and its supplements.

This distribution may include materials developed by third parties.

Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in the U.S. and other

countries, exclusively licensed through X/Open Company, Ltd.

Sun, Sun Microsystems, the Sun logo, the Solaris logo, the Java Coee Cup logo, docs.sun.com, Java, and Solaris are trademarks or registered trademarks of Sun

Microsystems, Inc. or its subsidiaries in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of

SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.

The OPEN LOOK and SunTM Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges the pioneering eorts

of Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun holds a non-exclusive license from Xerox to

the Xerox Graphical User Interface, which license also covers Sun's licensees who implement OPEN LOOK GUIs and otherwise comply with Sun's written license

agreements.

Products covered by and information contained in this publication are controlled by U.S. Export Control laws and may be subject to the export or import laws in

other countries. Nuclear, missile, chemical or biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export

or reexport to countries subject to U.S. embargo or to entities identied on U.S. export exclusion lists, including, but not limited to, the denied persons and specially

designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY

IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO

THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

091015@23031

Contents

Sun Adapter for TCP/IP HL7 User's Guide .......................................................................................... 7

Sun Adapter for TCP/IP HL7 Overview ..............................................................................................8

About Sun Adapter for TCP/IP HL7 ............................................................................................8

About HL7 .................................................................................................................................... 10

The TCP/IP HL7 Adapter Architecture .................................................................................... 10

Modes and Roles .......................................................................................................................... 12

Inbound Functionality ................................................................................................................ 14

Outbound Functionality ............................................................................................................. 17

General Functionality .................................................................................................................. 20

TCP/IP HL7 Adapter Operation ................................................................................................ 22

Monitoring the HL7 Adapter ...................................................................................................... 24

Schematron Support in the HL7 Adapter ................................................................................. 25

Adding and Conguring a TCP/IP HL7 Adapter in a Connectivity Map .................................... 27

Adding a TCP/IP HL7 External Application to a Connectivity Map .................................... 28

Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map ........................... 29

TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties ................................................. 30

General Inbound Settings – TCP/IP HL7 V2 Inbound Adapter ............................................ 31

TCPIP Inbound Settings — TCP/IP HL7 V2 Inbound Adapter ............................................ 32

TCPIP Inbound Settings - Server Port Binding — TCP/IP HL7 V2 Inbound Adapter ....... 35

TCPIP Inbound Settings - Client Connection Establishment — TCP/IP HL7 V2 Inbound

Adapter .......................................................................................................................................... 35

TCPIP Inbound Settings - Inbound Connection Management — TCP/IP HL7 V2 Inbound

Adapter .......................................................................................................................................... 35

TCPIP Inbound Schedules - Listener Schedule — TCP/IP HL7 V2 Inbound Adapter ....... 36

TCPIP Inbound Schedules - Service Schedule TCP/IP HL7 V2 Inbound Adapter ............. 38

HL7 Acknowledgment — TCP/IP HL7 V2 Inbound Adapter ............................................... 39

Lower Layer Protocol — TCP/IP HL7 V2 Inbound Adapter ................................................. 40

Sequence Number Protocol — TCP/IP HL7 V2 Inbound Adapter ....................................... 41

HL7 MSH Segment — TCP/IP HL7 V2 Inbound Adapter ..................................................... 41

HL7 SFT Segment — TCP/IP HL7 V2 Inbound Adapter ....................................................... 44

Communication Control — TCP/IP HL7 V2 Inbound Adapter ........................................... 45

HL7 Recourse Action — TCP/IP HL7 V2 Inbound Adapter .................................................. 47

TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties .............................................. 49

General Outbound Settings — TCP/IP HL7 V2 Outbound Adapter .................................... 49

TCPIP Outbound Settings — TCP/IP HL7 V2 Outbound Adapter ...................................... 50

TCPIP Outbound Settings - Client Connection Establishment — TCP/IP HL7 V2

Outbound Adapter ...................................................................................................................... 53

TCPIP Outbound Settings - Server Port Binding — TCP/IP HL7 V2 Outbound

Adapter .......................................................................................................................................... 54

HL7 Acknowledgment — TCP/IP HL7 V2 Outbound Adapter ............................................ 55

Lower Layer Protocol — TCP/IP HL7 V2 Outbound Adapter .............................................. 55

Sequence Number Protocol — TCP/IP HL7 V2 Outbound Adapter .................................... 56

HL7 MSH Segment — TCP/IP HL7 V2 Outbound Adapter .................................................. 57

HL7 SFT Segment — TCP/IP HL7 V2 Outbound Adapter .................................................... 59

Communication Control — TCP/IP HL7 V2 Outbound Adapter ........................................ 60

HL7 Recourse Action — TCP/IP HL7 V2 Outbound Adapter .............................................. 62

TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties ................................................. 64

General Inbound Settings — TCP/IP HL7 V3 Inbound Adapter .......................................... 64

TCPIP Inbound Settings — TCP/IP HL7 V3 Inbound Adapter ............................................ 65

TCPIP Inbound Settings - Server Port Binding — TCP/IP HL7 V3 Inbound Adapter ....... 68

TCPIP Inbound Settings - Client Connection Establishment — TCP/IP HL7 V3 Inbound

Adapter .......................................................................................................................................... 69

TCPIP Inbound Settings - Inbound Connection Management — TCP/IP HL7 V3 Inbound

Adapter .......................................................................................................................................... 69

TCPIP Inbound Schedules - Listener Schedule — TCP/IP HL7 V3 Inbound Adapter ....... 70

TCPIP Inbound Schedules - Service Schedule — TCP/IP HL7 V3 Inbound Adapter ........ 71

HL7 Acknowledgment — TCP/IP HL7 V3 Inbound Adapter ............................................... 73

Lower Layer Protocol — TCP/IP HL7 V3 Inbound Adapter ................................................. 73

Sequence Number Protocol — TCP/IP HL7 V3 Inbound Adapter ....................................... 74

HL7v3 Transmission Wrapper — TCP/IP HL7 V3 Inbound Adapter ................................. 74

Communication Control — TCP/IP HL7 V3 Inbound Adapter ........................................... 75

HL7 Recourse Action — TCP/IP HL7 V3 Inbound Adapter .................................................. 77

Schematron Validation — TCP/IP HL7 V3 Inbound Adapter .............................................. 79

TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties .............................................. 79

General Outbound Settings — TCP/IP HL7 V3 Outbound Adapter .................................... 80

TCPIP Outbound Settings — TCP/IP HL7 V3 Outbound Adapter ...................................... 80

Contents

Sun Adapter forTCP/IP HL7 User's Guide • October 20094

TCPIP Outbound Settings - Client Connection Establishment — TCP/IP HL7 V3

Outbound Adapter ...................................................................................................................... 83

TCPIP Outbound Settings - Server Port Binding — TCP/IP HL7 V3 Outbound

Adapter .......................................................................................................................................... 84

HL7 Acknowledgment — TCP/IP HL7 V3 Outbound Adapter ............................................ 85

Lower Layer Protocol — TCP/IP HL7 V3 Outbound Adapter .............................................. 85

Sequence Number Protocol — TCP/IP HL7 V3 Outbound Adapter .................................... 86

HL7v3 Transmission Wrapper — TCP/IP HL7 V3 Outbound Adapter .............................. 86

Communication Control — TCP/IP HL7 V3 Outbound Adapter ........................................ 87

HL7 Recourse Action — TCP/IP HL7 V3 Outbound Adapter .............................................. 89

Conguring Sun Adapter for TCP/IP HL7 Environment Properties ........................................... 91

Conguring TCP/IP HL7 Adapter Environment Properties ................................................. 91

TCP/IP HL7 Inbound Adapter Environment Properties ....................................................... 92

TCP/IP HL7 Inbound Adapter Environment Properties ....................................................... 94

Using the TCP/IP HL7 Predened Templates ................................................................................. 97

Prerequisites for the HL7 V3 Sample Projects .......................................................................... 97

Creating a Copy of an HL7 Sample Project ............................................................................... 98

Customizing Predened Collaborations for HL7 .................................................................. 102

Creating Copies of HL7 Collaborations .................................................................................. 102

Adding an HL7 Message Library to an Existing Collaboration ............................................ 104

About TCP/IP HL7 V2 Collaborations ........................................................................................... 107

TCP/IP HL7 V2 Adapter Projects Overview .......................................................................... 108

TCP/IP HL7 V2 Adapter Collaborations ................................................................................ 108

Inbound HL7 V2 Collaboration Overview ............................................................................. 109

Outbound HL7 V2 Collaboration Overview .......................................................................... 114

About TCP/IP HL7 V3 Collaborations ........................................................................................... 120

About HL7 V3 ............................................................................................................................ 120

TCP/IP HL7 V3 Adapter Projects Overview .......................................................................... 121

TCP/IP HL7 V3 Adapter Collaborations ................................................................................ 121

Inbound HL7 V3 Immediate Collaboration Overview ......................................................... 122

Inbound HL7 V3 Deferred Collaboration Overview ............................................................ 127

Outbound HL7 V3 Collaboration Overview .......................................................................... 133

MLLP V2 and the Sample Projects .................................................................................................. 140

Creating and Conguring the MLLP V2.0 Database ............................................................. 140

MLLP V2 Content Exchange Model ........................................................................................ 144

Standard Inbound HL7 V2 Collaboration Overview over MLLPV2 ................................... 146

Contents

Sun Adapter for TCP/IP HL7 User's Guide

This document provides information and instructions for working with the Sun Adapter for

TCP/IP HL7. It is divided into the topics listed below.

What You Need to Know

These topics provide information that is useful to know before you start working with the

TCP/IP HL7 Adapter:

■“Sun Adapter for TCP/IP HL7 Overview” on page 8

■“About TCP/IP HL7 V2 Collaborations” on page 107

■“About TCP/IP HL7 V3 Collaborations” on page 120

■“MLLP V2 Content Exchange Model” on page 144

■“Standard Inbound HL7 V2 Collaboration Overview over MLLPV2” on page 146

What You Need to Do

These links provide information and instructions for working with the TCP/IP HL7 Adapter in

Java CAPS projects:

■“Adding a TCP/IP HL7 External Application to a Connectivity Map” on page 28

■“Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map” on page 29

■“Conguring TCP/IP HL7 Adapter Environment Properties” on page 91

■“Creating a Copy of an HL7 Sample Project” on page 98

■“Customizing Predened Collaborations for HL7” on page 102

■“Creating Copies of HL7 Collaborations” on page 102

■“Adding an HL7 Message Library to an Existing Collaboration” on page 104

■“Creating and Conguring the MLLP V2.0 Database” on page 140

Additional Information

These links provide additional information that is useful to know when working with the

TCP/IP HL7 Adapter:

■“TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties” on page 30

■“TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties” on page 49

■“TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties” on page 64

■“TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties” on page 79

■“TCP/IP HL7 Inbound Adapter Environment Properties” on page 92

■“TCP/IP HL7 Inbound Adapter Environment Properties” on page 94

Sun Adapter for TCP/IP HL7 Overview

The following topics provide information about HL7 and the TCP/IP HL7 Adapter:

■“About Sun Adapter for TCP/IP HL7” on page 8

■“About HL7” on page 10

■“The TCP/IP HL7 Adapter Architecture” on page 10

■“Modes and Roles” on page 12

■“Inbound Functionality” on page 14

■“Outbound Functionality” on page 17

■“General Functionality” on page 20

■“TCP/IP HL7 Adapter Operation” on page 22

■“Monitoring the HL7 Adapter” on page 24

■“Schematron Support in the HL7 Adapter” on page 25

About Sun Adapter forTCP/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 specic needs.

■A complete set of congurable 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.

Sun Adapter forTCP/IP HL7 Overview

Sun Adapter forTCP/IP HL7 User's Guide • October 20098

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 congurations.

■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 Denition (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 congure the operation of the

TCP/IP HL7 Adapter. The Adapter includes a set of properties that are congured in the

Connectivity Map and only apply to that Adapter in the Project. It also includes a set of

properties that are congured in the Environment and apply to all TCP/IP HL7 Adapters in the

Project. These properties are adopted into the Message Library’s functions.

Sun Adapter forTCP/IP HL7 Overview

Sun Adapter forTCP/IP HL7 User's Guide 9

The Message Library handles all of the lower-layer protocol. The Message Library’s behavior is

customized using the Adapter conguration properties. These Adapter properties are used by

the resource adapter, but are also accessed and used by the prebuilt Collaborations.

About HL7

HL7 is a standard for exchanging information between medical applications and is an

abbreviation of Health Level Seven. Level Seven refers to the seventh OSI layer protocol for the

health environment. HL7 denes the format and the content of the messages that applications

must use when exchanging data with each other under various circumstances.

Hospitals and other medical institutions typically use many dierent types of systems to

communicate with one another. Everything, from patient records to billing information, is

tracked and recorded in computer systems. In order for these dierent types of systems to

communicate with each other, they use a standard like HL7.

Note – In the computer world, a protocol is a formal, well-dened standard for exchanging

information between computer applications.

An important part of the HL7 standard is the ACKnowledgment protocol, also known as an

ACK. Every time an application accepts a message and consumes the data, it is expected to send

an ACKnowledgment message back to the sending application. The sending application is

expected to keep on sending a message until it has received an ACK message.

TheTCP/IP HL7 Adapter Architecture

The TCP/IP HL7 Adapter's functionality comes from a combination of the TCP/IP HL7

Resource Adapter (RA), the predened inbound and outbound HL7 Collaborations, and the

generic HL7 Message Libraries.

TCP/IP HL7 Resource Adapter

The TCP/IP HL7 Resource Adapter communicates with external HL7 systems, establishes and

maintains the TCP/IP socket, manages message enveloping, maintains the sequence numbering

le, and provides the HL7 protocol state to the Collaboration. The RA (Resource Adapter) is

congured from the Adapter Properties Editor.

HL7 Collaborations

The inbound and outbound HL7 Collaborations provide message validation, sequence

numbering, ACK and NAK generation, and recourse actions. The predened HL7

Collaborations are designed to implement the HL7 standard protocol and inter-operate with

similar standard compliant systems by simply changing the Adapter property conguration.

Sun Adapter forTCP/IP HL7 Overview

Sun Adapter forTCP/IP HL7 User's Guide • October 200910

Indice

Altri manuali Sun Microsystems Hardware per computer

Sun Microsystems

Sun Microsystems Ultra Enterprise Caster Base Manuale utente

Sun Microsystems

Sun Microsystems Rack Manuale utente

Sun Microsystems

Sun Microsystems 2060 Manuale di installazione e funzionamento

Sun Microsystems

Sun Microsystems Enterprise 3500 Manuale utente

Sun Microsystems

Sun Microsystems Sun Fire B1600 Administration Manuale di istruzioni

Sun Microsystems

Sun Microsystems Dual Come usare

Sun Microsystems

Sun Microsystems StorEdge 3000 Series Manuale utente

Sun Microsystems

Sun Microsystems Enterprise 3500 Manuale utente

Sun Microsystems

Sun Microsystems Sun Blade T6320 Manuale utente

Sun Microsystems

Sun Microsystems Netra t1 Series Manuale utente

Sun Microsystems

Sun Microsystems 3400 Foglio di istruzioni

Sun Microsystems

Sun Microsystems Sun Fire E25K Manuale utente

Sun Microsystems

Sun Microsystems StorageTek 5220 NAS Appliance Manuale utente

Sun Microsystems

Sun Microsystems UltraSPARC III Cu Module Manuale utente

Sun Microsystems

Sun Microsystems XVR-1200 Manuale utente

Sun Microsystems

Sun Microsystems Sun Fire Cabinet Manuale di installazione e funzionamento

Sun Microsystems

Sun Microsystems Fire 6800 Manuale utente

Sun Microsystems

Sun Microsystems Netra ft 1800 Guida rapida per l'utente

Sun Microsystems

Sun Microsystems Sun Enterprise 10000 Manuale

Sun Microsystems

Sun Microsystems SPARCcenter 2000 Manuale utente

Sun Microsystems

Sun Microsystems TurboGX Manuale utente

Sun Microsystems

Sun Microsystems SunPCi II 2.3 Manuale utente

Sun Microsystems

Sun Microsystems Enterprise 00 Series Manuale utente

Sun Microsystems

Sun Microsystems StorEdge L1000 Manuale utente

Manuali Hardware per computer popolari di altre marche

EMC2

EMC2 VNX Series Manuale del proprietario

Panasonic

Panasonic DV0PM20105 Manuale utente

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 Manuale utente

Gigabyte

Gigabyte B660M DS3H AX DDR4 Manuale utente

Raidon

Raidon iT2300 Manuale utente

National Instruments

National Instruments PXI-8186 Manuale utente

Hauppauge

Hauppauge WinTV-HVR-2250 Manuale utente

Kontron

Kontron CP6002 Manuale utente

Manhattan

Manhattan 702843 Manuale utente

Aphex

Aphex 230 Manuale utente

AMD

AMD Phenom II Manuale operativo

Intel

Intel NUC 12 Pro Manuale utente

dbx

dbx Zone Pro 1260 Manuale utente

Galaxy

Galaxy GHDX2-2430S-24F4D Manuale utente

Intel

Intel AXXRMFBU4 Manuale utente

Kontron

Kontron DIMM-PC/MD Manuale utente

ST X-NUCLEO-SAFEA1B Istruzioni operative

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 Manuale utente