Summary of the content on the page No. 1
SunAdapterforTCP/IPHL7
User'sGuide
SunMicrosystems,Inc.
4150NetworkCircle
SantaClara,CA95054
U.S.A.
PartNo:821–0377–10
October2009
Summary of the content on the page No. 2
Copyright2009SunMicrosystems,Inc. 4150NetworkCircle,SantaClara,CA95054U.S.A. Allrightsreserved. SunMicrosystems,Inc.hasintellectualpropertyrightsrelatingtotechnologyembodiedintheproductthatisdescribedinthisdocument.Inparticular,andwithout limitation,theseintellectualpropertyrightsmayincludeoneormoreU.S.patentsorpendingpatentapplicationsintheU.S.andinothercountries. U.S.GovernmentRights–Commercialsoftware.GovernmentusersaresubjecttotheSunMicrosystems,Inc.standardlicenseagreementandapplicableprovi
Summary of the content on the page No. 3
Contents SunAdapterforTCP/IPHL7User'sGuide ..........................................................................................7 SunAdapterforTCP/IPHL7Overview ..............................................................................................8 AboutSunAdapterforTCP/IPHL7 ............................................................................................8 AboutHL7 ...........................................................................................................
Summary of the content on the page No. 4
Contents HL7SFTSegment—TCP/IPHL7V2InboundAdapter .......................................................44 CommunicationControl—TCP/IPHL7V2InboundAdapter ...........................................45 HL7RecourseAction—TCP/IPHL7V2InboundAdapter..................................................47 TCP/IPHL7V2AdapterOutboundConnectivityMapProperties..............................................49 GeneralOutboundSettings—TCP/IPHL7V2OutboundAdapter ....................................49 TCPIPOutboundS
Summary of the content on the page No. 5
Contents TCPIPOutboundSettings-ClientConnectionEstablishment—TCP/IPHL7V3 OutboundAdapter ......................................................................................................................83 TCPIPOutboundSettings-ServerPortBinding—TCP/IPHL7V3Outbound Adapter..........................................................................................................................................84 HL7Acknowledgment—TCP/IPHL7V3OutboundAdapter .....................................
Summary of the content on the page No. 6
6
Summary of the content on the page No. 7
SunAdapterforTCP/IPHL7User'sGuide ThisdocumentprovidesinformationandinstructionsforworkingwiththeSunAdapterfor TCP/IPHL7.Itisdividedintothetopicslistedbelow. WhatYouNeedtoKnow Thesetopicsprovideinformationthatisusefultoknowbeforeyoustartworkingwiththe TCP/IPHL7Adapter: ■ “SunAdapterforTCP/IPHL7Overview”onpage8 ■ “AboutTCP/IPHL7V2Collaborations”onpage107 ■ “AboutTCP/IPHL7V3Collaborations”onpage120 ■ “MLLPV2ContentExchangeModel”onpage144 ■ “StandardInboundHL7V2CollaborationOverviewoverMLLPV2”onpag
Summary of the content on the page No. 8
SunAdapterforTCP/IPHL7Overview Theselinksprovideadditionalinformationthatisusefultoknowwhenworkingwiththe TCP/IPHL7Adapter: ■ “TCP/IPHL7V2AdapterInboundConnectivityMapProperties”onpage30 ■ “TCP/IPHL7V2AdapterOutboundConnectivityMapProperties”onpage49 ■ “TCP/IPHL7V3AdapterInboundConnectivityMapProperties”onpage64 ■ “TCP/IPHL7V3AdapterOutboundConnectivityMapProperties”onpage79 ■ “TCP/IPHL7InboundAdapterEnvironmentProperties”onpage92 ■ “TCP/IPHL7InboundAdapterEnvironmentProperties”onpage94 SunAdapt
Summary of the content on the page No. 9
SunAdapterforTCP/IPHL7Overview Note–Throughoutthisdocumenttheterm“JMSqueue”isusedinthegenericsenseand actuallydenotesJMSqueuesortopics. TCP/IPHL7Features TheTCP/IPHL7Adapterincludesthefollowingfeatures: ■ Bidirectionalprocessing,includingclientorservermodeineitherdirection(toorfromSun JavaCAPSESB). ■ HandlesbothHL7HLLPandMLLPprotocolsandenvelopes. ■ Providesawidevarietyofrecourseactionconfigurations. ■ Non-blockingI/O. ■ Recoveryandretrylogic. ■ Debuglevelsanderrorlogging. ■ JournalingofHL7messa
Summary of the content on the page No. 10
SunAdapterforTCP/IPHL7Overview TheMessageLibraryhandlesallofthelower-layerprotocol.TheMessageLibrary’sbehavioris customizedusingtheAdapterconfigurationproperties.TheseAdapterpropertiesareusedby theresourceadapter,butarealsoaccessedandusedbytheprebuiltCollaborations. AboutHL7 HL7isastandardforexchanginginformationbetweenmedicalapplicationsandisan abbreviationofHealthLevelSeven.LevelSevenreferstotheseventhOSIlayerprotocolforthe healthenvironment.HL7definestheformatandthecontentofthemessagesthatapp
Summary of the content on the page No. 11
SunAdapterforTCP/IPHL7Overview IfasystemdoesnotconformtotheHL7specification,theCollaborationscanbemodifiedfor thattransactionbychangingtheJavacodeusingtheCollaborationEditor.TheCollaborations Javacodeisdesignedtobeavailableand“transparent”soyoucaneasilyreferencethe predefinedJavacodetoseehowitcurrentlyhandlesHL7transactionsandmakethe appropriatemodifications. TheCollaborationEditorallowsyoutocreateandeditJavacodetomodifyaCollaborationfor yourspecificneeds.Inmanycasesthiscodecanbecreatedgraphical
Summary of the content on the page No. 12
SunAdapterforTCP/IPHL7Overview ■ Monitoring TheEnterpriseManagerprovidesareal-timepictureoftheAdapter'sstateandstatus.The monitoringfacilitiesdisplaythefollowinginformation: ■ Adapterupordown ■ Connectedtoexternal ■ Currentsequencenumber ■ Dateandtimeofthelasttransaction ■ Adapterproperties ■ Alerts AlertsaresentfromtheRAandtheCollaborationswhenconditionsareidentifiedthat endangerorstoptheinterface.Youcanaddyourowncustomalertmessagestothe Collaborations. ■ Logging Logmessagesarewrittenfrombothth
Summary of the content on the page No. 13
SunAdapterforTCP/IPHL7Overview HL7AdapterSenderRole TheoutboundCollaborationistheimplementationoftheSenderandtheRAisconfiguredfor anoutbounddataflow.AJavaCAPSServiceforwardsthedatatotheAdapter,whichinturn forwardsthedatatotheacceptingHL7externalsystem.TheExternalSystemrespondswithan ACKorNAKresponse. HL7AdapterReceiverRole TheinboundCollaborationistheimplementationoftheReceiverroleinconjunctionwiththe RAbeingconfiguredforinbounddirection.TheAdapteracceptsamessagefromthesending HL7externalsystem,
Summary of the content on the page No. 14
SunAdapterforTCP/IPHL7Overview 2. TheReceiversendsthemessagetotheForwarder. 3. TheForwardersendsthemessagetothereceivingExternalSystem. 4. ThereceivingExternalSystemsendsanACKtotheForwarder. 5. TheForwarderreceivestheACKfromtheExternalandforwardsitontotheReceiver. 6. TheReceiverthenforwardstheACK,withanMSH-5,value“F”indicatingthatitisthe receivingExternalSystem’sACK,totheSender. IntheReceiverrole,theHL7RAisconfiguredforinbound,andtheinboundCollaborationis usedwiththeparameterSendsAppAcksettotrue
Summary of the content on the page No. 15
SunAdapterforTCP/IPHL7Overview StandardInboundMessageModeDataFlowandArchitecture ThefollowingstepsdescribetheflowofdataforaninboundAdapter: 1. TheexternalsystemsendstheHL7messagetotheAdapter. 2. TheCollaborationreceivestheHL7message. 3. TheCollaborationvalidatesthemessage(ifvalidateisenabled).Ifitfails,theCollaboration takestheconfiguredrecourseaction.Iftherecourseactionisstrippedandthemaximum numberofretrieshasbeenexceeded,themessageanderrorarewrittentotheerrorqueue. 4. TheCollaborationwritesth
Summary of the content on the page No. 16
SunAdapterforTCP/IPHL7Overview MessageVerification Messageverificationbeginswithreadingthemessagefromtheexternalsystem.Themessageis expectedtomatchtheMLLPenvelope,sincebothHLLPandMLLPenvelopeshavetheStartof Block(SOB),EndofData(EOD),andaCarriageReturn(CR)incommon. Ifamessagefailsthereadverification,itisconsideredbaddata.IfreadbyaninboundAdapter, thisfailurecausestheAdaptertogenerateaCannedHL7NAK.AnoutboundAdapterignores themessageandlogsawarning,reportingthenatureoftheproblemtothelogfile. AnHLLP
Summary of the content on the page No. 17
SunAdapterforTCP/IPHL7Overview ■ Noresponseisreceivedafteramessageissentthemaximumnumberoftimes. OutboundFunctionality TheoutboundTCP/IPHL7AdapterProject,prjHL7Outbound,canbeimplementedin standardoutboundmodeorintwoforwardmessagemodes:outbounddelayedACKor outboundforwarder. OutboundAdapterDataFlow Inoutboundmode,theAdapterreceivesHL7messagesfromaJMSqueue.Eachmessageis verifiedtoensureitcontainsHL7dataonly.LegitimateHL7dataisenvelopedintoits configuredformatandsenttotheexternalsystem. Amessageint
Summary of the content on the page No. 18
SunAdapterforTCP/IPHL7Overview 5. TheCollaborationreceivesandvalidatestheACK,andthenjournalstheACKandtheHL7 message(ifjournalingisenabled).IftheCollaborationreceivesaNAK,theNAKandthe HL7messagearesenttotheerrorqueue. 6. Finally,theCollaborationcommitstheJMSreceive. OutboundAdapterRolesforDelayedACKScenarios TheoutboundAdaptercanfulfilltworolesinadelayedACKscenario.Theoutbounddelayed acknowledgementmodeisusedtocommunicatewithanexternalsystemthatisconfiguredto receivemessagesinadelayedACKway;thati
Summary of the content on the page No. 19
SunAdapterforTCP/IPHL7Overview Note–ForDelayedACK,theReceiverandForwardermustbeonthesameintegration server. MessageVerification TheonlyverificationthattheoutboundAdapterdoesistoensurethatthemessageparsesinto thegenericEventMessageLibrary,andthattheMSHusesthecorrectfields.Theacknowledgeis verifiedtoensurethatthesentmessageisvalid. AcknowledgmentProcessing ■ AdapterGeneratesHL7Acknowledgment Inthisscenario,theAdaptergeneratesanHL7ACKafterreceivingandsuccessfullystoring themessageinaqueue;otherwise
Summary of the content on the page No. 20
SunAdapterforTCP/IPHL7Overview Note–TheTCP/IPHL7Adapterincludesinternalcountersthatkeeptrackofallerror conditions. GeneralFunctionality ThissectionexplainstheAdapter’sgeneralfunctionsandfeatures.Itincludesthefollowing topics: ■ “Non-blockingI/O”onpage20 ■ “HL7SequenceNumberingProtocol”onpage20 ■ “FailedMessageHandling”onpage21 ■ “RecourseActions”onpage21 Non-blockingI/O Thenon-blockingI/OfeaturepreventstheAdapterfromlockingupwhenattemptingtoreador writedatablocks,allowingtheAdaptertocontinueitso
