Sun Microsystems TCP manual

Sun A dapter f or T CP/IP HL7 U ser's Guide Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A. Part N o: 821–0377–10 October 2009[...]

Copyright 2009 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. I n particular, and without limitation, these intellectual property rights may include one or more U.S[...]

Cont ents Sun Adapter f or TCP/IP HL7 U ser's Guide .......................................................................................... 7 Sun A dapter for TCP/IP HL7 Overview ..............................................................................................8 A bout Sun Adapter for TCP/IP HL7 .................................[...]

HL7 SFT Segment — TCP/IP HL7 V2 Inbound A dapter ....................................................... 44 Communication C ontrol — TCP/IP HL7 V2 Inbound A dapter ........................................... 45 HL7 Recourse A ction — TCP/IP HL7 V2 Inbound A dapter .................................................. 47 TCP/IP HL7 V2 A dapter Ou[...]

TCPIP Outbound Settings - Client Connection Establishment — TCP/IP HL7 V3 Outbound A dapter ...................................................................................................................... 83 TCPIP Outbound Settings - Server P ort Binding — TCP/IP HL7 V3 Outbound A dapter ...................................................[...]

6[...]

Sun Adapt er for T CP/IP HL7 User's Guide This document provides information and instructions for working with the Sun A dapter for TCP/IP HL7. I t 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 A dapter: ■ “Sun A dapter for[...]

These links provide additional information that is useful to know when working with the TCP/IP HL7 A dapter: ■ “TCP/IP HL7 V2 A dapter Inbound Connectivity Map P roperties” on page 30 ■ “TCP/IP HL7 V2 A dapter Outbound Connectivity Map Properties” on page 49 ■ “TCP/IP HL7 V3 A dapter Inbound Connectivity Map P roperties” on page 6[...]

Note – Throughout this document the term “JMS queue” is used in the generic sense and actually denotes JMS queues or topics. T CP/IP HL7 Featur es The TCP/IP HL7 A dapter includes the following features: ■ Bidirectional processing, including client or server mode in either direction (to or from Sun J ava CAPS ESB). ■ Handles both HL7 HLLP[...]

The M essage Library handles all of the lower-layer protocol. The Message Library’ s behavior is customized using the A dapter conguration properties. These A dapter 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 [...]

If a system does not conform to the HL7 specication, the Collaborations can be modied for that transaction by changing the J ava code using the C ollaboration Editor. The C ollaborations J ava code is designed to be available and “transparent” so you can easily reference the predened J ava code to see how it currently handles HL7 trans[...]

■ Monitoring The Enterprise Manager provides a real-time picture of the A dapter's state and status. The monitoring facilities display the following information: ■ A dapter up or down ■ Connected to external ■ Current sequence number ■ Date and time of the last transaction ■ A dapter properties ■ Alerts Alerts are sent from the R[...]

HL7 Adapter Sender Role The outbound Collaboration is the implementation of the Sender and the RA is congured for an outbound data ow. A J ava CAPS Service forwards the data to the A dapter, which in turn forwards the data to the accepting HL7 external system. The External System responds with an A CK or N AK response. HL7 Adapter Rec eiver R[...]

2. The Receiver sends the message to the Forwarder. 3. The Forwarder sends the message to the receiving External System. 4. The receiving External System sends an A CK to the Forwarder. 5. The Forwarder receives the A CK from the External and forwards it on to the Receiver. 6. The Receiver then forwards the A CK, with an MSH - 5, value “F” indi[...]

Standard Inbound Message Mode Data F low and Archit ec ture The following steps describe the ow of data for an inbound A dapter: 1. The external system sends the HL7 message to the A dapter. 2. The Collaboration receives the HL7 message. 3. The Collaboration validates the message (if validate is enabled). If it fails, the Collaboration takes the[...]

Message V erication M essage verication begins with reading the message from the external system. The message is expected to match the MLLP envelope, since both HLLP and MLLP envelopes have the Start of Block (SOB), End of Data (EOD), and a Carriage Return (CR) in common. If a message fails the read verication, it is considered bad data. I[...]

■ No response is received after a message is sent the maximum number of times. Outbound F unc tionality The outbound TCP/IP HL7 A dapter Project, prjHL7Outbound, can be implemented in standard outbound mode or in two forward message modes: outbound delayed A CK or outbound forwarder. Outbound Adapter Data F low In outbound mode, the A dapter rece[...]

5. The Collaboration receives and validates the ACK, and then journals the A CK and the HL7 message (if journaling is enabled). If the Collaboration receives a N AK, the NAK and the HL7 message are sent to the error queue. 6. Finally, the Collaboration commits the JMS receive. Outbound Adapter Roles f or Delay ed ACK Scenarios The outbound A dapter[...]

Note – For Delayed A CK, the Receiver and Forwarder must be on the same integration server. Message V erication The only verication that the outbound A dapter does is to ensure that the message parses into the generic Event M essage Library, and that the MSH uses the correct elds. The acknowledge is veried to ensure that the sent mess[...]

Note – The TCP/IP HL7 Adapter includes internal counters that keep track of all error conditions. General F unc tionality This section explains the A dapter’ s general functions and features. I t includes the following topics: ■ “Non-blocking I/O ” on page 20 ■ “HL7 Sequence N umbering Protocol” on page 20 ■ “Failed M essage Han[...]

The minimum HL7 sequence number is 1. The maximum HL7 sequence number is 2 billion. A sequence number of “0“ is used to start a session. If the sequence numbers between the A dapter and the external cannot be reconciled during start or when exchanging messages, the A dapter shuts down and wait for human intervention as dictated by the HL7 Stand[...]

The argument error message is the user-congured alert message. The argument HL7 is the source component (this must be “HL7”). Note – The alerter.fatal( " error msg " , " HL7 " ) method is only applicable to the packaged TCP/IP HL7 Collaborations. The Exit recourse action should be applied to any error condition that req[...]

Lower Layer Pro toco l This section describes the two supported envelope types used in the HL7 protocol: ■ HLLP (H ybrid L ower Layer Protocol) ■ MLLP (Minimal Lower Layer Protocol) Both envelope types use the following conguration parameters. For more information on these parameters, see “Lower Layer Protocol — TCP/IP HL7 V2 Inbound A d[...]

I t is expected that, when enabled, the journal queue has one or more subscribers that process the contents of the queue so that it remains manageable. For example, the Batch A dapter or a database A dapter could periodically consume the messages by writing them to a le or a database. Error Queues The A dapter provides a mechanism to store faile[...]

<web-app> ... ... <!-- Default monitoring period used in monitoring the external system connection --> <context-param> <param-name>monitorperiod</param-name> <param-value>2000</param-value> </context-param> ... </web-app> Schematron Support in the HL7 Adapter Schematron is supported for HL7 V3 M[...]

In the HL7 A dapter, this schematron is useful for validating an HL7 V3 document against predened schematron schemas that you write. You can also obtain schemas from organizations such as NHS and HL7.org. For example, NHS provides schemas for CD A documents. Schematron C onguration in HL7 Adapter You congure the schematron validation from [...]

Using the Schematr on API P erform the following to invoke the schematron API from a Java Collaboration: ■ Obtaining the Factory Object ■ Obtaining the Validator Object ■ P erforming the Validation Obtaining the F ac tory Objec t Below is a sample call to the getSchematronValidatorFactory method. com.stc.connector.hl7.schematron.SchematronVal[...]

You can congure the TCP/IP HL7 A dapter properties in the following locations: ■ Connectivity Map : These properties most commonly apply to a specic component A dapter, and may vary from other Adapters of the same type in the P roject. ■ Environment Explorer : These properties are commonly global, applying to all Adapters of the same type[...]

Modify the Adapter pr operties, as described in “Modifying the T CP/IP HL7 Adapter Pr oper ties in the Connectivity Map” on page 29 . Modifying the T CP/IP HL7 Adapt er Proper ties in the C onnec tivity Map You can modify an A dapter's properties after it is created in the Connectivity Map. The properties you modify in the Connectivity Map[...]

▼ Modifying Adapter P roper ties in the Connectivity Map Fr om the Connectivity Map, double-click the Adapter icon located in the link between the T CP/IP HL7 External Application and the Ser vice. The A dapter Properties Editor appears, and displays either inbound or outbound properties depending on the link to the Service. In the explorer panel[...]

■ “HL7 A cknowledgment — TCP/IP HL7 V2 Inbound A dapter” on page 39 ■ “Lower Layer Protocol — TCP/IP HL7 V2 Inbound A dapter” on page 40 ■ “Sequence N umber Protocol — TCP/IP HL7 V2 Inbound A dapter” on page 41 ■ “HL7 MSH Segment — TCP/IP HL7 V2 Inbound A dapter” on page 41 ■ “HL7 SFT Segment — TCP/IP HL7 V2 In[...]

T CPIP Inbound Settings — T CP/IP HL7 V2 Inbound Adapt er The following table lists and describes the properties on the TCPIP Inbound Settings page of the Properties Editor accessed from the Connectivity Map. These properties congure the J ava socket and server socket options. T ABLE 3 Connectivity Map - TCPIP Inbound Settings Name Description[...]

T ABLE 3 Connectivity Map - TCPIP Inbound Settings (Continued) Name Description Keep Alive An indicator of whether the client’ s SO_KEEP ALIVE option is enabled or disabled. Select true to enable SO_KEEP ALIVE; otherwise, select false . When the option is enabled for a TCP socket and no data has been exchanged across the socket in either directio[...]

T ABLE 3 Connectivity Map - TCPIP Inbound Settings (Continued) Name Description SoLinger An indicator of whether the adapter performs a “linger-on-close” timeout. This option disables or enables an immediate return from a call to the close() method for a TCP Socket. To enable the linger-on-close timeout, select true ; otherwise, select false . [...]

T CPIP Inbound Settings - S er ver P or t Binding — T CP/IP HL7 V2 Inbound A dapter The following table lists and describes the properties that appear on the Server P ort Binding page of the Properties Editor accessed from the Connectivity Map. The properties dene the server port binding retry options. This section is only used when the Connec[...]

T ABLE 6 C onnectivity Map - TCPIP I nbound Settings - Inbound Connection Management Name Description Max Connection Pool Size The maximum number of concurrent connections allowed for the specic listener or monitor that is listening or monitoring the specied TCP/IP port. 0 (zero) indicates that there is no limit. This value indicates the capa[...]

■ Timer Service – A vailable for Java EE, this scheduler is congured using the At Fixed Rate , Delay , and Period properties. ■ Work Manager – A vailable for Java EE (JCA 1.5 and above), this scheduler is congured using the Delay and Period properties. T ABLE 7 Connectivity Map - TCPIP Inbound Schedules - Listener Schedule Name Descri[...]

T CPIP Inbound Schedules - S er vice Schedule T CP/IP HL7 V2 Inbound Adapter The following table lists and describes the properties that appear on the Service Schedule page of the Properties Editor accessed from the Connectivity Map. These properties congure the scheduler used by the TCP/IP server that executes the business tasks (Collaboration [...]

T ABLE 8 C onnectivity Map - TCPIP I nbound Schedules - Service Schedule (Continued) Name Description A t Fixed Rate An indicator of whether a xed-rate execution or xed-delay execution is used. This property applies to the Timer Service conguration only, and is used when the Schedule Type property is set to Repeated . Select true to indica[...]

T ABLE 9 Connectivity Map - HL7 Acknowledgment (Continued) Name Description eGate Sends App A cks An indicator of whether the HL7 application acknowledgment sent to the external system is generated by the adapter or forwarded from the application server. Select one of the following options: ■ true – Indicates that the application server receive[...]

T ABLE 10 Connectivity Map - Lower L ayer Protocol (Continued) Name Description End Data Character The second to the last envelope marker character in the HL7 envelope, as a decimal ASCII number. Enter a number from 1 to 127. Unless there is a conict, the value should be ASCII FS (decimal 28). End Block Character The last envelope marker charact[...]

T ABLE 12 Connectivity Map - HL7 MSH Segment Name Description Field Separator The character that separates the segment ID and the rst real eld. This value denes the character that is used as a separator for the rest of the message and is the rst eld in the HL7 MSH segment (MSH-01). The value is a decimal ASCII number, and the allowed[...]

T ABLE 12 Connectivity Map - HL7 MSH Segment (Continued) Name Description Processing ID The subcomponent processing ID of the MSH-11 eld. MSH-11 is used to indicate whether a message is processed as dened in the HL7 A pplication processing rules. Specify one of the following options: ■ D - The message is part of a debugging system. ■ P - [...]

T ABLE 12 Connectivity Map - HL7 MSH Segment (Continued) Name Description Validate MSH An indicator of whether to validate the MSH segment of the data message (for inbound) and the MSH segment of the ACK (for outbound). Select true if you want the Collaboration to validate the MSH segment; otherwise select false . This parameter is used in Collabor[...]

T ABLE 13 Connectivity Map - HL7 SFT Segment (Continued) Name Description Software Certied Version or Release Number The latest software version number or release number for the sending system, which helps provide a more complete prole of the application that is sending or receiving HL7 messages. Version numbers are important in identifying t[...]

T ABLE 14 Connectivity Map - Communication C ontrol Name Description Time To Wait For A Response The amount of time (in milliseconds) that the adapter waits for a response from the external system before taking recourse action (see Action on No Response in HL7 Recourse Action ). Any data from the external system is considered a response. This prope[...]

HL7 Recourse A c tion — T CP/IP HL7 V2 Inbound Adapt er The following table lists and describes the properties that appear on the HL7 Recourse A ction page of the Properties Editor accessed from the Connectivity Map. These properties dene the actions the adapter takes when operations occur outside the congured constraints. T ABLE 15 Connect[...]

T ABLE 15 Connectivity Map - HL7 Recourse Action (Continued) Name Description Action on N ak Received The action the adapter takes when it receives an HL7 A pplication NAK from the external system. Select one of the following options: ■ Resend – The adapter attempts to resend the message to the external system. ■ Reset – The adapter closes [...]

T CP/IP HL7 V2 Adapt er O utbound Connectivity Map Pr oper ties The TCP/IP HL7 V2 server outbound adapter conguration properties are organized into the following sections on the Properties Editor accessed from the Connectivity Map: ■ “General Outbound Settings — TCP/IP HL7 V2 Outbound Adapter” on page 49 ■ “TCPIP Outbound Settings ?[...]

T CPIP Outbound S ettings — TCP/IP HL7 V2 Outbound Adapt er The following table lists and describes the properties on the TCPIP Outbound Settings page of the Properties Editor accessed from the Connectivity Map. These properties congure the J ava socket and server socket options. For more information, see the J avadocs for Java SD K. T ABLE 17[...]

T ABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued) Name Description Keep Alive An indicator of whether the client’ s SO_KEEP ALIVE option is enabled or disabled. Select true to enable SO_KEEP ALIVE; otherwise, select false . When the option is enabled for a TCP socket and no data has been exchanged across the socket in either direct[...]

T ABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued) Name Description SoLinger An indicator of whether the adapter performs a “linger-on-close” timeout. This option disables or enables an immediate return from a call to the close() method for a TCP Socket. To enable the linger-on-close timeout, select true ; otherwise, select false [...]

T ABLE 17 Connectivity Map - TCPIP Outbound Settings (Continued) Name Description Socket Factory Implementation Class Name The name of the Java class that implements the socket factory. This class is used to create the socket. If you have provided your own socket implementation, enter the name of the Java class that contains this implementation her[...]

T ABLE 18 C onnectivity Map - TCPIP Outbound Settings - Client Connection Establishment (Continued) Name Description A uto Reconnect Upon Matching Failure An indicator or whether to attempt to reconnect automatically when the adapter gets a matching connection from a container, even though this connection is not valid; for example, the external sid[...]

HL7 Ackno wledgment — T CP/IP HL7 V2 O utbound Adapt er The following table lists and describes the properties that appear on the HL7 A cknowledgment page of the Properties Editor accessed from the Connectivity Map. These properties dene how the application acknowledgment events are handled. T ABLE 20 Connectivity Map - HL7 Acknowledgement Nam[...]

T ABLE 21 Connectivity Map - Lower L ayer Protocol Name Description LLP Type MLLP is the congured default value. The lower layer protocol (LLP) type. Select one of the following options: ■ MLLP (Minimal Lower Layer Protocol) ■ HLLP (H ybrid Lower Layer Protocol) ■ MLLP v2.0 (Minimal Lower Layer Protocol v2.0) For more information on the av[...]

HL7 MSH Segment — T CP/IP HL7 V2 O utbound Adapt er The following table lists and describes the properties that appear on the HL7 MSH Segment page of the Properties Editor accessed from the Connectivity Map. These properties dene the conguration of the MSH segment of the HL7 message. For more information about this segment, refer to the HL7[...]

T ABLE 23 Connectivity Map - HL7 MSH Segment (Continued) Name Description Receiving Facility A user-dened value that further identies the receiving application among multiple identical instances of the application running on behalf of dierent organizations. The default value is Sun HL7 adapter . This is the sixth eld in the HL7 MSH segm[...]

T ABLE 23 Connectivity Map - HL7 MSH Segment (Continued) Name Description Conformance Statement ID A unique identier that applies to a query’ s conformance statement. I t can also be used as a Message P role Identier to assert constancy with a message prole (grammar, syntax, usage, and so on). This is the 21st eld in the HL7 MSH se[...]

T ABLE 24 Connectivity Map - HL7 SFT Segment (Continued) Name Description Software Certied Version or Release Number The latest software version number or release number for the sending system, which helps provide a more complete prole of the application that is sending or receiving HL7 messages. Version numbers are important in identifying t[...]

T ABLE 25 Connectivity Map - Communication C ontrol Name Description Time To Wait For A Response The amount of time (in milliseconds) that the adapter waits for a response from the external system before taking recourse action (see Action on No Response in HL7 Recourse Action ). Any data from the external system is considered a response. This prope[...]

HL7 Recourse A c tion — T CP/IP HL7 V2 O utbound Adapt er The following table lists and describes the properties that appear on the HL7 Recourse A ction page of the Properties Editor accessed from the Connectivity Map. These properties dene the actions the adapter takes when operations occur outside the congured constraints. T ABLE 26 Conne[...]

T ABLE 26 Connectivity Map - HL7 Recourse Action (Continued) Name Description Action on N ak Received The action the adapter takes when it receives an HL7 A pplication NAK from the external system. Select one of the following options: ■ Resend – The adapter attempts to resend the message to the external system. ■ Reset – The adapter closes [...]

T CP/IP HL7 V3 Adapt er Inbound Connectivity M ap Properties The TCP/IP HL7 V3 Server inbound adapter conguration properties are organized into the following sections on the Properties Editor accessed from the Connectivity Map: ■ “General Inbound Settings — TCP/IP HL7 V3 Inbound A dapter” on page 64 ■ “TCPIP Inbound Settings — TCP/[...]

T ABLE 27 Connectivity Map - General Inbound Settings (V3) (Continued) Name Description Scope Of State The scope of the state object, which is a Message Library node. Select one of the following options for this property: ■ Resource Adapter Level – The state has the same life cycle as the resource adapter. ■ Connection L evel – The state ha[...]

T ABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued) Name Description ServerSO Timeout The value (in milliseconds) of the SO_TIMEOUT parameter for ServerSocket . The timeout must be greater than zero ( 0 ). A timeout of zero is interpreted as an innite timeout. This value is used for the ServerSocket.accept() method. When this op[...]

T ABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued) Name Description Receive Buer Size A number indicating the receive buer size. This is the value of the SO_RCVBUF option for the current socket, which is the buer size used by the operating system for input on this socket. I t provides an estimate of the size of the underl[...]

T ABLE 28 Connectivity Map - TCPIP Inbound Settings (V3) (Continued) Name Description SoTimeout The value of the SoTimeout in milliseconds. This is used for the accepted client socket. You can enter a value greater than or equal to zero ( 0 ). When set to zero ( 0 ), the timeout is innite. With this option set to a non-zero value, calling the re[...]

T CPIP Inbound Settings - Client Connec tion Establishment — T CP/IP HL7 V3 Inbound Adapter The following table lists and describes the property that appears on the Client Connection Establishment page of the Properties Editor accessed from the Connectivity Map. This property denes a wait time before connecting to the external system. This sec[...]

T ABLE 31 C onnectivity Map - TCPIP I nbound Settings (V3) - Inbound Connection Management (Continued) Name Description Scope Of Connection The scope of the accepted connection that is used by the adapter. Select one of the following options: ■ Resource Adapter Level – The resource adapter closes the connection upon request (by way of ClosureCo[...]

T ABLE 32 C onnectivity Map - TCPIP I nbound Schedules (V3) - L istener Schedule Name Description Scheduler The scheduler type for this inbound communication. Select one of the following options: ■ Timer Service – The task is scheduled through the Java EE Timer Service. Timer Service is supported by Java EE. ■ Work Manager – The task is sch[...]

scheduler used by the TCP/IP server that executes the business tasks (Collaboration rules) over the existing connection. This scheduler aects the actual business rules you dene. You can use either of the following two J ava EE schedulers, both of which provide the functionality required by the inbound TCP/IP server. ■ Timer Service – A va[...]

T ABLE 33 C onnectivity Map - TCPIP I nbound Schedules (V3) - Service Schedule (Continued) Name Description A t Fixed Rate An indicator of whether a xed-rate execution or xed-delay execution is used. This property applies to the Timer Service conguration only, and is used when the Schedule Type property is set to Repeated . Select true to [...]

T ABLE 35 Connectivity Map - Lower L ayer Protocol (V3) Name Description LLP Type The lower layer protocol (LLP) type. The supported option is MLLP v2.0 (Minimal Lower Layer Protocol v2.0). For more information on MLLP v2.0, see “Lower Layer Protocol” on page 23 . Start Block Character The rst envelope marker character in the HL7 envelope, a[...]

needs to package and route the message to the specied receiving applications or message handling services. The transmission wrapper is a cluster of classes and identies the sender and receiver of the message and the particular kind of message being communicated. T ABLE 37 Connectivity Map - HL7v3 Transmission Wrapper Name Description Interact[...]

T ABLE 38 Connectivity Map - Communication C ontrol (V3) Name Description Time To Wait For A Response The amount of time (in milliseconds) that the adapter waits for a response from the external system before taking recourse action (see Action on No Response in HL7 Recourse Action ). Any data from the external system is considered a response. This [...]

HL7 Recourse A c tion — T CP/IP HL7 V3 Inbound Adapt er The following table lists and describes the properties that appear on the HL7 Recourse A ction page of the Properties Editor accessed from the Connectivity Map. These properties dene the actions the adapter takes when operations occur outside the congured constraints. T ABLE 39 Connect[...]

T ABLE 39 Connectivity Map - HL7 Recourse Action (V3) (Continued) Name Description Action on N ak Received The action the adapter takes when it receives an HL7 A pplication NAK from the external system. Select one of the following options: ■ Resend – The adapter attempts to resend the message to the external system. ■ Reset – The adapter cl[...]

Schematron V alidation — TCP/IP HL7 V3 Inbound Adapt er The following table lists and describes the properties that appears on the Schematron Validation page of the Properties Editor accessed from the Connectivity Map. The schematron uses the concept of nding tree patterns in a parsed document rather than grammar patterns. T ABLE 40 Connectivi[...]

General Outbound Settings — TCP/IP HL7 V3 Outbound Adapter The following table lists and describes the TCP/IP HL7 V3 outbound adapter properties that appear on the General Outbound Settings page of the Properties Editor accessed from the Connectivity Map. T ABLE 41 Connectivity Map - General Outbound Settings (V3) Name Description Max Data Size A[...]

T ABLE 42 Connectivity Map - TCPIP Outbound Settings (V3) Name Description Connection Type The way the adapter establishes the TCP/IP connection. Select one of the following options: ■ Client – The adapter connects to an external server (host/port) to establish the connection. The adapter is in active mode. ■ Server – The adapter waits and [...]

T ABLE 42 Connectivity Map - TCPIP Outbound Settings (V3) (Continued) Name Description Receive Buer Size A number indicating the receive buer size. This is the value of the SO_RCVBUF option for the current socket, which is the buer size used by the operating system for input on this socket. I t provides an estimate of the size of the under[...]

T ABLE 42 Connectivity Map - TCPIP Outbound Settings (V3) (Continued) Name Description SoTimeout The value of the SoTimeout in milliseconds. You can enter a value greater than or equal to zero ( 0 ). When set to zero ( 0 ), the timeout is innite. With this option set to a non-zero value, calling the read() method on the input stream associated w[...]

T ABLE 43 C onnectivity Map - TCPIP Outbound Settings (V3) - Client Connection Establishment (Continued) Name Description Always Create New Connection An indicator of whether the adapter always attempts to create a new connection when a connection establishment request is received. Select on of the following options: ■ true – The adapter always[...]

T ABLE 44 C onnectivity Map - TCPIP Outbound Settings (V3) - Server P ort Binding (Continued) Name Description Retry Binding I nterval The amount of time (in milliseconds) that the adapter waits between attempts to bind to the specied TCP/IP port on the localhost. HL7 Ackno wledgment — T CP/IP HL7 V3 O utbound Adapt er The following table list[...]

T ABLE 46 Connectivity Map - Lower L ayer Protocol (V3) (Continued) Name Description End Data Character The second to the last envelope marker character in the HL7 envelope, as a decimal ASCII number. Enter a number from 1 to 127. Unless there is a conict, the value should be ASCII FS (decimal 28). End Block Character The last envelope marker ch[...]

T ABLE 48 Connectivity Map - HL7v3 Transmission Wrapper Name Description Interaction ID The identication of the unique information interchange. The attribute values are derived from the HL7 MDF interaction names; for example, POLB_INI00100 and COMT_IN300652 . Processing Code An indicator of the type of system the message is part of. Specify one [...]

T ABLE 49 Connectivity Map - Communication C ontrol (V3) Name Description Time To Wait For A Response The amount of time (in milliseconds) that the adapter waits for a response from the external system before taking recourse action (see Action on No Response in HL7 Recourse Action ). Any data from the external system is considered a response. This [...]

HL7 Recourse A c tion — T CP/IP HL7 V3 O utbound Adapt er The following table lists and describes the properties that appear on the HL7 Recourse A ction page of the Properties Editor accessed from the Connectivity Map. These properties dene the actions the adapter takes when operations occur outside the congured constraints. T ABLE 50 Conne[...]

T ABLE 50 Connectivity Map - HL7 Recourse Action (V3) (Continued) Name Description Action on N ak Received The action the adapter takes when it receives an HL7 A pplication NAK from the external system. Select one of the following options: ■ Resend – The adapter attempts to resend the message to the external system. ■ Reset – The adapter cl[...]

C onguring Sun Adapt er for T CP/IP HL7 En vironment Pr oper ties The adapter environment conguration properties dene how the adapter connects to and interacts with other J ava CAPS components within the environment. The environment properties are accessed from the N etBeans IDE Services window. The following sections provide instructions [...]

T CP/IP HL7 Inbound Adapter En vironment Pr oper ties The TCP/IP HL7 A dapter conguration parameters accessed from the Environment tree apply to both the inbound and outbound A dapters, and are the same for HL7 v2 and HL7 v3 A dapters. The inbound TCP/IP HL7 A dapter’ s Environment properties are divided into the following sections: ■ “HL7[...]

T ABLE 52 Environment - HL7 Inbound A dapter - TCPIP Inbound Settings Name Description Steady P ool Size An integer indicating the minimum number of message–driven beans to maintain. When the value is set to a number greater than 0 (zero), the container pre-populates the MDB pool with the specied number and tries to ensure that there are alway[...]

T ABLE 53 Environment - HL7 Inbound A dapter - Sequence N umber Protocol Name Description Sequence Number F ile Location The location of the sequence number le (a local directory). This is required when the Sequence N umber Protocol is enabled. The sequence number folder is a nonvolatile directory that stores the sequence number les used to p[...]

HL7 Outbound Adapter - TCPIP Outbound Settings The following table lists and describes the properties that appear on the MDB P ool Setting page of the Properties Editor accessed from the Environment. These properties congure the J ava socket and server socket options. For more information, see the J avadocs provided with Java SDK. T ABLE 55 Envi[...]

T ABLE 56 Environment - HL7 Outbound Adapter - Connection P ool Settings Name Description Steady P ool Size An integer indicating the minimum number of resource adapter connections to be maintained. When the value is set to a number greater than 0 (zero), the container pre-populates the RA connection pool with the specied number and tries to ens[...]

T ABLE 57 Environment - HL7 Outbound Adapter - Sequence N umber Protocol Name Description Sequence Number F ile Location The location of the sequence number le (a local directory). This is required when the Sequence N umber Protocol is enabled. The sequence number folder is a nonvolatile directory that stores the sequence number les used to p[...]

Collaborations. Therefore, it is important to maintain the original predened jcdHL7V3Inbound and jcdHL7V3Outbound Collaborations in their initial form for future use. Before working with the HL7 V3 sample Projects, be sure that the required HL7 V3 SAR les are uploaded to the repository. The required les are listed below: 1. HL7eWay.sar 2. [...]

Export the Project you want to copy: a. On the Projects window , right-click the Project to copy , click Expor t, and then click Pr oject. The Export Manager dialog box appears. b . Select the Projects and Environments to export. The selected Project appears in the Selected Projects: pane of the Export M anager. c. Selec t the Project or the Enviro[...]

Tip – Click the left-arrow button , if you want to move the selected projects from the right pane to the left pane. d. Click Brow se and select an appropriate directory to save the exported Project. e. Click Export. The Project is compressed and saved to the specied directory and le name. Rename the original Project in the NetBeans IDE. FIG[...]

Note – The NetBeans IDE will not import identically named Projects to the same root, so you must perform this step before importing the Project back in. On the NetBeans IDE, click Save All . Import the Project back in to the Repositor y . a. On the NetBeans menu bar , select T ools, point to CAPS Repositor y , and then selec t Impor t Project fro[...]

d. Click Import. I t may take a few seconds to import the project. When the project is imported, the Import Status dialog box appears. e. Click OK on the dialog box. The CAPS Repository is refreshed, and you now have two copies of the same Project in the Repository. Cust omizing Predened C ollabora tions for HL7 The predened Collaborations ar[...]

Repeat this step for additional c opies of the Collaboration. T o add each new Collaboration to a P rojec t's Connectivity Map, drag and dr op the Collaboration from the Pr ojects Explorer tree to the Connectivity Map Editor . The new Collaborations can now be associated with the Project's components. FIGURE 4 Collaboration — C opied to[...]

Adding an HL7 Message Libr ar y t o an Existing C ollabora tion In some cases, a specic HL7 message or messages might need to be added to the Collaboration. P erform the following to add a HL7 Message Library to an existing Collaboration. Note – Make sure you are using the correct version of the M essage Library for the C ollaboration you are [...]

Click Add to select the object type denition. A dialog box appears where you can select the M essage Library to add. FIGURE 6 Collaboration Denition ( Java) Properties 4 Using the TCP/IP HL7 Predened T emplates Sun Adapter for TCP/IP HL7 U ser's Guide 105[...]

In the Look In eld, na vigate to the location of the Message Library . The HL7 M essage Libraries are located in CAPS Components L ibrary > Message Library > HL7. Select the Message Librar y and then click Selec t. The M essage Library is added to the list. FIGURE 7 Select Object Type Denition 5 6 Using the TCP/IP HL7 Predened T empl[...]

Tip – You can also modify an existing HL7 V2 Message Library by clicking the M essage Library to change, clicking the ellipsis that appears, and selecting the appropriate M essage Library. On the Collabora tion Denition Proper ties dialog box, click OK. About TCP/IP HL7 V2 Collabor ations This section provides an overview and description of th[...]

The following topics provide information about the sample V2 Collaborations and provide instructions for copying and customizing them: ■ “TCP/IP HL7 V2 A dapter Projects Overview” on page 108 ■ “TCP/IP HL7 V2 A dapter Collaborations” on page 108 ■ “Inbound HL7 V2 Collaboration Overview” on page 109 ■ “Outbound HL7 V2 Collabora[...]

A t the end of each action, the state is set for the next execution of the C ollaboration. There are three main states: ■ To Establish: A new or reset connection needs to have an HL7 session established. If sequence numbering is used, the sequence numbers need to be negotiated. ■ Messaging: This is where the exchange of messages and A CKs takes[...]

otdHL7_GENERIC_EVT_1, com.stc.SeeBeyond.OTD_Library.HL7.Generic.HL7_ACK.AC K otdHL7_ACK_1,com.stc.connectors.jms.JMS otdJMS_JOURNAL, com.stc.connectors.jms.JMS otdJMS_ERROR) throws Throwable Note – The above text has been wrapped to t the page. Once the message is received, the Collaboration determines whether the message needs to be validated[...]

Collaboration gets triggered by a HL7 message received from a HL7 Client/Outbound/External; it then calls HL7 User Collaboration Rule by executing the receive() method Receive is the entry point to the HL7 User Collaboration; it has the follo wing signature: receive (HL7eW ay , JMS_D A T A, GenericHL7OTD , HL7ACK OTD , JournalJMSSess, ErrorJMSSess)[...]

Inbound HL7 V2 Collabor ation - P ar t 2 The Collaboration receives the HL7 V2 message from the external using receiveHL7message() . If an exception occurs due to incomplete data and the adapter fails to read the data within the congured number of retries, the associated recourse action is taken. If the exception is due to no response, the assoc[...]

Handle Max F ailed Read Retry/T ake Recourse Action archiveError Message() Handle Max NAK Sent condition/T ake Recourse Action journalHL7 Message() Handle No Response Error/ T ake Recourse Action sendHL7Nak() sends NAK Exception due to incomplete data? receiveAndSend() Gets the HL7 Message from External and validates it and sends Ack/Nak receiveHL7[...]

Inbound HL7 V2 Collabor ation - P ar t 3 After the A CK is sent, the HL7 V2 message and the A CK are journaled to the JMS queue Journal destination. If the message fails to journal, the associated recourse action is taken. If sequence numbering is enabled, the processAckNakSequenceNumbering method calculates the next sequence number and stores the [...]

The following topics describe the business logic dened in the jcdHL7Outbound Collaboration: ■ “Outbound HL7 V2 Collaboration - Part 1” on page 115 ■ “Outbound HL7 V2 Collaboration - Part 2” on page 117 ■ “Outbound HL7 V2 Collaboration - Part 3” on page 119 ■ “HL7 V2 Outbound Test Collaboration” on page 119 Outbound HL7 V2[...]

Collaboration gets triggered by a JMS HL7 message; it then calls HL7 User Collaboration Rule by executing the receive() method Only if Sequence Numbering is enabled Only if Sequence Numbering is enabled Receive is the entry point to the HL7 User Collaboration; it has the follo wing signature: receiv e (JMSMessage, HL7Ewa y , GenericHL7OTD , HL7ACK [...]

Outbound HL7 V2 Collabora tion - Par t 2 The Collaboration receives the HL7 ACK or N AK from the external system using receiveHL7AckNak() . If an exception occurs due to incomplete data and the adapter fails to read the data within the congured number of retries, the associated recourse action is taken. If the exception is due to no response, th[...]

Can result in archiving the HL7 message/with NAK in ERROR Queue Calls other helper methods such as checkSendingReceiving Application and checkSendingReceiving Facility to validate the ACK message Exception occurred? Exception due to incomplete data? receiveHL7AckNak() Get the HL7 ACK message from External isAckMessage() Validates message and determ[...]

Outbound HL7 V2 Collabora tion - Par t 3 If the A CK message passes validation, the HL7 V2 message and ACK message are sent to the JMS journal destination. If the message fails to journal, the associated recourse action is taken. If sequence numbering is enabled, the processAckNakSequenceNumbering method calculates the next sequence number and stor[...]

About TCP/IP HL7 V3 Collabor ations The following topics provide a brief overview of HL7 V3, and describe the HL7 V3 Collaborations and provide instructions on copying and customizing the C ollaborations: ■ “A bout HL7 V3” on page 120 ■ “TCP/IP HL7 V3 A dapter Projects Overview” on page 121 ■ “TCP/IP HL7 V3 A dapter Collaborations?[...]

The V3 standard also includes interactions, such as Create Patient B illing Account. There are three modes of A cknowledgement process in HL7 V3: ■ Immediate M ode ■ Deferred Mode ■ Queued M ode T CP/IP HL7 V3 A dapter Projects O verview Several HL7 V3 sample Projects are provided with the TCP/IP HL7 A dapter to illustrate dierent scenario[...]

1. Inbound HL7 V3 I mmediate C ollaboration 2. Inbound HL7 V3 Deferred Collaboration 3. Inbound HL7 V3 Queue M anager 4. Inbound HL7 V3 M essage Publisher Inbound HL7 V3 Immediate C ollaboration Overview The Inbound HL7 V3 Collaboration, jcdHL7V3Inbound, contains M essage Libraries for the HL7 V3 Resource A dapter, JMS Data, JMS Journal, and JMS Er[...]

Note – The above text has been wrapped to t the page. About TCP/IP HL7 V3 Collaborations Sun Adapter for TCP/IP HL7 U ser's Guide 123[...]

Once the message is received, the Collaboration determines whether the message needs to be validated. The HL7 V3 message is then validated, making sure that the message structure is correct. Various elds in the Transmission Wrapper of the message are also validated, such as Exception occurred? Exception due to incomplete data receive(--) receive[...]

Version Code, Processing Code, Processing Mode Code, and Interaction ID . If these elds do not match the conguration, a N AK is returned. The Collaboration receives the HL7 V3 message from the external using receiveHL7Message() . If an exception occurs due to incomplete data, and the adapter fails to read the data within the congured numbe[...]

validateHL7Message() Validates V3 message and determines if it should send ACK/NAK HL7 V3 Message passed Validation? sendHL7ACK() Sends HL7 V3(MCCI_IN000004U V01) immediate ACK Message SendHL7NAK() Sends HL7 v3 (MCCI_IN000004UV01) immediate NAK message Calls other helper methods(makeNAK()) to make V3 NAK message and send it Calls other helper metho[...]

Inbound HL7 V3 Deferred C ollaboration Overview The Inbound HL7 V3 Collaboration, jcdHL7V3DeferredInbound, contains M essage Libraries for the HL7 V3 Resource A dapter, JMS Data, JMS Journal, JMS Error, and JMS APP A CK as well as the HL7 V3 Patient A dministration Domain Interaction Event (PRP A_IN403001UV01) and the corresponding HL7 V3 Commit Ac[...]

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 t the page. Once the message is received, the Collaboration determines whether the message needs to be validated. The HL7 V3 message is then validated, making sure that the message structure is [...]

Receive is the entry point to the HL7 user collaboration, it has the f ollowing signature. receive(HL7e way , otd_PRP A_IN403001UV01, otd_MCCI_IN000006UV01, otd_MCCI_IN000007UV01,JMS_D A T A, JournalJMSOTD ,ErrorJMSOTD , JournalAppACKJMS) Is Sequence Number Enabled receive(--) receive HL7 v3 PRPA_IN403001UV01 message, validate it and send HL7 v3 co[...]

HL7 V3 Standard Inbound Message Mode Data F low (For Def erred Mode of A CK Process) — P ar t 2 The Collaboration receives the HL7 V3 message from the external using receiveHL7message() . If an exception occurs due to incomplete data, and the adapter fails to read the data within the congured number of retries, the associated recourse action i[...]

receiveAndSend() Gets the HL7 v3 message from the external , validates it and sends ACK/NAK receiveHL7Message() receives the HL7 v3 message from the external validateHL7Message() Validates V3 message and message does not have valid sequence number if sequence number is enabled and determines if it should send ACK/NAK (Insert expected sequence numbe[...]

HL7 V3 Standard Inbound Message Mode Data F low (For Def erred Mode of A CK Process) — P ar t 3 After the Commit ACK is sent and the A pplication A CK is stored in JMS, the HL7 V3 message and the A CKs are journaled to the JMS queue journal destination. If the message fails to journal the associated recourse action is taken. About TCP/IP HL7 V3 C[...]

Outbound HL7 V3 C ollaboration Overview The Outbound HL7 V3 Collaboration, jcdHL7V3Outbound, contains Message Libraries for the HL7 V3 Resource A dapter, JMS Data, JMS Journal, and JMS Error, as well as the HL7 V3 Patient A dministration Domain Interaction Event (PRP A_IN403001UV01) and the HL7 V3 Message validation passed Validate Sequence numberi[...]

corresponding HL7 V3 A cknowledgements. MCCI_IN000004UV01 for Immediate M ode and MCCI_IN000006UV01 for Deferred Mode. The Collaboration works with its own internal code and the Properties Conguration les. The outbound Collaboration assumes that it is reading valid HL7 V3 messages, so the data ow that feeds this Collaboration must ensure t[...]

Receive is the entry point to the HL7 user collaboration, it has the follo wing signature. receive (JMSMessage,HL7ew ay , otd_PRP A_IN403001UV01, otd_MCCI_IN000004UV01, otdMCCI_IN000006UV01_1, JournalJMSOTD , ErrorJMSO TD) HL7 v3 message passed validation receive(--) send HL7 message to external HL7 system and wait for HL7 ACK validateHL7Message() [...]

HL7 V3 Standard Outbound Message Mode Data Flo w (For Immediat e and Deferred Mode of A CK Process) — P ar t 2 In processMessage() , the message moves on to insertSequenceNumber() . If sequence numbering is enabled and is in Deferred Mode, the insertSequenceNumber method inserts the sequence number and call sendHL7Message() . The sendHL7Message m[...]

Exception Occurred Exception due to incomplete data InsertSequenceNumber() insert the next sequence number in the hl7 v3 message sendHL7Message() send the hl7 v3 message to external using HL7eWays OTD receiveHL7AckNak() Get the HL7 Ack message form the external isAckMessage() Validates message and determines if message is Ack or Nak validateAckNak([...]

HL7 V3 Standard Outbound Message Mode Data Flo w (For Immediat e and Deferred Mode of A CK Process) — P ar t 3 If the message does not pass validation it is handled as a N AK, the associated recourse action is taken, and the message is archived in the error queue. If the message is a N AK, the associated recourse action is taken, and the message [...]

HL7 V3 Outbound T est Collabor ation For information, see “HL7 V2 Outbound Test Collaboration” on page 119 . Ack Message passed validation? journalMessage() Sends HL7 and Ack mesaages to JMS Journal Destination Nak Message Journal HL7 message processAckNakSequenceNumbering() Calculates the next sequence number and stores the number in the seque[...]

MLLP V2 and the Sample Projects Minimal Lower Layer Protocol Release 2 (MLLP V2.0) is a message transport protocol, and is required for all message transport protocols used to transport HL7 Version 3 content. This protocol wraps the HL7 message to indicate the beginning and end of each message. The following topics provide instruction on how to set[...]

d. Click OK. The database appears in the list of databases on the Services window. Make sure y our database instance is running. F or Oracle, DB2, SQL Server , and Sybase databases , do the following: a. Copy the database driv er le to JavaCAPS_H ome /appserver/lib . b . Under Databases on the NetBeans Services window , right- click Drivers and [...]

Note – A broken icon represents that the database is not connected. ▼ T o Run the MLLP V2.0 Da tabase S cripts You can either run the MLLP database scripts from N etBeans or from a SQL editor. The following steps take you through running the scripts from N etBeans. On the NetBeans IDE, click the Projects tab . Expand CAPS Components Library >[...]

This opens the SQL Editor window along with the SQL Statement. CREATE TABLE HL7MESSAGELOG (MESSAGEID VARCHAR(250), APPLICATIONID VARCHAR(250) , REQUESTMESSAGE CLOB, RESPONSEMESSAGE CLOB, STATUS SMALLINT, CREATEDTIME TIMESTAMP, LASTUPDATEDTIME TIMESTAMP) In the SQL Editor toolbar , click in the Connection eld and select the database connection fr[...]

T o view the new tables, return to the Services window , right- click the database connection, and then click Refresh. Expand the database connection and then T ables to view the database. ▼ T o Create the C onnec tion Pool and JDBC Resourc e In order to connect to the database, you need to dene a JD BC connection pool and JDB C resource using[...]

acknowledgement message. The MLLP V2 acknowledgement protocol is synchronous: the source system will not send new HL7 content until an acknowledgement for the previous HL7 content has been received. If the HL7 content (a query in the example below) triggers the sending of HL7 content (a response) by the destination system, then this HL7 content is [...]

In outbound mode, the message is sent to the sender and waits for the commit acknowledgement or negative acknowledgement from the receiver. If the adapter receives a negative acknowledgement, the message is sent again until the congured maximum number of retries is made. Standard Inbound HL7 V2 Collabor ation Over view ov er MLLPV2 In the MLLP V[...]

Is Sequence Numbering Enabled? receive(--) receive HL7 message, validate it and send HL7 ACK / NAK message YES Continue processInitialHandshake Send HL7 ACK/ NAK Inser tSequenceNumber Inser ts the next sequence n umber in the HL7 ACK/NAK receiveAndSend() Gets the HL7 message from the external , validates it and sends HL7 ACK/NAK Collobration gets t[...]

HL7 V2 Standard Inbound Message Mode Data F low over MLLPV2 — Par t 2 The Collaboration receives the HL7 V2 message from the external using receiveHL7message() . If an exception occurs due to incomplete data, and the adapter fails to read the data within the congured number of retries, the associated recourse action is taken. If the exception [...]

HL7 V2 Standard Inbound Message Mode Data F low over MLLPV2 — Par t 3 If no exception occurs, validateHL7Message() is called, which validates the message to determine whether to A CK or NAK the message. Other helper methods are also called to validate the HL7 message. If the HL7 message does not pass validation, the Collaboration calls makeNak() [...]

Continued journalHL7 Message() archiveError Message() Handle max Nak sent Condition/T ake recourse action Exit Recourse action if failed to journal HL7 Message passed V alidation? Journal HL7 Message? SendHL7NAK() Sends HL7 NAK SendHL7ACK() Sends HL7 ACK StoreHL7ACK() Stores HL7 ACK in the persistence database JournalMessage(). Sends HL7 and ACK me[...]