450 likes | 799 Views
HL7 version 3. HL7 v3 Implementation – an introduction. Covers HL7 v3 modeling principles, MIF, ITSs and the structure of XML instances, the RIMBAA technology matrix. Slide contents published under the Creative Commons / Attribute-Share Alike license
E N D
HL7 version 3 HL7 v3 Implementation – an introduction Covers HL7 v3 modeling principles, MIF, ITSs and the structure of XML instances, the RIMBAA technology matrix. Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/HL7v3_implementation.zip
Agenda • HL7 v3 modeling/HDF – bottom up • MIF and the origins of schema • Conformance/validation principles • RIMBAA Technology Matrix • HL7 v3 documentation • From an implementers standpoint
An introduction HL7 v3 modeling / HDF -bottom up- Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/implementation_mechanics.ppt
XML example XML ITS DT R1
HL7 v3: Model Refinement ITS (serialization format of instances) R-MIM / SIM Serializable Model Refinement of Clinical Documents D-MIM / DIM Domain Model Pharmacy Refinement of RIM Stable model, Domain agnostic RIM
RoleRelationship ActRelationship Role Participation RIM Backbone Classes Entity Act
Notes • Core of all information models: Data Type specification • Dynamic model: • Interactions, message/response exchanges between 2 applications • Service layer, contractual issues, -work in progress- currently not covered by HL7 v3
An introduction MIF – Model Interchange Format Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/implementation_mechanics.ppt
MIF • The Model Interchange Format (MIF) • a set of XML formats used to support the storage and exchange of HL7 version 3 artefacts • the pre-publication format of HL7 v3 artefacts used by tooling. • the formal definition of the HL7 metamodel. • MIF can be transformed into derived forms such as UML/XMI or OWL.
MIF documents: • Requirements-analysis related structures. • Static model related structures. • Dynamic model related structures. • Infrastructure related structures: • including data types, and vocabulary • Structures related to testing • Conformance-related HL7 structures • Publication related structures
MIF: How Is It Defined? (1) A set of XML schemas (+ Schematron):
MIF: How Is It Defined? (2) • The XML schemas define the MIF language constructs as types, with the meaning of the types explained informally in annotations:
MIF versions • The meta-model format used for HL7 v3 models is subject to changes. • Versions: MIF 1.0 , MIF 2.1.x • Latest MIF version is generated by the latest version of the ‘v3Generator’ tool • XSLTs between MIF 2.1.x versions are shipped with the Generator tool.
MIF Diff Determine differences between models
An introduction ITSs and the origins of HL7 Schema Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/implementation_mechanics.ppt
ITS – Implementable Technology Specification • An ITS specifies how instances of HL7 SIMs should be ‘transmitted’ • Serialization, deserialization, encoding syntax • The most commonly used ITS is the “XML ITS” • Alternatives: RIM serialization ITS (“RIM ITS”), Green CDA
MIF transform toXML based ITS schemas Repository MIF MIF MIF XSLT XSLT R-MIM Pubs XML Schemas
MIF Example: E_NonPersonLivingSubject Other attributes
MIF v. XML-based ITS • XML provides a syntax only • An XML based ITS defines the set of valid XML instances for a given message type • no schema can do this • Download informative schemas with the v3 Ballot Package • Normative Edition schemas as a reference
Generated XML-Schema for BirthPlace (snippet, XML ITS 1.1) XML ITS
An introduction Conformance and Validation Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/implementation_mechanics.ppt
A “Valid” v3 instance.. • Complies with the requirements as defined by the HL7 v3 information model • Conformance indicator, cardinality, vocabulary • Complies with additional (“contractual”) requirements • Template definitions, business rules
Attribute/AssociationConformance Levels • Conformance indicator: • Optional: MAY be present, MAY be processed • Required: SHOULD be present, SHALL be supported by sender/receiver, SHALL be sent if known • Mandatory yes/no: • Mandatory*: SHALL be present, SHALL be processed/supported by sender/receiver
Vocabulary: Value Sets Person name: EN [0..*] administrativeGenderCode: CE CWE <= AdministrativeGender … • Attribute is linked to Concept Domain • The concept domain is (UV Realm) represented by a value set. • The value set is based on a coding system.
R-MIM (SIM).. and a Template (LIM) • Notes: • Template model must be a valid constraint on the R-MIM • -- An instance would not be able to conform to both if the above doesn’t hold true • Reminder: Clone names of classes carry no semantics (they are irrelevant)
Constraint Language • To express additional constraints • OCL, ADL, Gello • No solution has been formally adopted • Typical (OCL) example: • The Person object should have either an id or a name • context Person • inv: id.hasContent or name.hasContent
Example: „Valid“ CDA Document • Validates against the published XML Schema • XML Schema based validation tool • Validates against the abstract CDA model specification • Use a MIF (specification of the abstract model) based validation tool, includes conformance and vocabulary validation • Validates against requirements as specified in implementation guides • Mostly: a XML Schematron based validation tool • Validates against templates as specified in a document instance • MIF or Schema based validation tools
An introduction RIMBAA Technology Matrix Slide contents published under the Creative Commons / Attribute-Share Alike license Source: www.ringholm.de/download/implementation_mechanics.ppt
The RIM is “abstract” The same “instance” of information can be shared via different information interoperability paradigms • E.g. lab results can be shared • via (electronic) documents (v3 Clinical Document Architecture) • via V3 lab messages • via Web Services with v3 payloads • ..or they can be imported • In a RIM Based Application (RIMBAA)
Use of V3 artefacts RIMBAA
RIMBAA Technology Matrix (1/2) Persistent Representation Object Representation Serialized Representation RIM (generic) Model RIM Constrained Information Model Application specific Model
UI PL RIMBAA Technology Matrix (2/2) (at a 90 ̊ angle to the matrix on the previous slide) Processing Logic Object Representation User Interface
Consistentency of Models • It is beneficial to use one and the same semantic (reference) model for messaging, in-memory application objects as well as at the persistence layer. • This ensures the lowest degree of semantic loss due to mappings between data models. • Mapping of application internal data models to message models is possible if one only has to support a couple of messages
Any Questions ? • Or: post your question/suggestions via • HL7 Wiki: http://bit.ly/d7tSsL • E-mail v3impl@ringholm.com