醫(yī)學(xué)信息集成標(biāo)準(zhǔn)與技術(shù) 課件 第五章 NHAPI應(yīng)用程序接口

第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用NHAPI概述HL7應(yīng)用編程接口(HL7ApplicationProgrammingInterface，HAPI)是一個(gè)Java語言編寫的面向?qū)ο蟮拈_源HL7V2.X版的消息構(gòu)造解析工具包，由加拿大多倫多綜合醫(yī)院(UniversityHealthNetwork,UHN）開發(fā)。最新版是2017年發(fā)布的2.3版，對HL7V2.7、2.8、2.8.1提供了支持，可從https://hapifhir.github.io/hapi-hl7v2/下載。NHAPI是.net版的HAPI，是美國科羅拉多健康信息交換項(xiàng)目(ColoradoHealthInformationExchange，COHIE)的貢獻(xiàn)，使得.net開發(fā)人員在使用HL7V2.X對象模型變得容易，該對象模型允許解析或者構(gòu)造以管道符(pipe,‘|’)分隔或者XML格式的HL7消息。NHAPI的當(dāng)前版本仍然是2014年發(fā)布的2.4版，下載地址為https:///projects/nhapi或http:///。第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用主要程序集及命名空間HL7標(biāo)準(zhǔn)版本眾多，較為復(fù)雜。NHAPI采用面向?qū)ο笏枷?，把各個(gè)版本所涉及的數(shù)據(jù)類型、段、消息的共性抽象出來模型化，定義成為基類與接口。消息構(gòu)造與解析類面向基類編程，巧妙避開了各種版本細(xì)節(jié)的羈絆。每個(gè)版本都有該版本專門的程序集文件，實(shí)現(xiàn)該版本所定義的細(xì)節(jié)。NHAPI組成上有9個(gè)程序集構(gòu)成，每個(gè)程序集又按照功能相近劃分為命名空間以方便使用。

NHAPI主要程序集及命名空間見右表。程序集功能命名空間內(nèi)容NHapi.Base包含解析/編碼消息的核心組件的程序集。含有數(shù)據(jù)類型、段及消息的基類和接口。文件名為NHapi.Base.dllNHapi.Base.Model提供所有數(shù)據(jù)類型、消息、段等的基類NHapi.Base.Parser提供所有以管道符分隔的或XML格式的HL7消息解析器NHAPI.Base.validation提供對管道符分隔的或XML格式的HL7消息字符串和消息對象的驗(yàn)證NHapi.Base.SourceGeneration提供所有HL7V2.X規(guī)則的重新生成NHapi.Model.V21NHapi.Model.V22NHapi.Model.V23NHapi.Model.V231NHapi.Model.V24NHapi.Model.V25NHapi.Model.V251各種HL7V2.X版程序集。包括符合HL7V2.X規(guī)則的數(shù)據(jù)類型、段及消息。文件名為NHapi.Model.V2X.dllNHapi.Model.V2X.Datatype包含符合HL7V2.X規(guī)則的數(shù)據(jù)類型(如CE、TX、ST)NHapi.Model.V2X.Group包含符合HL7V2.X規(guī)則的組合，用于表示消息中的字段組合(如ADT_A01_Insurance)NHapi.Model.V2X.Message包含符合HL7V2.X規(guī)則的消息(如ADT_A01,ACK)NHapi.Model.V2X.Segment包含符合HL7V2.X規(guī)則的消息段(如PID,MSH)NHapi.NUnit基類類庫和V2.X庫的單元測試程序集。文件名為NHapi.NUnit.dllNHapi.NUnit提供基類及HL7V2.X各版本庫的單元測試NHapi.NUnit.Additional附加的單元測試庫。文件名為NHapi.NUnit.Additional.dllNHapi.NUnit.Additional提供對自定義段Zxx的單元測試第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用5.3.1接口數(shù)據(jù)類型接口采用組合模式設(shè)計(jì)抽象節(jié)點(diǎn)為IType；容器節(jié)點(diǎn)為IComposite，用來規(guī)范所有復(fù)雜數(shù)據(jù)類型的類，比如CE、PN、XCN等其中的Components組合了任意個(gè)IType類型接口；葉子節(jié)點(diǎn)為IPrimitive用來約束所有簡單數(shù)據(jù)類型類如ST、NM、ID、IS等。包括IStructure基接口及其派生接口ISegment和IGroup。ISegment規(guī)范了段類的訪問接口。IGroup約束了各種可重復(fù)結(jié)構(gòu)的屬性和方法，其派生出的IMessage接口規(guī)定了消息的接口。2.數(shù)據(jù)結(jié)構(gòu)接口5.3.2數(shù)據(jù)結(jié)構(gòu)基類包括HL7消息類體系和HL7段類體系。NHAPI中并沒有為字段、組件、子組件建立專門的類，只是把數(shù)據(jù)類型類作為段類的成員，從而把字段/組件/子組件三層結(jié)構(gòu)統(tǒng)一用組合模式進(jìn)行透明訪問。1.HL7消息基類AbstractGroup類實(shí)現(xiàn)了IGroup接口，組合了AbstractGroupItem類。AbstractMessage類繼承AbstractGroup類，并實(shí)現(xiàn)了IMessage接口，作為所有消息的抽象基類。GenericMessage類繼承AbstractMessage類，內(nèi)嵌了V21-V25類作為GenericMessage的子類提供指定版本的通用消息，通常在解析消息時(shí)初始化指定類型消息類找不到時(shí)的一個(gè)替代。2.HL7段基類包括AbstractSegment類，實(shí)現(xiàn)了ISegment接口，其中組合了任意多個(gè)AbstractSegmentItem類。GenericSegment類繼承了AbstractSegment類，作為各種段的基類。GenericSegment作為消息解析時(shí)指定段類找不到時(shí)的通用段容器，比如用于解析用戶自定義段Zxx。5.3.3通用數(shù)據(jù)類型類實(shí)現(xiàn)了數(shù)據(jù)結(jié)構(gòu)接口IType，所以也是以組合模式設(shè)計(jì)：AbstractType類實(shí)現(xiàn)了IType接口為抽象節(jié)點(diǎn)，是所有復(fù)合數(shù)據(jù)類型類的基類，在各版本程序集中定義。GenericComposite類實(shí)現(xiàn)了IComposite接口為容器節(jié)點(diǎn)，在解析消息時(shí)為未知的復(fù)合數(shù)據(jù)類型提供一個(gè)通用的類型容器。AbstractPrimitive為葉子節(jié)點(diǎn)，是所有簡單數(shù)據(jù)類型類的基類，在各版本程序集中定義，其派生類GenericPrimitive類實(shí)現(xiàn)了IPrimitive接口，也是為未知數(shù)據(jù)類型提供通用類型實(shí)例。第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用5.4NHapi.Base.Parser命名空間5.4.1模型接口IModelClassFactory5.4.2模型包管理類PackageManager5.4.3模型工廠類DefaultModelClassFactory5.4.4消息構(gòu)造解析器基類ParserBase5.4.5經(jīng)典構(gòu)造解析器類PipeParser5.4.6XML構(gòu)造解析器類XMLParser5.4.1模型接口IModelClassFactoryIModelClassFactory接口提供了對指定版本模型庫中的指定消息、段、組、數(shù)據(jù)類型類的獲取接口。實(shí)現(xiàn)該接口的類包括DefaultModelClassFactory類。publicinterfaceIModelClassFactory{

//獲取theVersion指定版本theName指定消息名的消息類 TypeGetMessageClass(StringtheName,StringtheVersion,boolisExplicit);

//獲取theVersion指定版本theName指定組名的組類 TypeGetGroupClass(StringtheName,StringtheVersion);

//獲取theVersion指定版本theName指定段名的段類 TypeGetSegmentClass(StringtheName,StringtheVersion);

//獲取theVersion指定版本theName指定類型名的數(shù)據(jù)類型類 TypeGetTypeClass(StringtheName,StringtheVersion);}5.4.2模型包管理類PackageManagerPackageManager靜態(tài)類屬于NHAPI.Base命名空間，對所支持的各種版本模型庫的包名和路徑進(jìn)行集中管理。其中_packages屬性中有HL7Package對象的集合，每個(gè)對象對應(yīng)了一種版本的HL7模型信息，包括版本名Version和包名PackageName，見右圖。5.4.3模型工廠類DefaultModelClassFactoryDefaultModelClassFactory類實(shí)現(xiàn)了IModelClassFactory接口，如右圖。該類從PackageManager對象中獲取模型包信息并加載，提供了IModelClassFactory接口規(guī)定的消息、組、段、數(shù)據(jù)類型類的按類名查找接口，如果查找失敗則可以返回通用消息、組、段、數(shù)據(jù)類型。5.4.4消息構(gòu)造解析器基類ParserBaseParserBase類是HL7消息構(gòu)造解析器基類，派生出用于傳統(tǒng)編碼字符分隔消息的PipeParser類和XML格式消息的XMLParser類，見下圖。5.4.5經(jīng)典構(gòu)造解析器類PipeParserPipeParser類是支持傳統(tǒng)的以編碼字符（如|、^、&、~）分隔的HL7V2構(gòu)造解析類，對于非預(yù)期的段和字段則解析成通用段或字段加入到解析結(jié)果中。PipeParser類是NHAPI中使用最頻繁的核心類。1.類成員PipeParser類繼承PipeBase類，實(shí)現(xiàn)了其中定義的抽象方法，同時(shí)擴(kuò)展了新的方法。其中核心的方法是Parse和Encode方法，但不是對基類同名方法的重寫而是新定義的重載方法。Parse方法有兩個(gè)重載，分別用于解析段對象和字段對象。Encode方法有三個(gè)重載，分別用于構(gòu)造消息/組編碼、段編碼和字段編碼。2.消息解析方法1）DoParse方法DoParse方法作為消息解析的入口，創(chuàng)建了與消息類型和版本號一致的消息對象實(shí)例，將消息字符串拆分為段，并對每個(gè)段去除首部的空白字符及尾部的多余分隔符，然后調(diào)用解析段對象的Parse方法得到段對象，添加到消息對象。2）解析段對象的Parse方法解析段字符串的Parse方法用encodingChars指定的編碼字符將段segment解析為段對象實(shí)例destination，其中嵌套調(diào)用了解析字段字符串的Parse方法對每個(gè)字段和組件進(jìn)行解析。3）解析字段對象的Parse方法

解析字段對象的Parse方法由于沒有字段那些復(fù)雜情況及重復(fù)值需要處理，因此比較直觀。先用組件分隔符將字段字符串拆分為組件數(shù)組，對每個(gè)組件再用子組件分隔符拆分為子組件數(shù)組，每個(gè)子組件再做去除轉(zhuǎn)義處理，保存為簡單類型對象。每個(gè)字段或組件可能是復(fù)合類型有下一級結(jié)構(gòu)，但也可能是簡單類型沒有下一級結(jié)構(gòu)。由于Split方法會返回至少一個(gè)組件或子組件，因此可以不用區(qū)分字段或組件是復(fù)合類型還是簡單類型，進(jìn)行一致化處理。3.消息構(gòu)造方法1）DoEncode方法DoEncode方法作為消息編碼的入口，有指定編碼和默認(rèn)編碼兩個(gè)重載。指定編碼的DoEncode方法先判斷指定的編碼是否支持，然后調(diào)用構(gòu)造消息編碼的Encode重載方法。默認(rèn)編碼的DoEncode方法使用PipeParser默認(rèn)的“VB”編碼（VB是指豎杠），即先創(chuàng)建一個(gè)MSH段對象，從中獲取字段分隔符、編碼字符、版本號、消息類型，再調(diào)用構(gòu)造消息編碼的Encode方法。2）構(gòu)造消息編碼的Encode方法構(gòu)造消息編碼的Encode方法用encodingChars指定的編碼字符對消息對象source進(jìn)行編碼，其中嵌套調(diào)用了構(gòu)造段編碼的Encode重載方法對每個(gè)段對象進(jìn)行編碼，得到各段編碼字符串。用段終止符連接各段編碼字符串得到消息編碼字符串。3）構(gòu)造段編碼的Encode方法構(gòu)造段編碼的Encode方法使用encodingChars指定的編碼字符對段對象實(shí)例source的每個(gè)字段對象進(jìn)行編碼，其中嵌套調(diào)用構(gòu)造字段編碼的Encode方法對每個(gè)組件和子組件對象進(jìn)行編碼得到字段編碼字符串用字段分隔符連接段名和各字段編碼字符串，得到段編碼字符串。4）構(gòu)造字段編碼的Encode方法構(gòu)造字段編碼的Encode方法使用encodingChars指定的編碼字符通過兩層循環(huán)對字段對象實(shí)例source的每個(gè)組件和子組件對象進(jìn)行編碼外循環(huán)對字段對象的每個(gè)組件對象編碼內(nèi)循環(huán)對組件對象的每個(gè)子組件對象編碼，得到子組件編碼字符串用子組件分隔符連接各子組件編碼字符串得到組件編碼字符串用組件分隔符連接各組件編碼字符串得到字段編碼字符串。5.4.6XML構(gòu)造解析器類XMLParserXMLParser類是支持xml格式的HL7消息構(gòu)造解析類，遵循HL7規(guī)范的XML編碼規(guī)則。該類是個(gè)抽象類，只處理數(shù)據(jù)類型和段的構(gòu)造解析，而不是整個(gè)消息的構(gòu)造解析。需要為某一特定消息結(jié)構(gòu)創(chuàng)建派生類來使用該類，該派生類需要能夠識別與XML文檔中各種段節(jié)點(diǎn)對應(yīng)的段對象，然后調(diào)用解析段的Parse方法或者構(gòu)造段的Encode方法。DefaultXMLParser類是一個(gè)默認(rèn)的XMLParser擴(kuò)展類，使用段名把XML編碼消息中的段元素指定為消息對象中的段對象，但通用性不強(qiáng)。第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用5.5NHAPI.Base.Validation命名空間在ParserBase中組合了驗(yàn)證器對象_messageValidate，在構(gòu)造消息的Encode方法和解析消息的Parse方法中對消息編碼字符串以及消息對象均進(jìn)行驗(yàn)證。NHAPI.Base.Validation命名空間包括：驗(yàn)證器接口、驗(yàn)證器類和NHAPI.Base.validation.impl子空間中的驗(yàn)證規(guī)則類、驗(yàn)證環(huán)境類。5.5.1驗(yàn)證器接口驗(yàn)證規(guī)則接口包括IRule及其派生的編碼規(guī)則接口IEncodingRule、消息規(guī)則接口IMessageRule和簡單數(shù)據(jù)類型規(guī)則接口IPrimitiveTypeRule。驗(yàn)證環(huán)境接口IValidationContext定義了獲取IEncodingRule實(shí)例的getEncodingRules方法、獲取IMessageRule實(shí)例的getMessageRules方法和獲取IprimitiveTypeRule實(shí)例的getPrimitiveRules方法。實(shí)現(xiàn)了IPrimitiveTypeRule接口的類包括SizeRule類、TrimLeadingWhitespace類、RegexPrimitiveRule類。實(shí)現(xiàn)了IvalidationContext接口的類有ValidationContextImpl類。5.5.2驗(yàn)證器類MessageValidator類通過其構(gòu)造函數(shù)傳入IValidationContext驗(yàn)證環(huán)境實(shí)例myContext，Validate方法對傳入的IMessage消息實(shí)例或字符串進(jìn)行規(guī)則驗(yàn)證，該類結(jié)構(gòu)見下圖。5.5.3NHAPI.Base.validation.impl子空間1.驗(yàn)證規(guī)則類包括實(shí)現(xiàn)了IPrimitiveTypeRule接口的SizeRule類、TrimLeadingWhitespace類、RegexPrimitiveRule類，可分別對原始類型值進(jìn)行長度驗(yàn)證和修正、前導(dǎo)空格的驗(yàn)證與消去、正則表達(dá)式定義的驗(yàn)證與修正。這些類的結(jié)構(gòu)見下圖。2驗(yàn)證環(huán)境類驗(yàn)證環(huán)境類包括ValidationContextImpl類及其派生類DefaultValidation類的派生類StrictValidation類。ValidationContextImpl類組合了許多RuleBinding對象，后者保存了IRule驗(yàn)證規(guī)則與版本及類的綁定關(guān)系，并實(shí)現(xiàn)了IValidationContext接口，提供對驗(yàn)證規(guī)則的獲取方法。5.5.3NHAPI.Base.validation.impl子空間第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用5.6NHAPI.Model.V2X命名空間HL7每個(gè)版本對數(shù)據(jù)類型、段、組、消息均可以有不同的定義，NHAPI通過不同程序集來提供，包括NHapi.Model.V21、NHapi.Model.V22、NHapi.Model.V23、NHapi.Model.V231、NHapi.Model.V24、NHapi.Model.V25、NHapi.Model.V251。每個(gè)程序集再分為DataType、Segment、Group和Message命名空間，在這些命名空間下定義各種數(shù)據(jù)類型類、段類、組類和消息類。數(shù)據(jù)類型類NHapi.Model.V2X.Datatype簡單數(shù)據(jù)類型類復(fù)合數(shù)據(jù)類型類段類NHapi.Model.V2X.Segment消息類NHapi.Model.V2X.Message第五章NHAPI應(yīng)用程序接口5.1概述5.2主要程序集及命名空間5.3NHapi.Base.Model命名空間5.4NHapi.Base.Parser命名空間5.5NHAPI.Base.Validation命名空間5.6NHAPI.Model.V2X命名空間5.7NHAPI的應(yīng)用5.7NHAPI的應(yīng)用5.7.1構(gòu)造消息5.7.2解析消息5.7.1構(gòu)造消息1）引用類庫NHapi.Base.dllNhapi.Model.V2x.dll2）使用名字空間：usingNHapi.Base.Parser;usingNHapi.Base;usingNHapi.Model.V2x;usingNHapi.Model.V2x.Message;usingNHapi.Model.V2x.Segment;3）實(shí)例化PipeParser類：PipeParserparser=newPipeParser();4）實(shí)例化消息:Message.消息類型msg=newMessage.消息類型();5）填寫消息各段、字段的值：msg.MSH.EncodingCharacters.Value=@"^~\&";……6）編碼消息：StringstrMsg=parser.encode(msg);usingNHapi.Base.Parser;usingNHapi.Base;usingNHapi.Model.V231.Message;usingNHapi.Model.V231.Datatype;staticStringEncodeTest(){PipeParserparser=newPipeParser();QRY_R02qry=newQRY_R02();qry.MSH.MessageType.MessageType.Value="QRY";qry.MSH.MessageType.TriggerEvent.Value="R02";qry.MSH.MessageType.MessageStructure.Value="QRY_R02";qry.MSH.FieldSeparator.Value="|";qry.MSH.SendingApplication.NamespaceID.Value="CohieCentral";qry.MSH.SendingFacility.NamespaceID.Value="COHIE";qry.MSH.ReceivingApplication.NamespaceID.Value="Clinical";qry.MSH.ReceivingFacility.NamespaceID.Value="IHE";qry.MSH.EncodingCharacters.Value=@"^~\&";qry.MSH.VersionID.VersionID.Value="2.3.1";qry.MSH.DateTimeOfMessage.TimeOfAnEvent.SetLongDate(DateTime.Now);qry.MSH.MessageControlID.Value="000123";qry.MSH.ProcessingID.ProcessingID.Value="P";XCNst=qry.QRD.GetWhoSubjectFilter(0);st.AssigningAuthority.UniversalID.Value="";st.IDNumber.Value="123456";qry.QRD.QueryDateTime.TimeOfAnEvent.SetLongDate(DateTime.Now);qry.QRD.QueryFormatCode.Value="R";qry.QRD.QueryPriority.Value="I";CEwhat=qry.QRD.GetWhatSubjectFilter(0);what.Identifier.Value="RES";return(parser.Encode(qry));}返回的編碼后的消息字符串內(nèi)容如下：MSH|^~\&|CohieCentral|COHIE|Clinical|IHE|202204241526||QRY^R02^QRY_R02|000123|P|2.3.1QRD|202204241526|R|I|||||123456|RES5.7.2解析消息1）引用類庫:NHapi.Base.dllNhapi.Model.V2x.dll2）使用名字空間usingNHapi.Base;usingNHapi.Model.V2x;usingNHapi.Model.V2x.Message;usingNHapi.Model.V2x.Segment;3）實(shí)例化PipeParser類：PipeParserparser=newPipeParser();4）解析消息：IMessagem=parser.parse(strMsg);5）強(qiáng)制轉(zhuǎn)換消息：消息類型msg=mas消息類型;6）獲得消息各字段的值：StringmsgID=msg.MSH.MessageControlID.Value;……usingNHapi.Base.Model;usingNHapi.Base.Parser;usingNHapi.Base;usingNHapi.Model.V25;usingNHapi.Model.V25.Message;usingNHapi.Model.V25.Segme