Sun-microsystems Sun Adapter IP HL 7 Manuel d'utilisateur Page 1

Sun Adapter for TCP/IP HL7User's GuideSun Microsystems, Inc.4150 Network CircleSanta Clara, CA 95054U.S.A.Part No: 821–0377–10October 2009

The Message Library handles all of the lower-layer protocol. The Message Library’s behavior iscustomized using the Adapter conguration properties. Th

Tip – Click the left-arrow button , if you want to move the selected projects from the rightpane to the left pane.d. Click Browse and select an approp

Note – The NetBeans IDE will not import identically named Projects to the same root, so youmust perform this step before importing the Project back in

d. Click Import.It may take a few seconds to import the project. When the project is imported, the ImportStatus dialog box appears.e. Click OK on the

Repeat this step for additional copies of the Collaboration.To add each new Collaboration to a Project's Connectivity Map, drag and drop the Coll

Adding an HL7 Message Library to an ExistingCollaborationIn some cases, a specic HL7 message or messages might need to be added to the Collaboration.

Click Add to select the object type denition.A dialog box appears where you can select the Message Library to add.FIGURE 6 Collaboration Denition (J

In the Look In eld, navigate to the location of the Message Library.The HL7 Message Libraries are located in CAPS Components Library > Message Lib

Tip – You can also modify an existing HL7 V2 Message Library by clicking the Message Libraryto change, clicking the ellipsis that appears, and selecti

The following topics provide information about the sample V2 Collaborations and provideinstructions for copying and customizing them: “TCP/IP HL7 V2 A

At the end of each action, the state is set for the next execution of the Collaboration. There arethree main states: To Establish: A new or reset conn

If a system does not conform to the HL7 specication, the Collaborations can be modied forthat transaction by changing the Java code using the Collab

otdHL7_GENERIC_EVT_1,com.stc.SeeBeyond.OTD_Library.HL7.Generic.HL7_ACK.AC KotdHL7_ACK_1,com.stc.connectors.jms.JMS otdJMS_JOURNAL,com.stc.connectors.j

Collaboration gets triggered by a HL7 message received from a HL7 Client/Outbound/External; it then calls HL7 User Collaboration Rule by executing the

Inbound HL7 V2 Collaboration - Part 2The Collaboration receives the HL7 V2 message from the external usingreceiveHL7message(). If an exception occurs

Handle MaxFailed ReadRetry/TakeRecourseActionarchiveErrorMessage()Handle Max NAK Sent condition/TakeRecourse ActionjournalHL7Message()Handle NoRespons

Inbound HL7 V2 Collaboration - Part 3After the ACK is sent, the HL7 V2 message and the ACK are journaled to the JMS queue Journaldestination. If the m

The following topics describe the business logic dened in the jcdHL7Outbound Collaboration: “Outbound HL7 V2 Collaboration - Part 1” on page 115 “Out

Collaboration gets triggered by a JMS HL7 message; it then calls HL7 User Collaboration Rule byexecuting the receive() methodOnly ifSequenceNumberingi

Outbound HL7 V2 Collaboration - Part 2The Collaboration receives the HL7 ACK or NAK from the external system usingreceiveHL7AckNak(). If an exception

Can result inarchiving theHL7 message/withNAK inERROR QueueCalls other helper methods such ascheckSendingReceivingApplication and checkSendingReceivin

Outbound HL7 V2 Collaboration - Part 3If the ACK message passes validation, the HL7 V2 message and ACK message are sent to theJMS journal destination.

MonitoringThe Enterprise Manager provides a real-time picture of the Adapter's state and status. Themonitoring facilities display the following

About TCP/IP HL7 V3 CollaborationsThe following topics provide a brief overview of HL7 V3, and describe the HL7 V3Collaborations and provide instructi

The V3 standard also includes interactions, such as Create Patient Billing Account.There are three modes of Acknowledgement process in HL7 V3: Immedia

1. Inbound HL7 V3 Immediate Collaboration2. Inbound HL7 V3 Deferred Collaboration3. Inbound HL7 V3 Queue Manager4. Inbound HL7 V3 Message PublisherInb

Note – The above text has been wrapped to t the page.About TCP/IP HL7 V3 CollaborationsSun Adapter for TCP/IP HL7 User's Guide 123

Once the message is received, the Collaboration determines whether the message needs to bevalidated. The HL7 V3 message is then validated, making sure

Version Code, Processing Code, Processing Mode Code, and Interaction ID. If these elds donot match the conguration, a NAK is returned.The Collaborat

validateHL7Message()Validates V3 message and determines if it should send ACK/NAKHL7 V3 Message passedValidation?sendHL7ACK() Sends HL7 V3(MCCI_IN0000

Inbound HL7 V3 Deferred Collaboration OverviewThe Inbound HL7 V3 Collaboration, jcdHL7V3DeferredInbound, contains Message Librariesfor the HL7 V3 Reso

otdHL7_ACK_1,com.stc.connectors.jms.JMS otdJMS_JOURNAL,com.stc.connectors.jms.JMS otdJMS_ERROR) throws Throwable.Note – The above text is wrapped to 

Receive is the entry point to the HL7 user collaboration, it has the following signature.receive(HL7eway, otd_PRPA_IN403001UV01, otd_MCCI_IN000006UV01

HL7 Adapter Sender RoleThe outbound Collaboration is the implementation of the Sender and the RA is congured foran outbound data ow. A Java CAPS Ser

HL7 V3 Standard Inbound Message Mode Data Flow (For DeferredMode of ACK Process) — Part 2The Collaboration receives the HL7 V3 message from the extern

receiveAndSend()Gets the HL7 v3 message from the external , validates it and sends ACK/NAKreceiveHL7Message()receives the HL7 v3 message from the exte

HL7 V3 Standard Inbound Message Mode Data Flow (For DeferredMode of ACK Process) — Part 3After the Commit ACK is sent and the Application ACK is store

Outbound HL7 V3 Collaboration OverviewThe Outbound HL7 V3 Collaboration, jcdHL7V3Outbound, contains Message Libraries for theHL7 V3 Resource Adapter,

corresponding HL7 V3 Acknowledgements. MCCI_IN000004UV01 for Immediate Mode andMCCI_IN000006UV01 for Deferred Mode. The Collaboration works with its o

Receive is the entry point to the HL7 user collaboration, it has the following signature. receive(JMSMessage,HL7eway, otd_PRPA_IN403001UV01, otd_MCCI_

HL7 V3 Standard Outbound Message Mode Data Flow (For Immediateand Deferred Mode of ACK Process) — Part 2In processMessage(), the message moves on to i

Exception OccurredException due to incomplete dataInsertSequenceNumber()insert the next sequence number in the hl7 v3 messagesendHL7Message()send the

HL7 V3 Standard Outbound Message Mode Data Flow (For Immediateand Deferred Mode of ACK Process) — Part 3If the message does not pass validation it is

HL7 V3 Outbound Test CollaborationFor information, see “HL7 V2 Outbound Test Collaboration” on page 119.Ack Message passed validation?journalMessage()

2. The Receiver sends the message to the Forwarder.3. The Forwarder sends the message to the receiving External System.4. The receiving External Syste

MLLP V2 and the Sample ProjectsMinimal Lower Layer Protocol Release 2 (MLLP V2.0) is a message transport protocol, and isrequired for all message tran

d. Click OK.The database appears in the list of databases on the Services window.Make sure your database instance is running.For Oracle, DB2, SQL Serv

Note – A broken icon represents that the database is not connected.▼To Run the MLLP V2.0 Database ScriptsYou can either run the MLLP database scripts

This opens the SQL Editor window along with the SQL Statement.CREATE TABLE HL7MESSAGELOG (MESSAGEID VARCHAR(250), APPLICATIONID VARCHAR(250) ,REQUESTM

To view the new tables, return to the Services window, right-click the database connection, andthen click Refresh. Expand the database connection and

acknowledgement message. The MLLP V2 acknowledgement protocol is synchronous: thesource system will not send new HL7 content until an acknowledgement

In outbound mode, the message is sent to the sender and waits for the commitacknowledgement or negative acknowledgement from the receiver. If the adap

Is Sequence Numbering Enabled? receive(--)receive HL7 message, validate it and send HL7 ACK / NAK messageYESContinueprocessInitialHandshakeSen

HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 —Part 2The Collaboration receives the HL7 V2 message from the external usingreceiveHL7messa

HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 —Part 3If no exception occurs, validateHL7Message() is called, which validates the message

Standard Inbound Message Mode Data Flow and ArchitectureThe following steps describe the ow of data for an inbound Adapter:1. The external system sen

ContinuedjournalHL7Message()archiveErrorMessage()Handle max Nak sent Condition/Take recourse actionExit Recourse action if failed to journalHL7 Messa

Message VericationMessage verication begins with reading the message from the external system. The message isexpected to match the MLLP envelope, si

No response is received after a message is sent the maximum number of times.Outbound FunctionalityThe outbound TCP/IP HL7 Adapter Project, prjHL7Outb

5. The Collaboration receives and validates the ACK, and then journals the ACK and the HL7message (if journaling is enabled). If the Collaboration rec

Note – For Delayed ACK, the Receiver and Forwarder must be on the same integrationserver.Message VericationThe only verication that the outbound Ada

Copyright 2009 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. All rights reserved.Sun Microsystems, Inc. has intellectual pr

Note – The TCP/IP HL7 Adapter includes internal counters that keep track of all errorconditions.General FunctionalityThis section explains the Adapter

The minimum HL7 sequence number is 1. The maximum HL7 sequence number is 2 billion. Asequence number of “0“ is used to start a session. If the sequenc

The argument error message is the user-congured alert message. The argument HL7 is thesource component (this must be “HL7”).Note – The alerter.fatal(

Lower Layer ProtocolThis section describes the two supported envelope types used in the HL7 protocol: HLLP (Hybrid Lower Layer Protocol) MLLP (Minimal

It is expected that, when enabled, the journal queue has one or more subscribers that process thecontents of the queue so that it remains manageable.

<web-app>...<!-- Default monitoring period used in monitoring theexternal system connection --><context-param><param-name>m

In the HL7 Adapter, this schematron is useful for validating an HL7 V3 document againstpredened schematron schemas that you write. You can also obtai

Using the Schematron APIPerform the following to invoke the schematron API from a Java Collaboration: Obtaining the Factory Object Obtaining the Valid

You can congure the TCP/IP HL7 Adapter properties in the following locations: Connectivity Map: These properties most commonly apply to a specic com

Modify the Adapter properties, as described in “Modifying the TCP/IP HL7 Adapter Properties inthe Connectivity Map”on page 29.Modifying the TCP/IP HL7

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

▼Modifying Adapter Properties in the Connectivity MapFrom the Connectivity Map, double-click the Adapter icon located in the link between theTCP/IP HL

“HL7 Acknowledgment — TCP/IP HL7 V2 Inbound Adapter” on page 39 “Lower Layer Protocol — TCP/IP HL7 V2 Inbound Adapter” on page 40 “Sequence Number Pr

TCPIP Inbound Settings — TCP/IP HL7 V2 InboundAdapterThe following table lists and describes the properties on the TCPIP Inbound Settings page of theP

TABLE 3 Connectivity Map - TCPIP Inbound Settings (Continued)Name DescriptionKeep Alive An indicator of whether the client’s SO_KEEPALIVE option is en

TABLE 3 Connectivity Map - TCPIP Inbound Settings (Continued)Name DescriptionSoLinger An indicator of whether the adapter performs a “linger-on-close”

TCPIP Inbound Settings - Server Port Binding —TCP/IP HL7 V2 Inbound AdapterThe following table lists and describes the properties that appear on the S

TABLE 6 Connectivity Map - TCPIP Inbound Settings - Inbound Connection ManagementName DescriptionMax Connection PoolSizeThe maximum number of concurre

Timer Service – Available for Java EE, this scheduler is congured using the At Fixed Rate,Delay, and Period properties. Work Manager – Available for

TCPIP Inbound Schedules - Service Schedule TCP/IPHL7 V2 Inbound AdapterThe following table lists and describes the properties that appear on the Servi

TABLE 8 Connectivity Map - TCPIP Inbound Schedules - Service Schedule (Continued)Name DescriptionAt Fixed Rate An indicator of whether a xed-rate exe

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

TABLE 9 Connectivity Map - HL7 Acknowledgment (Continued)Name DescriptioneGate Sends App Acks An indicator of whether the HL7 application acknowledgme

TABLE 10 Connectivity Map - Lower Layer Protocol (Continued)Name DescriptionEnd Data Character The second to the last envelope marker character in the

TABLE 12 Connectivity Map - HL7 MSH SegmentName DescriptionField Separator The character that separates the segment ID and the rst real eld. This va

TABLE 12 Connectivity Map - HL7 MSH Segment (Continued)Name DescriptionProcessing ID The subcomponent processing ID of the MSH-11 eld. MSH-11 is used

TABLE 12 Connectivity Map - HL7 MSH Segment (Continued)Name DescriptionValidate MSH An indicator of whether to validate the MSH segment of the data me

TABLE 13 Connectivity Map - HL7 SFT Segment (Continued)Name DescriptionSoftware CertiedVersion or ReleaseNumberThe latest software version number or

TABLE 14 Connectivity Map - Communication ControlName DescriptionTime To Wait For AResponseThe amount of time (in milliseconds) that the adapter waits

HL7 Recourse Action — TCP/IP HL7 V2 InboundAdapterThe following table lists and describes the properties that appear on the HL7 Recourse Actionpage of

TABLE 15 Connectivity Map - HL7 Recourse Action (Continued)Name DescriptionAction on Nak Received The action the adapter takes when it receives an HL7

TCP/IP HL7 V2 Adapter Outbound Connectivity MapPropertiesThe TCP/IP HL7 V2 server outbound adapter conguration properties are organized into thefollo

TCPIP Outbound Settings - Client Connection Establishment — TCP/IP HL7 V3Outbound Adapter ...

TCPIP Outbound Settings — TCP/IP HL7 V2 OutboundAdapterThe following table lists and describes the properties on the TCPIP Outbound Settings page ofth

TABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued)Name DescriptionKeep Alive An indicator of whether the client’s SO_KEEPALIVE option is

TABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued)Name DescriptionSoLinger An indicator of whether the adapter performs a “linger-on-clos

TABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued)Name DescriptionSocket FactoryImplementation ClassNameThe name of the Java class that i

TABLE 18 Connectivity Map - TCPIP Outbound Settings - Client Connection Establishment(Continued)Name DescriptionAuto Reconnect UponMatching FailureAn

HL7 Acknowledgment — TCP/IP HL7 V2 OutboundAdapterThe following table lists and describes the properties that appear on the HL7 Acknowledgmentpage of

TABLE 21 Connectivity Map - Lower Layer ProtocolName DescriptionLLP Type MLLP is the congured default value.The lower layer protocol (LLP) type. Sele

HL7 MSH Segment — TCP/IP HL7 V2 OutboundAdapterThe following table lists and describes the properties that appear on the HL7 MSH Segmentpage of the Pr

TABLE 23 Connectivity Map - HL7 MSH Segment (Continued)Name DescriptionReceiving Facility A user-dened value that further identies the receiving app

TABLE 23 Connectivity Map - HL7 MSH Segment (Continued)Name DescriptionConformance StatementIDA unique identier that applies to a query’s conformance

6

TABLE 24 Connectivity Map - HL7 SFT Segment (Continued)Name DescriptionSoftware CertiedVersion or ReleaseNumberThe latest software version number or

TABLE 25 Connectivity Map - Communication ControlName DescriptionTime To Wait For AResponseThe amount of time (in milliseconds) that the adapter waits

HL7 Recourse Action — TCP/IP HL7 V2 OutboundAdapterThe following table lists and describes the properties that appear on the HL7 Recourse Actionpage o

TABLE 26 Connectivity Map - HL7 Recourse Action (Continued)Name DescriptionAction on Nak Received The action the adapter takes when it receives an HL7

TCP/IP HL7 V3 Adapter Inbound Connectivity Map PropertiesThe TCP/IP HL7 V3 Server inbound adapter conguration properties are organized into thefollow

TABLE 27 Connectivity Map - General Inbound Settings (V3) (Continued)Name DescriptionScope Of State The scope of the state object, which is a Message

TABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued)Name DescriptionServerSO Timeout The value (in milliseconds) of the SO_TIMEOUT para

TABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued)Name DescriptionReceive Buer Size A number indicating the receive buer size. This

TABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued)Name DescriptionSoTimeout The value of the SoTimeout in milliseconds. This is used

TCPIP Inbound Settings - Client ConnectionEstablishment — TCP/IP HL7 V3 Inbound AdapterThe following table lists and describes the property that appea

Sun Adapter forTCP/IP HL7 User's GuideThis document provides information and instructions for working with the Sun Adapter forTCP/IP HL7. It is d

TABLE 31 Connectivity Map - TCPIP Inbound Settings (V3) - Inbound Connection Management(Continued)Name DescriptionScope Of Connection The scope of the

TABLE 32 Connectivity Map - TCPIP Inbound Schedules (V3) - Listener ScheduleName DescriptionScheduler The scheduler type for this inbound communicatio

scheduler used by the TCP/IP server that executes the business tasks (Collaboration rules) overthe existing connection. This scheduler aects the actu

TABLE 33 Connectivity Map - TCPIP Inbound Schedules (V3) - Service Schedule (Continued)Name DescriptionAt Fixed Rate An indicator of whether a xed-ra

TABLE 35 Connectivity Map - Lower Layer Protocol (V3)Name DescriptionLLP Type The lower layer protocol (LLP) type. The supported option is MLLP v2.0(M

needs to package and route the message to the specied receiving applications or messagehandling services. The transmission wrapper is a cluster of cl

TABLE 38 Connectivity Map - Communication Control (V3)Name DescriptionTime To Wait For AResponseThe amount of time (in milliseconds) that the adapter

HL7 Recourse Action — TCP/IP HL7 V3 InboundAdapterThe following table lists and describes the properties that appear on the HL7 Recourse Actionpage of

TABLE 39 Connectivity Map - HL7 Recourse Action (V3) (Continued)Name DescriptionAction on Nak Received The action the adapter takes when it receives a

SchematronValidation — TCP/IP HL7 V3 InboundAdapterThe following table lists and describes the properties that appears on the SchematronValidation pag

These links provide additional information that is useful to know when working with theTCP/IP HL7 Adapter: “TCP/IP HL7 V2 Adapter Inbound Connectivity

General Outbound Settings — TCP/IP HL7 V3Outbound AdapterThe following table lists and describes the TCP/IP HL7 V3 outbound adapter properties thatapp

TABLE 42 Connectivity Map - TCPIP Outbound Settings (V3)Name DescriptionConnection Type The way the adapter establishes the TCP/IP connection. Select

TABLE 42 Connectivity Map - TCPIP Outbound Settings (V3) (Continued)Name DescriptionReceive Buer Size A number indicating the receive buer size. Thi

TABLE 42 Connectivity Map - TCPIP Outbound Settings (V3) (Continued)Name DescriptionSoTimeout The value of the SoTimeout in milliseconds. You can ente

TABLE 43 Connectivity Map - TCPIP Outbound Settings (V3) - Client Connection Establishment(Continued)Name DescriptionAlways Create NewConnectionAn ind

TABLE 44 Connectivity Map - TCPIP Outbound Settings (V3) - Server Port Binding (Continued)Name DescriptionRetry Binding Interval The amount of time (i

TABLE 46 Connectivity Map - Lower Layer Protocol (V3) (Continued)Name DescriptionEnd Data Character The second to the last envelope marker character i

TABLE 48 Connectivity Map - HL7v3 Transmission WrapperName DescriptionInteraction ID The identication of the unique information interchange. The attr

TABLE 49 Connectivity Map - Communication Control (V3)Name DescriptionTime To Wait For AResponseThe amount of time (in milliseconds) that the adapter

HL7 Recourse Action — TCP/IP HL7 V3 OutboundAdapterThe following table lists and describes the properties that appear on the HL7 Recourse Actionpage o

Note – Throughout this document the term “JMS queue” is used in the generic sense andactually denotes JMS queues or topics.TCP/IP HL7 FeaturesThe TCP/

TABLE 50 Connectivity Map - HL7 Recourse Action (V3) (Continued)Name DescriptionAction on Nak Received The action the adapter takes when it receives a

Conguring Sun Adapter for TCP/IP HL7 EnvironmentPropertiesThe adapter environment conguration properties dene how the adapter connects to andintera

TCP/IP HL7 Inbound Adapter Environment PropertiesThe TCP/IP HL7 Adapter conguration parameters accessed from the Environment tree applyto both the in

TABLE 52 Environment - HL7 Inbound Adapter - TCPIP Inbound SettingsName DescriptionSteady Pool Size An integer indicating the minimum number of messag

TABLE 53 Environment - HL7 Inbound Adapter - Sequence Number ProtocolName DescriptionSequence Number FileLocationThe location of the sequence number 

HL7 Outbound Adapter - TCPIP Outbound SettingsThe following table lists and describes the properties that appear on the MDB Pool Setting pageof the Pr

TABLE 56 Environment - HL7 Outbound Adapter - Connection Pool SettingsName DescriptionSteady Pool Size An integer indicating the minimum number of res

TABLE 57 Environment - HL7 Outbound Adapter - Sequence Number ProtocolName DescriptionSequence Number FileLocationThe location of the sequence number

Collaborations. Therefore, it is important to maintain the original predenedjcdHL7V3Inbound and jcdHL7V3Outbound Collaborations in their initial form

Export the Project you want to copy:a. On the Projects window, right-click the Project to copy, click Export, and then click Project.The Export Manage