Sun Microsystems Sun Adapter forTCP/IPHL7 User Manual
  1. Manuals
  2. Brands
  3. Sun Microsystems Manuals
  4. Computer Hardware
  5. Sun Adapter forTCP/IPHL7
  6. User manual
Sun Microsystems Sun Adapter forTCP/IPHL7 User Manual

Sun Microsystems Sun Adapter forTCP/IPHL7 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Sun Adapter forTCP/IPHL7 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Sun Microsystems Sun Adapter forTCP/IPHL7

Summary of Contents for Sun Microsystems Sun Adapter forTCP/IPHL7

  • Page 1 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...
  • Page 2 X/Open Company, Ltd. Sun, Sun Microsystems, the Sun logo, the Solaris logo, the Java Coffee 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.

  • Page 3: Table Of Contents

    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 ........................
  • Page 4 Contents 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 —...
  • Page 5 Contents 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 —...

  • Page 7: Sun Adapter For Tcp/Ip Hl7 User's Guide

    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”...

  • Page 8: Sun Adapter For Tcp/Ip Hl7 Overview

    Sun Adapter for TCP/IP HL7 Overview 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 ■...
  • Page 9 Sun Adapter for TCP/IP HL7 Overview Throughout this document the term “JMS queue” is used in the generic sense and Note – 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 ■...

  • Page 10: About Hl7

    Sun Adapter for TCP/IP HL7 Overview The Message Library handles all of the lower-layer protocol. The Message Library’s behavior is customized using the Adapter configuration properties. These Adapter properties are used by the resource adapter, but are also accessed and used by the prebuilt Collaborations. About HL7 HL7 is a standard for exchanging information between medical applications and is an abbreviation of Health Level Seven.
  • Page 11 Sun Adapter for TCP/IP HL7 Overview If a system does not conform to the HL7 specification, the Collaborations can be modified for that transaction by changing the Java code using the Collaboration Editor. The Collaborations Java code is designed to be available and “transparent” so you can easily reference the predefined Java code to see how it currently handles HL7 transactions and make the appropriate modifications.

  • Page 12: Modes And Roles

    Sun Adapter for TCP/IP HL7 Overview Monitoring ■ The Enterprise Manager provides a real-time picture of the Adapter's state and status. The monitoring facilities display the following information: Adapter up or down ■ Connected to external ■ Current sequence number ■...
  • Page 13 Sun Adapter for TCP/IP HL7 Overview HL7 Adapter Sender Role The outbound Collaboration is the implementation of the Sender and the RA is configured for an outbound data flow. A Java CAPS Service forwards the data to the Adapter, which in turn forwards the data to the accepting HL7 external system.

  • Page 14: Inbound Functionality

    Sun Adapter for TCP/IP HL7 Overview 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 ACK to the Forwarder. 5. The Forwarder receives the ACK from the External and forwards it on to the Receiver. 6.
  • Page 15 Sun Adapter for TCP/IP HL7 Overview Standard Inbound Message Mode Data Flow and Architecture The following steps describe the flow of data for an inbound Adapter: 1. The external system sends the HL7 message to the Adapter. 2. The Collaboration receives the HL7 message. 3.
  • Page 16 Sun Adapter for TCP/IP HL7 Overview Message Verification Message verification 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 verification, it is considered bad data.

  • Page 17: Outbound Functionality

    Sun Adapter for TCP/IP HL7 Overview No response is received after a message is sent the maximum number of times. ■ Outbound Functionality The outbound TCP/IP HL7 Adapter Project, prjHL7Outbound, can be implemented in standard outbound mode or in two forward message modes: outbound delayed ACK or outbound forwarder.
  • Page 18 Sun Adapter for TCP/IP HL7 Overview 5. The Collaboration receives and validates the ACK, and then journals the ACK and the HL7 message (if journaling is enabled). If the Collaboration receives a NAK, the NAK and the HL7 message are sent to the error queue. 6.
  • Page 19 Sun Adapter for TCP/IP HL7 Overview For Delayed ACK, the Receiver and Forwarder must be on the same integration Note – server. Message Verification The only verification that the outbound Adapter does is to ensure that the message parses into the generic Event Message Library, and that the MSH uses the correct fields.

  • Page 20: General Functionality

    Sun Adapter for TCP/IP HL7 Overview The TCP/IP HL7 Adapter includes internal counters that keep track of all error Note – conditions. General Functionality This section explains the Adapter’s general functions and features. It includes the following topics: “Non-blocking I/O” on page 20 ■...
  • Page 21 Sun Adapter for TCP/IP HL7 Overview 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 Adapter and the external cannot be reconciled during start or when exchanging messages, the Adapter shuts down and wait for human intervention as dictated by the HL7 Standard.

  • Page 22: Tcp/Ip Hl7 Adapter Operation

    Sun Adapter for TCP/IP HL7 Overview The argument error message is the user-configured alert message. The argument HL7 is the source component (this must be “HL7”). The alerter.fatal("error msg", "HL7") method is only applicable to the packaged Note – TCP/IP HL7 Collaborations. The Exit recourse action should be applied to any error condition that requires human intervention to correct an error.
  • Page 23 Sun Adapter for TCP/IP HL7 Overview Lower Layer Protocol This section describes the two supported envelope types used in the HL7 protocol: HLLP (Hybrid Lower Layer Protocol) ■ MLLP (Minimal Lower Layer Protocol) ■ Both envelope types use the following configuration parameters. For more information on these parameters, see “Lower Layer Protocol —...

  • Page 24: Monitoring The Hl7 Adapter

    Sun Adapter for TCP/IP HL7 Overview It 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 Adapter or a database Adapter could periodically consume the messages by writing them to a file or a database.

  • Page 25: Schematron Support In The Hl7 Adapter

    Sun Adapter for TCP/IP HL7 Overview <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 Message Libraries. The Schematron uses the concept of finding tree patterns in the parsed document rather than the grammar.
  • Page 26 Sun Adapter for TCP/IP HL7 Overview In the HL7 Adapter, this schematron is useful for validating an HL7 V3 document against predefined schematron schemas that you write. You can also obtain schemas from organizations such as NHS and HL7.org. For example, NHS provides schemas for CDA documents.

  • Page 27: Adding And Configuring A Tcp/Ip Hl7 Adapter In A Connectivity Map

    Adding and Configuring a TCP/IP HL7 Adapter in a Connectivity Map Using the Schematron API Perform the following to invoke the schematron API from a Java Collaboration: Obtaining the Factory Object ■ Obtaining the Validator Object ■ Performing the Validation ■...

  • Page 28: Adding A Tcp/Ip Hl7 External Application To A Connectivity Map

    Adding and Configuring a TCP/IP HL7 Adapter in a Connectivity Map You can configure the TCP/IP HL7 Adapter properties in the following locations: Connectivity Map: These properties most commonly apply to a specific component ■ Adapter, and may vary from other Adapters of the same type in the Project. Environment Explorer: These properties are commonly global, applying to all Adapters of ■...

  • Page 29: Modifying The Tcp/Ip Hl7 Adapter Properties In The Connectivity Map

    Adding and Configuring a TCP/IP HL7 Adapter in a Connectivity Map Adapter Location FIGURE 1 Modify the Adapter properties, as described in “Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map”on page Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map You can modify an Adapter's properties after it is created in the Connectivity Map.

  • Page 30: Tcp/Ip Hl7 V2 Adapter Inbound Connectivity Map Properties

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties ▼ Modifying Adapter Properties in the Connectivity Map From the Connectivity Map, double-click the Adapter icon located in the link between the TCP/IP HL7 External Application and the Service. The Adapter Properties Editor appears, and displays either inbound or outbound properties depending on the link to the Service.

  • Page 31: General Inbound Settings - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties “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 Protocol — TCP/IP HL7 V2 Inbound Adapter” on page 41 ■...

  • Page 32: Tcpip Inbound Settings - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties TCPIP Inbound Settings — TCP/IP HL7 V2 Inbound Adapter 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 configure the Java socket and server socket options.
  • Page 33 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (Continued) TABLE 3 Name Description Keep Alive An indicator of whether the client’s SO_KEEPALIVE option is enabled or disabled. Select true to enable SO_KEEPALIVE; otherwise, select false. When the option is enabled for a TCP socket and no data has been exchanged across the socket in either direction for two hours, TCP automatically sends a KEEPALIVE probe to the peer (the actual value is implementation dependent).
  • Page 34 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (Continued) TABLE 3 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.

  • Page 35: Tcpip Inbound Settings - Server Port Binding - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties TCPIP Inbound Settings - Server Port Binding — TCP/IP HL7 V2 Inbound Adapter The following table lists and describes the properties that appear on the Server Port Binding page of the Properties Editor accessed from the Connectivity Map. The properties define the server port binding retry options.

  • Page 36: Tcpip Inbound Schedules - Listener Schedule - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings - Inbound Connection Management TABLE 6 Name Description Max Connection Pool The maximum number of concurrent connections allowed for the specific Size listener or monitor that is listening or monitoring the specified TCP/IP port. 0 (zero) indicates that there is no limit.
  • Page 37 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Timer Service – Available for Java EE, this scheduler is configured using the At Fixed Rate, ■ Delay, and Period properties. Work Manager – Available for Java EE (JCA 1.5 and above), this scheduler is configured ■...

  • Page 38: Tcpip Inbound Schedules - Service Schedule Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties TCPIP Inbound Schedules - Service Schedule TCP/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 configure the scheduler used by the TCP/IP server that executes the business tasks (Collaboration rules) over the existing connection.

  • Page 39: Hl7 Acknowledgment - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Schedules - Service Schedule (Continued) TABLE 8 Name Description At Fixed Rate An indicator of whether a fixed-rate execution or fixed-delay execution is used. This property applies to the Timer Service configuration only, and is used when the Schedule Type property is set to Repeated.

  • Page 40: Lower Layer Protocol - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 Acknowledgment (Continued) TABLE 9 Name Description eGate Sends App Acks An indicator of whether the HL7 application acknowledgment sent to the external system is generated by the adapter or forwarded from the application server.

  • Page 41: Sequence Number Protocol - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - Lower Layer Protocol (Continued) TABLE 10 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 conflict, the value should be ASCII FS (decimal 28).
  • Page 42 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 MSH Segment TABLE 12 Name Description Field Separator The character that separates the segment ID and the first real field. This value defines the character that is used as a separator for the rest of the message and is the first field in the HL7 MSH segment (MSH-01).
  • Page 43 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 MSH Segment (Continued) TABLE 12 Name Description Processing ID The subcomponent processing ID of the MSH-11 field. MSH-11 is used to indicate whether a message is processed as defined in the HL7 Application processing rules.

  • Page 44: Hl7 Sft Segment - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 MSH Segment (Continued) TABLE 12 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;...

  • Page 45: Communication Control - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 SFT Segment (Continued) TABLE 13 Name Description Software Certified The latest software version number or release number for the sending system, Version or Release which helps provide a more complete profile of the application that is sending or Number receiving HL7 messages.
  • Page 46 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - Communication Control TABLE 14 Name Description Time To Wait For A The amount of time (in milliseconds) that the adapter waits for a response from Response the external system before taking recourse action (see Action on No Response in HL7 Recourse Action).

  • Page 47: Hl7 Recourse Action - Tcp/Ip Hl7 V2 Inbound Adapter

    TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties HL7 Recourse Action — TCP/IP HL7 V2 Inbound Adapter The following table lists and describes the properties that appear on the HL7 Recourse Action page of the Properties Editor accessed from the Connectivity Map. These properties define the actions the adapter takes when operations occur outside the configured constraints.
  • Page 48 TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 Recourse Action (Continued) TABLE 15 Name Description Action on Nak Received The action the adapter takes when it receives an HL7 Application NAK from the external system. Select one of the following options: ■...

  • Page 49: Tcp/Ip Hl7 V2 Adapter Outbound Connectivity Map Properties

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties The TCP/IP HL7 V2 server outbound adapter configuration properties are organized into the following sections on the Properties Editor accessed from the Connectivity Map: “General Outbound Settings —...

  • Page 50: Tcpip Outbound Settings - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties TCPIP Outbound Settings — TCP/IP HL7 V2 Outbound Adapter 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 configure the Java socket and server socket options.
  • Page 51 TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (Continued) TABLE 17 Name Description Keep Alive An indicator of whether the client’s SO_KEEPALIVE option is enabled or disabled. Select true to enable SO_KEEPALIVE; otherwise, select false. When the option is enabled for a TCP socket and no data has been exchanged across the socket in either direction for two hours, TCP automatically sends a KEEPALIVE probe to the peer (the actual value is implementation dependent).
  • Page 52 TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (Continued) TABLE 17 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.

  • Page 53: Tcpip Outbound Settings - Client Connection Establishment - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (Continued) TABLE 17 Name Description Socket Factory The name of the Java class that implements the socket factory. This class is used to Implementation Class create the socket. If you have provided your own socket implementation, enter Name the name of the Java class that contains this implementation here.

  • Page 54: Tcpip Outbound Settings - Server Port Binding - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings - Client Connection Establishment TABLE 18 (Continued) Name Description Auto Reconnect Upon An indicator or whether to attempt to reconnect automatically when the adapter Matching Failure gets a matching connection from a container, even though this connection is not valid;...

  • Page 55: Hl7 Acknowledgment - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties HL7 Acknowledgment — TCP/IP HL7 V2 Outbound Adapter The following table lists and describes the properties that appear on the HL7 Acknowledgment page of the Properties Editor accessed from the Connectivity Map. These properties define how the application acknowledgment events are handled.

  • Page 56: Sequence Number Protocol - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - Lower Layer Protocol TABLE 21 Name Description LLP Type MLLP is the configured default value. The lower layer protocol (LLP) type. Select one of the following options: ■ MLLP (Minimal Lower Layer Protocol) ■...

  • Page 57: Hl7 Msh Segment - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties HL7 MSH Segment — TCP/IP HL7 V2 Outbound Adapter 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 define the configuration of the MSH segment of the HL7 message.
  • Page 58 TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7 MSH Segment (Continued) TABLE 23 Name Description Receiving Facility A user-defined value that further identifies the receiving application among multiple identical instances of the application running on behalf of different organizations.

  • Page 59: Hl7 Sft Segment - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7 MSH Segment (Continued) TABLE 23 Name Description Conformance Statement A unique identifier that applies to a query’s conformance statement. It can also be used as a Message Profile Identifier to assert constancy with a message profile (grammar, syntax, usage, and so on).

  • Page 60: Communication Control - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7 SFT Segment (Continued) TABLE 24 Name Description Software Certified The latest software version number or release number for the sending system, Version or Release which helps provide a more complete profile of the application that is sending or Number receiving HL7 messages.
  • Page 61 TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - Communication Control TABLE 25 Name Description Time To Wait For A 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 Response HL7 Recourse Action).

  • Page 62: Hl7 Recourse Action - Tcp/Ip Hl7 V2 Outbound Adapter

    TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties HL7 Recourse Action — TCP/IP HL7 V2 Outbound Adapter The following table lists and describes the properties that appear on the HL7 Recourse Action page of the Properties Editor accessed from the Connectivity Map. These properties define the actions the adapter takes when operations occur outside the configured constraints.
  • Page 63 TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7 Recourse Action (Continued) TABLE 26 Name Description Action on Nak Received The action the adapter takes when it receives an HL7 Application NAK from the external system. Select one of the following options: ■...

  • Page 64: Tcp/Ip Hl7 V3 Adapter Inbound Connectivity Map Properties

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties The TCP/IP HL7 V3 Server inbound adapter configuration properties are organized into the following sections on the Properties Editor accessed from the Connectivity Map: “General Inbound Settings —...

  • Page 65: Tcpip Inbound Settings - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - General Inbound Settings (V3) (Continued) TABLE 27 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: ■...
  • Page 66 TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (V3) (Continued) TABLE 28 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 infinite timeout.
  • Page 67 TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (V3) (Continued) TABLE 28 Name Description Receive Buffer Size A number indicating the receive buffer size. This is the value of the SO_RCVBUF option for the current socket, which is the buffer size used by the operating system for input on this socket.

  • Page 68: Tcpip Inbound Settings - Server Port Binding - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (V3) (Continued) TABLE 28 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 infinite.

  • Page 69: Tcpip Inbound Settings - Client Connection Establishment - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties TCPIP Inbound Settings - Client Connection Establishment — TCP/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 defines a wait time before connecting to the external system.

  • Page 70: Tcpip Inbound Schedules - Listener Schedule - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Settings (V3) - Inbound Connection Management TABLE 31 (Continued) Name Description Scope Of Connection The scope of the accepted connection that is used by the adapter. Select one of the following options: ■...

  • Page 71: Tcpip Inbound Schedules - Service Schedule - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Schedules (V3) - Listener Schedule TABLE 32 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.
  • Page 72 TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties scheduler used by the TCP/IP server that executes the business tasks (Collaboration rules) over the existing connection. This scheduler affects the actual business rules you define. You can use either of the following two Java EE schedulers, both of which provide the functionality required by the inbound TCP/IP server.

  • Page 73: Hl7 Acknowledgment - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - TCPIP Inbound Schedules (V3) - Service Schedule (Continued) TABLE 33 Name Description At Fixed Rate An indicator of whether a fixed-rate execution or fixed-delay execution is used. This property applies to the Timer Service configuration only, and is used when the Schedule Type property is set to Repeated.

  • Page 74: Sequence Number Protocol - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - Lower Layer Protocol (V3) TABLE 35 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”...

  • Page 75: Communication Control - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties needs to package and route the message to the specified receiving applications or message handling services. The transmission wrapper is a cluster of classes and identifies the sender and receiver of the message and the particular kind of message being communicated. Connectivity Map - HL7v3 Transmission Wrapper TABLE 37 Name...
  • Page 76 TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - Communication Control (V3) TABLE 38 Name Description Time To Wait For A The amount of time (in milliseconds) that the adapter waits for a response from Response the external system before taking recourse action (see Action on No Response in HL7 Recourse Action).

  • Page 77: Hl7 Recourse Action - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties HL7 Recourse Action — TCP/IP HL7 V3 Inbound Adapter The following table lists and describes the properties that appear on the HL7 Recourse Action page of the Properties Editor accessed from the Connectivity Map. These properties define the actions the adapter takes when operations occur outside the configured constraints.
  • Page 78 TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties Connectivity Map - HL7 Recourse Action (V3) (Continued) TABLE 39 Name Description Action on Nak Received The action the adapter takes when it receives an HL7 Application NAK from the external system. Select one of the following options: ■...

  • Page 79: Schematron Validation - Tcp/Ip Hl7 V3 Inbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Schematron Validation — TCP/IP HL7 V3 Inbound Adapter 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 finding tree patterns in a parsed document rather than grammar patterns.

  • Page 80: General Outbound Settings - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties 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.
  • Page 81 TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (V3) TABLE 42 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.
  • Page 82 TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (V3) (Continued) TABLE 42 Name Description Receive Buffer Size A number indicating the receive buffer size. This is the value of the SO_RCVBUF option for the current socket, which is the buffer size used by the operating system for input on this socket.

  • Page 83: Tcpip Outbound Settings - Client Connection Establishment - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (V3) (Continued) TABLE 42 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 infinite. With this option set to a non-zero value, calling the read() method on the input stream associated with this socket will block for only the configured length of time.

  • Page 84: Tcpip Outbound Settings - Server Port Binding - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (V3) - Client Connection Establishment TABLE 43 (Continued) Name Description Always Create New An indicator of whether the adapter always attempts to create a new connection Connection when a connection establishment request is received.

  • Page 85: Hl7 Acknowledgment - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - TCPIP Outbound Settings (V3) - Server Port Binding (Continued) TABLE 44 Name Description Retry Binding Interval The amount of time (in milliseconds) that the adapter waits between attempts to bind to the specified TCP/IP port on the localhost.

  • Page 86: Sequence Number Protocol - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - Lower Layer Protocol (V3) (Continued) TABLE 46 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 conflict, the value should be ASCII FS (decimal 28).

  • Page 87: Communication Control - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7v3 Transmission Wrapper TABLE 48 Name Description Interaction ID The identification of the unique information interchange. The attribute values are derived from the HL7 MDF interaction names; for example, POLB_INI00100 and COMT_IN300652.
  • Page 88 TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - Communication Control (V3) TABLE 49 Name Description Time To Wait For A The amount of time (in milliseconds) that the adapter waits for a response from Response the external system before taking recourse action (see Action on No Response in HL7 Recourse Action).

  • Page 89: Hl7 Recourse Action - Tcp/Ip Hl7 V3 Outbound Adapter

    TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties HL7 Recourse Action — TCP/IP HL7 V3 Outbound Adapter The following table lists and describes the properties that appear on the HL7 Recourse Action page of the Properties Editor accessed from the Connectivity Map. These properties define the actions the adapter takes when operations occur outside the configured constraints.
  • Page 90 TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties Connectivity Map - HL7 Recourse Action (V3) (Continued) TABLE 50 Name Description Action on Nak Received The action the adapter takes when it receives an HL7 Application NAK from the external system. Select one of the following options: ■...

  • Page 91: Configuring Sun Adapter For Tcp/Ip Hl7 Environment Properties

    Configuring Sun Adapter for TCP/IP HL7 Environment Properties Configuring Sun Adapter for TCP/IP HL7 Environment Properties The adapter environment configuration properties define how the adapter connects to and interacts with other Java CAPS components within the environment. The environment properties are accessed from the NetBeans IDE Services window. The following sections provide instructions on how to configure Java CAPS component environment properties and lists the environment properties for the various communications adapters.

  • Page 92: Tcp/Ip Hl7 Inbound Adapter Environment Properties

    Configuring Sun Adapter for TCP/IP HL7 Environment Properties TCP/IP HL7 Inbound Adapter Environment Properties The TCP/IP HL7 Adapter configuration parameters accessed from the Environment tree apply to both the inbound and outbound Adapters, and are the same for HL7 v2 and HL7 v3 Adapters.
  • Page 93 Configuring Sun Adapter for TCP/IP HL7 Environment Properties Environment - HL7 Inbound Adapter - TCPIP Inbound Settings TABLE 52 Name Description Steady Pool 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 specified number and tries to ensure that there are always this number of beans in the free pool.

  • Page 94: Tcp/Ip Hl7 Inbound Adapter Environment Properties

    Configuring Sun Adapter for TCP/IP HL7 Environment Properties Environment - HL7 Inbound Adapter - Sequence Number Protocol TABLE 53 Name Description Sequence Number File The location of the sequence number file (a local directory). This is required when Location the Sequence Number Protocol is enabled. The sequence number folder is a nonvolatile directory that stores the sequence number files used to persist the HL7 sequence number.
  • Page 95 Configuring Sun Adapter for TCP/IP HL7 Environment Properties HL7 Outbound Adapter - TCPIP Outbound Settings The following table lists and describes the properties that appear on the MDB Pool Setting page of the Properties Editor accessed from the Environment. These properties configure the Java socket and server socket options.
  • Page 96 Configuring Sun Adapter for TCP/IP HL7 Environment Properties Environment - HL7 Outbound Adapter - Connection Pool Settings TABLE 56 Name Description Steady Pool 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 specified number and tries to ensure that there are always this many connections in the free pool.

  • Page 97: Using The Tcp/Ip Hl7 Predefined Templates

    Using the TCP/IP HL7 Predefined Templates Environment - HL7 Outbound Adapter - Sequence Number Protocol TABLE 57 Name Description Sequence Number File The location of the sequence number file (a local directory). This is required when the Sequence Number Protocol is enabled. The sequence number folder is a Location nonvolatile directory that stores the sequence number files used to persist the HL7 sequence number.

  • Page 98: Creating A Copy Of An Hl7 Sample Project

    Using the TCP/IP HL7 Predefined Templates Collaborations. Therefore, it is important to maintain the original predefined 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 files are uploaded to the repository.
  • Page 99 Using the TCP/IP HL7 Predefined Templates 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 Manager dialog box appears. Export Manager FIGURE 2 b. Select the Projects and Environments to export. The selected Project appears in the Selected Projects: pane of the Export Manager.
  • Page 100 Using the TCP/IP HL7 Predefined Templates Click the left-arrow button , if you want to move the selected projects from the right Tip – pane to the left pane. d. Click Browse and select an appropriate directory to save the exported Project. Export Manager —...
  • Page 101 Using the TCP/IP HL7 Predefined Templates The NetBeans IDE will not import identically named Projects to the same root, so you Note – must perform this step before importing the Project back in. On the NetBeans IDE, click Save All. Import the Project back in to the Repository.

  • Page 102: Customizing Predefined Collaborations For Hl7

    Using the TCP/IP HL7 Predefined Templates d. Click Import. It 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.
  • Page 103 Using the TCP/IP HL7 Predefined Templates Collaboration — Copied to Project Tree FIGURE 4 Repeat this step for additional copies of the Collaboration. To add each new Collaboration to a Project's Connectivity Map, drag and drop the Collaboration from the Projects Explorer tree to the Connectivity Map Editor. The new Collaborations can now be associated with the Project's components.

  • Page 104: Adding An Hl7 Message Library To An Existing Collaboration

    Using the TCP/IP HL7 Predefined Templates Connectivity Map — Newly Added Collaborations FIGURE 5 Adding an HL7 Message Library to an Existing Collaboration In some cases, a specific HL7 message or messages might need to be added to the Collaboration. Perform the following to add a HL7 Message Library to an existing Collaboration.
  • Page 105 Using the TCP/IP HL7 Predefined Templates Collaboration Definition (Java) Properties FIGURE 6 Click Add to select the object type definition. A dialog box appears where you can select the Message Library to add. Sun Adapter for TCP/IP HL7 User's Guide...
  • Page 106 Using the TCP/IP HL7 Predefined Templates Select Object Type Definition FIGURE 7 In the Look In field, navigate to the location of the Message Library. The HL7 Message Libraries are located in CAPS Components Library > Message Library > HL7. Select the Message Library and then click Select.

  • Page 107: About Tcp/Ip Hl7 V2 Collaborations

    About TCP/IP HL7 V2 Collaborations Message Library Added to the List FIGURE 8 You can also modify an existing HL7 V2 Message Library by clicking the Message Library Tip – to change, clicking the ellipsis that appears, and selecting the appropriate Message Library. On the Collaboration Definition Properties dialog box, click OK.

  • Page 108: Tcp/Ip Hl7 V2 Adapter Projects Overview

    About TCP/IP HL7 V2 Collaborations The following topics provide information about the sample V2 Collaborations and provide instructions for copying and customizing them: “TCP/IP HL7 V2 Adapter Projects Overview” on page 108 ■ “TCP/IP HL7 V2 Adapter Collaborations” on page 108 ■...

  • Page 109: Inbound Hl7 V2 Collaboration Overview

    About TCP/IP HL7 V2 Collaborations At the end of each action, the state is set for the next execution of the Collaboration. There are three main states: To Establish: A new or reset connection needs to have an HL7 session established. If ■...
  • Page 110 About TCP/IP HL7 V2 Collaborations 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 The above text has been wrapped to fit the page. Note – Once the message is received, the Collaboration determines whether the message needs to be validated.
  • Page 111 About TCP/IP HL7 V2 Collaborations 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 (...) Receive is the entry point to the HL7 User receive HL7 message from Collaboration;...
  • Page 112 About TCP/IP HL7 V2 Collaborations Inbound HL7 V2 Collaboration - Part 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 configured number of retries, the associated recourse action is taken. If the exception is due to no response, the associated recourse action is taken.
  • Page 113 About TCP/IP HL7 V2 Collaborations Continued receiveAndSend() Gets the HL7 Message from External and validates it and sends Ack/Nak receiveHL7Message() receives the HL7 Message from External Handle Max Calls other Failed Read Exception helper methods Exception due to Retry/Take occurred? incomplete data? to validate the Recourse...

  • Page 114: Outbound Hl7 V2 Collaboration Overview

    About TCP/IP HL7 V2 Collaborations Inbound HL7 V2 Collaboration - Part 3 After the ACK is sent, the HL7 V2 message and the ACK 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 number in the sequence number file by calling the updateSequenceNumberFile method to persist the next sequence number.
  • Page 115 About TCP/IP HL7 V2 Collaborations The following topics describe the business logic defined 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 ■...
  • Page 116 About TCP/IP HL7 V2 Collaborations Collaboration gets triggered by a JMS HL7 message; it then calls HL7 User Collaboration Rule by executing the receive() method Handle No Response Error/ receive (...) Receive is the entry point Take Recourse send HL7 message to to the HL7 User Action external HL7 system and...
  • Page 117 About TCP/IP HL7 V2 Collaborations Outbound HL7 V2 Collaboration - Part 2 The Collaboration receives the HL7 ACK or NAK from the external system using receiveHL7AckNak(). If an exception occurs due to incomplete data and the adapter fails to read the data within the configured number of retries, the associated recourse action is taken. If the exception is due to no response, the associated recourse action is taken.
  • Page 118 About TCP/IP HL7 V2 Collaborations Continued receiveHL7AckNak() Get the HL7 ACK message from External Handle Max Failed Exception Exception Read due to incomplete Retry/Take occurred? data? Recourse Action isAckMessage() Validates Handle No message and determines if Response message is ACK or NAK Error/Take Recourse Calls other helper...
  • Page 119 About TCP/IP HL7 V2 Collaborations Outbound HL7 V2 Collaboration - Part 3 If the ACK 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 stores the number in the sequence number file, calling updateSequenceNumberFile to persist the next sequence number.

  • Page 120: About Tcp/Ip Hl7 V3 Collaborations

    About TCP/IP HL7 V3 Collaborations About TCP/IP HL7 V3 Collaborations The following topics provide a brief overview of HL7 V3, and describe the HL7 V3 Collaborations and provide instructions on copying and customizing the Collaborations: “About HL7 V3” on page 120 ■...

  • Page 121: Tcp/Ip Hl7 V3 Adapter Projects Overview

    About TCP/IP HL7 V3 Collaborations The V3 standard also includes interactions, such as Create Patient Billing Account. There are three modes of Acknowledgement process in HL7 V3: Immediate Mode ■ Deferred Mode ■ Queued Mode ■ TCP/IP HL7 V3 Adapter Projects Overview Several HL7 V3 sample Projects are provided with the TCP/IP HL7 Adapter to illustrate different scenarios for connecting with external HL7 systems.

  • Page 122: Inbound Hl7 V3 Immediate Collaboration Overview

    About TCP/IP HL7 V3 Collaborations 1. Inbound HL7 V3 Immediate Collaboration 2. Inbound HL7 V3 Deferred Collaboration 3. Inbound HL7 V3 Queue Manager 4. Inbound HL7 V3 Message Publisher Inbound HL7 V3 Immediate Collaboration Overview The Inbound HL7 V3 Collaboration, jcdHL7V3Inbound, contains Message Libraries for the HL7 V3 Resource Adapter, JMS Data, JMS Journal, and JMS Error, as well as the HL7 V3 Patient Administration Domain Interaction Event (PRPA_IN403001UV01) and the corresponding HL7 V3 Acknowledgements (MCCI_IN000004UV01).
  • Page 123 About TCP/IP HL7 V3 Collaborations The above text has been wrapped to fit the page. Note – Sun Adapter for TCP/IP HL7 User's Guide...
  • Page 124 About TCP/IP HL7 V3 Collaborations Collobration gets triggered by a hl7 v3 PRPA_IN403001UV01 message received from HL7 client,it then calls HL7 user colloboration rules by exceuting the receive method. Receive is the entry point to the HL7 user receive(--) receive HL7 v3 collaboration, it has the following PRPA_IN403001UV01 message, signature.receive(HL7eway,...
  • Page 125 About TCP/IP HL7 V3 Collaborations Version Code, Processing Code, Processing Mode Code, and Interaction ID. If these fields do not match the configuration, a NAK 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 configured number of retries, the associated recourse action is taken.
  • Page 126 About TCP/IP HL7 V3 Collaborations Continued validateHL7Message() Calls other helper methoss Validates V3 message and to validate HL7 v3 determines if it should send message ACK/NAK SendHL7NAK() HL7 V3 Sends HL7 v3 archive Message (MCCI_IN000004UV01) ErrorMessage() passed immediate Validation? NAK message Calls other helper Handle max methods(makeNAK())

  • Page 127: Inbound Hl7 V3 Deferred Collaboration Overview

    About TCP/IP HL7 V3 Collaborations Inbound HL7 V3 Deferred Collaboration Overview The Inbound HL7 V3 Collaboration, jcdHL7V3DeferredInbound, contains Message Libraries for the HL7 V3 Resource Adapter, JMS Data, JMS Journal, JMS Error, and JMS APP ACK as well as the HL7 V3 Patient Administration Domain Interaction Event (PRPA_IN403001UV01) and the corresponding HL7 V3 Commit Acknowledgement (MCCI_IN000006UV01) and Application Acknowledgement (MCCI_IN000007UV01).
  • Page 128 About TCP/IP HL7 V3 Collaborations otdHL7_ACK_1,com.stc.connectors.jms.JMS otdJMS_JOURNAL, com.stc.connectors.jms.JMS otdJMS_ERROR) throws Throwable. The above text is wrapped to fit the page. Note – 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.
  • Page 129 About TCP/IP HL7 V3 Collaborations Collobration gets triggered by a hl7 v3 PRPA_IN403001UV01 message received from HL7 client,it then calls HL7 user colloboration rules by exceuting the receive method. Receive is the entry point to the HL7 user receive(--) receive HL7 v3 collaboration, it has the following signature.
  • Page 130 About TCP/IP HL7 V3 Collaborations HL7 V3 Standard Inbound Message Mode Data Flow (For Deferred Mode of ACK Process) — Part 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 configured number of retries, the associated recourse action is taken.
  • Page 131 About TCP/IP HL7 V3 Collaborations Continued receiveAndSend() Gets the HL7 v3 message from the external , validates it and sends ACK/NAK receiveHL7Message() receives the HL7 v3 message from the external Handle Max Exception Failed read Exception Calls other helper methods to retry.Take occurred? to incomplete...
  • Page 132 About TCP/IP HL7 V3 Collaborations HL7 V3 Standard Inbound Message Mode Data Flow (For Deferred Mode of ACK Process) — Part 3 After the Commit ACK is sent and the Application ACK is stored in JMS, the HL7 V3 message and the ACKs are journaled to the JMS queue journal destination.

  • Page 133: Outbound Hl7 V3 Collaboration Overview

    About TCP/IP HL7 V3 Collaborations Continued HL7 V3 Message validation passed sequence Validate Sequence numbering Number processSequenceNumbering() enabled SendHL7NAK() Sends HL7 v3 (MCCI_IN000006UV01) commit NAK message if SendHL7CommitAck() Is Correct accept ack is required or send expected and journalHL7AppAck() HL7 v3 Application NAK sequence Sends HL7 V3(MCCI_IN000006UV01) number...
  • Page 134 About TCP/IP HL7 V3 Collaborations corresponding HL7 V3 Acknowledgements. MCCI_IN000004UV01 for Immediate Mode and MCCI_IN000006UV01 for Deferred Mode. The Collaboration works with its own internal code and the Properties Configuration files. The outbound Collaboration assumes that it is reading valid HL7 V3 messages, so the data flow that feeds this Collaboration must ensure this. The Outbound Collaboration is for both immediate and deferred mode.
  • Page 135 About TCP/IP HL7 V3 Collaborations Collaboration gets triggered by JMS HL7 message. It then calls HL7 user collaboration rule by executing the receive method. Handle receive(--) Receive is the entry point to the validation error. HL7 user collaboration, it has the Take recourse send HL7 message to external following signature.
  • Page 136 About TCP/IP HL7 V3 Collaborations HL7 V3 Standard Outbound Message Mode Data Flow (For Immediate and Deferred Mode of ACK Process) — Part 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().
  • Page 137 About TCP/IP HL7 V3 Collaborations Continued InsertSequenceNumber() Only if sequence numbering is enabled and ACK process insert the next sequence number is deferred Mode 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...
  • Page 138 About TCP/IP HL7 V3 Collaborations HL7 V3 Standard Outbound Message Mode Data Flow (For Immediate and Deferred Mode of ACK Process) — Part 3 If the message does not pass validation it is handled as a NAK, the associated recourse action is taken, and the message is archived in the error queue.
  • Page 139 About TCP/IP HL7 V3 Collaborations Continued Message passed validation? Handle Nak Condition. Take recourse action Message Can result in archiving the HL7 messge/with Nak in the Error Queue Journal HL7 message journalMessage() Exit recourse action if failed Sends HL7 and Ack mesaages to journal to JMS Journal Destination JMS Message...

  • Page 140: Mllp V2 And The Sample Projects

    MLLP V2 and the Sample Projects 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.
  • Page 141 MLLP V2 and the Sample Projects 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 Server, and Sybase databases, do the following: a. Copy the database driver file to JavaCAPS_Home/appserver/lib. b.
  • Page 142 MLLP V2 and the Sample Projects A broken icon represents that the database is not connected. Note – ▼ To Run the MLLP V2.0 Database Scripts You can either run the MLLP database scripts from NetBeans or from a SQL editor. The following steps take you through running the scripts from NetBeans.
  • Page 143 MLLP V2 and the Sample Projects 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 field and select the database connection from the drop-down list.

  • Page 144: Mllp V2 Content Exchange Model

    MLLP V2 and the Sample Projects To view the new tables, return to the Services window, right-click the database connection, and then click Refresh. Expand the database connection and then Tables to view the database. ▼ To Create the Connection Pool and JDBC Resource In order to connect to the database, you need to define a JDBC connection pool and JDBC resource using the GlassFish Admin Console or the command-line interface.
  • Page 145 MLLP V2 and the Sample Projects 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. HL7 Query/Response Source/Destination Destination/Source HL7 Content: Query() Commit Acknowledgement() HL7 Content: Query() Commit Acknowledgement()

  • Page 146: Standard Inbound Hl7 V2 Collaboration Overview Over Mllpv2

    MLLP V2 and the Sample Projects 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 configured maximum number of retries is made.
  • Page 147 MLLP V2 and the Sample Projects Collobration gets triggered by a hl7 message received from HL7 client,it then calls HL7 user colloboration rules by exceuting the receive method. Receive is the entry point to the HL7 user receive(--) collaboration, it has the following signature. receive HL7 message, validate it receive( HL7ServerApplication input, JMS and send HL7...
  • Page 148 MLLP V2 and the Sample Projects HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 — Part 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 configured number of retries, the associated recourse action is taken.
  • Page 149 MLLP V2 and the Sample Projects HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 — Part 3 If no exception occurs, validateHL7Message() is called, which validates the message to determine whether to ACK or NAK the message. Other helper methods are also called to validate the HL7 message.
  • Page 150 MLLP V2 and the Sample Projects Continued Calls other helper methods to makeNAK and send it StoreHL7NAK() SendHL7NAK() archiveError Stores HL7 NAK in Message passed Sends HL7 NAK Message() Persistence Database Validation? SendHL7ACK() Handle max Nak Sends HL7 ACK sent Condition/Take recourse action StoreHL7ACK() This is to store the HL7 ACK in the...

Table of Contents