Sun Microsystems IP HL 7, TCP manual

Sun Adapter forTCP/IP HL7

User's Guide

SunMicrosystems, Inc.

4150Network Circle

SantaClara, CA 95054

U.S.A.

PartNo:821–0377–10

October2009

Contents

Main Page Contents Page Page Page Sun Adapter forTCP/IP HL7 User's Guide Sun Adapterfor TCP/IP HL7 Overview About Sun Adapterfor TCP/IP HL7 TCP/IPHL7 Features TCP/IPHL7 Adapter Components About HL7 TheTCP/IP HL7 Adapter Architecture TCP/IPHL7 Resource Adapter HL7Collaborations GenericHL7 Message Libraries SunJava Composite Application Suite Functionality Modes and Roles StandardMode HL7Adapter Sender Role HL7Adapter Receiver Role DelayedACK Mode Inbound Functionality InboundAdapter Data Flow StandardInbound Message Mode Data Flow and Architecture InboundReceiver Message Mode MessageVerication AcknowledgmentProcessing Outbound Functionality OutboundAdapter Data Flow OutboundStandard Messaging Mode OutboundAdapter Roles for Delayed ACK Scenarios OutboundDelayed ACK Role OutboundForwarder Role MessageVerication AcknowledgmentProcessing GeneralFunctionality Non-blockingI/O HL7Sequence Numbering Protocol FailedMessage Handling Stoppingthe Collaboration with a Fatal Alert TCP/IPHL7 Adapter Operation Direction ConnectionType LowerLayer Protoco l MLLP HLLP HL7Acknowledgment Level Journaling Monitoringthe HL7 Adapter SchematronSuppor t in the HL7 Adapter SchematronConguration in HL7 Adapter APIfor Schematron Validation Usingthe Schematron API Obtainingthe Factory Object Obtainingthe Validator Object Addingand Conguring a TCP/IP HL7 Adapter in a Connectivity Map Addinga TCP/IP HL7 External Application to a Connectivity Map ToAdd aTCP/IP HL7 External Application Modifying theTCP/IP HL7 Adapter Properties in the Connectivity Map ModifyingAdapter Properties in the Connectivity Map TCP/IPHL7 V2 Adapter Inbound Connectivity Map Properties GeneralInbound S ettings TCP/IP HL7 V2 Inbound TCPIPInbound Settings TCP/IP HL7 V2 Inbound Page Page Page TCPIPInbound Schedules - Listener Schedule TCP/IPHL7 V2 Inbound Adapter Delay,and Period properties. usingthe Delay and Period properties. TCPIPInbound Schedules - Ser vice ScheduleTCP/IP HL7V2 Inbound Adapter HL7 Acknowledgment TCP/IP HL7 V2 Inbound LowerLayer Protocol TCP/IP HL7V2 Inbound Sequence Number Protocol TCP/IP HL7 V2 Inbound HL7 MSH Segment TCP/IP HL7 V2 Inbound Adapter Page Page HL7 SFT Segment TCP/IP HL7 V2 Inbound Adapter CommunicationControl TCP/IP HL7 V2 Inbound Thefollowing table lists and describes the properties that appears on the Communication Page HL7 RecourseAc tion TCP/IP HL7 V2 Inbound Page TCP/IPHL7 V2 Adapter Outbound Connectivity Map GeneralO utbound Settings TCP/IP HL7 V2 TCPIPOutbound Settings TCP/IP HL7 V2 Outbound Page Page TCPIPOutbound Settings - Client Connection Establishment TCP/IP HL7 V2 Outbound Adapter (Continued) TCPIPOutbound Settings - S erver Port Binding TCP/IPHL7 V2 Outbound Adapter TCPIPOutbound Settings is set to Server. HL7 Acknowledgment TCP/IP HL7 V2 Outbound LowerLayer Protocol TCP/IP HL7V2 Outbound Sequence Number Protocol TCP/IP HL7 V2 HL7 MSH Segment TCP/IP HL7 V2 Outbound Thefollowing table lists and describes the properties that appear on the HL7 MSH Segment Page HL7 SFT Segment TCP/IP HL7 V2 Outbound Adapter Note The SFT segment is available starting with HL7 version 2.5. CommunicationControl TCP/IP HL7 V2 Outbound Thefollowing table lists and describes the properties that appear on the Communication Page HL7 RecourseAc tion TCP/IP HL7 V2 Outbound Page TCP/IPHL7 V3 Adapter Inbound Connectivity Map Properties GeneralInbound S ettings TCP/IP HL7 V3 Inbound TCPIPInbound Settings TCP/IP HL7 V3 Inbound Page Page TCPIPInbound Settings - Ser verPort Binding TCP/IPHL7 V3 Inbound Adapter TCPIPInbound Settings is set to Server. TCPIPInbound Settings - Client Connection Establishment TCP/IP HL7 V3 Inbound Adapter TCPIPInbound Settings - Inbound Connection Management TCP/IP HL7 V3 Inbound Adapter TCPIPInbound Schedules - Listener Schedule TCP/IPHL7 V3 Inbound Adapter TCPIPInbound Schedules - Ser vice Schedule TCP/IP HL7V3 Inbound Adapter Page HL7 Acknowledgment TCP/IP HL7 V3 Inbound LowerLayer Protocol TCP/IP HL7V3 Inbound Sequence Number Protocol TCP/IP HL7 V3 Inbound HL7v3Transmission Wrapper TCP/IP HL7 V3 Inbound Adapter CommunicationControl TCP/IP HL7 V3 Inbound Thefollowing table lists and describes the properties that appears on the Communication Page HL7 RecourseAc tion TCP/IP HL7 V3 Inbound Page SchematronValidation TCP/IP HL7V3 Inbound TCP/IPHL7 V3 Adapter Outbound Connectivity Map GeneralO utbound Settings TCP/IP HL7 V3 TCPIPOutbound Settings TCP/IP HL7 V3 Outbound Page Page TCPIPOutbound Settings - Client Connection Establishment TCP/IP HL7 V3 Outbound Adapter (Continued) TCPIPOutbound Settings - S erver Port Binding TCP/IPHL7 V3 Outbound Adapter TCPIPOutbound Settings is set to Server. HL7 Acknowledgment TCP/IP HL7 V3 Outbound LowerLayer Protocol TCP/IP HL7V3 Outbound Sequence Number Protocol TCP/IP HL7 V3 HL7v3Transmission Wrapper TCP/IP HL7 V3 CommunicationControl TCP/IP HL7 V3 Outbound Thefollowing table lists and describes the properties that appear on the Communication Page HL7 RecourseAc tion TCP/IP HL7 V3 Outbound Page ConguringSun Adapter for TCP/IP HL7 Environment ConguringTCP/IP HL7 Adapter Environment Properties ToCongure the EnvironmentProper ties TCP/IPHL7 Inbound Adapter Environment Properties HL7Inbound Adapter - TCPIP Inbound Settings HL7Inbound Adapter - MDB Pool Settings HL7Inbound Adapter - Sequence Number Protocol HL7Inbound Adapter - Database Settings TCP/IPHL7 Inbound Adapter Environment Properties HL7Outbound Adapter - TCPIP Outbound Settings HL7Outbound Adapter - Connection Pool Settings HL7Outbound Adapter - Sequence Number Protocol Usingthe TCP/IP HL7 Predened Templates Prerequisitesfor the HL7 V3 Sample Projects Creatinga Copy of an HL7 Sample Project ToCreate a Copyof a Project Page Page Page CustomizingPredened Collaborations for HL7 CreatingCopies of HL7 Collaborations ToCreate Copies of HL7 Collaborations Page Addingan HL7 Message Librar y toan Existing Collaboration ToAdd HL7 Message Library to an Existing Collaboration Page Page AboutTCP/IP HL7 V2 Collaborations TCP/IPHL7 V2 Adapter Projects Overview TCP/IPHL7 V2 Adapter Collaborations Inbound HL7V2 Collaboration Overview InboundHL7 V2 Collaboration - Part 1 Page Page InboundHL7 V2 Collaboration - Part 2 Page InboundHL7 V2 Collaboration - Part 3 Outbound HL7V2 Collaboration Overview OutboundHL7 V2 Collaboration - Part 1 Page OutboundHL7 V2 Collaboration - Part 2 Page OutboundHL7 V2 Collaboration - Part 3 HL7V2 Outbound TestCollaboration AboutTCP/IP HL7 V3 Collaborations About HL7 V3 TCP/IPHL7 V3 Adapter Projects Overview TCP/IPHL7 V3 Adapter Collaborations Inbound HL7V3 Immediate Collaboration Overview HL7V3 Standard Inbound Message Mode Data Flow (For Immediate Modeof ACK Process) Part 1 Page Page HL7V3 Standard Inbound Message Mode Data Flow (For Immediate Modeof ACK Process) Part 2 Page Inbound HL7V3 Deferred Collaboration Overview HL7V3 Standard Inbound Message Mode Data Flow (For Deferred Modeof ACK Process) Part 1 Page Page HL7V3 Standard Inbound Message Mode Data Flow (For Deferred Modeof ACK Process) Part 2 Page Page Outbound HL7V3 Collaboration Overview andDeferred Mode of ACK Process) Part 1 Page andDeferred Mode of ACK Process) Part 2 YES YES NO NO andDeferred Mode of ACK Process) Part 3 HL7V3 Outbound TestCollaboration Forinformation, see HL7 V2 Outbound Test Collaboration on page 119. MLLPV2 and the Sample Projects Creatingand Conguring the MLLP V2.0 Database ToCreate and Connect to the Database Page ToRun the MLLP V2.0 Database Scripts Page ToCreate the Connection Pooland JDBC Resource Associatingthe MLLP Database With the Adapter MLLPV2 Content Exchange Model HL7 Query/Response StandardInbound HL7 V2 Collaboration Overview overMLLPV2 Part 1 Page Part 2 SunAdapterfor TCP/IP HL7 User's Guide Oc tober 2009148 NO NO YESYES Part 3 JMS Message consumed and committed SunAdapterfor TCP/IP HL7 User's Guide Oc tober 2009150