The Standards In This Document Provide An Integrated ... - HL7.org

EDITORS, CO-EDITORS, AND CONTRIBUTORS |Editors: |Principal Editors: |
| |Peter L. Elkin, MD, Mayo Clinic |
| |(Elkin.Peter@mayo.edu) |
| |Martin Kernberg, MD, UCSF (mkfrad@aol.com) |
| | |
| |Co-Editors: |
| |Thomas Beale, Ocean Informatics |
| |Sam Heard, MD, Ocean Informatics |
| |Mark Shafarman, Chair-Elect, HL7 |
| |Robert Dolin, MD |
| |Dale Nelson |
|Contributors: |Liora Alschuler, alschuler.spinosa |
| |Russ Hamm, Mayo Clinic |
| |Calvin Beebe, Mayo Clinic |
| |George W. Beeler, Jr. Ph.D., Beeler |
| |Consulting LLC |
| |Fred Behlen, PhD., LAI Technology |
| |Tim Benson, Abies Ltd |
| |Paul Biron, MLIS, Kaiser Permanente |
| |Sandy Boyer, BSP, Consultant |
| |Andrew Goodchild, DSTC |
| |William T.F. Goossen, PhD, RN |
| |Richard Harding, Queensland Health |
| |Mike Henderson, Eastern Informatics |
| |Mary Ann Juurlink, Killdara Corporation |
| |Ted Klein, Klein Consulting, Inc |
| |Mike Mair, MD |
| |Charlie McCay, Ramsey Systems, Ltd. |
| |Lloyd McKenzie, IBM Global Services |
| |Charlie Mead, MD, MSc (charliem22@yahoo.com) |
| |Bas van Poppel, Hiscom BV |
| |Jennifer Puyenbroek, McKesson Information |
| |Solutions |
| |Angelo Rossi-Mori, CNR |
| |Alexander Ruggieri, MD, Mayo Clinic |
| |Gunther Schadow, MD, PhD, Regenstrief |
| |Institute for Health Care |
| |Amnon Shabo, IBM Research |
| |John Silva, Philips Medical Systems |
| |Ioana Singureanu, Eversolve |
| |Harold Solbrig, Mayo Clinic |
| |Harry Solomon, GE Medical Systems |
REVISION HISTORY |Revision history |
|Version|Date |Author |Comments |
|1.0 | |R Dolin |Initial Baltimore Draft, with |
| | | |Templates SIG, EHR SIG, and Structured|
| | | |Documents TC, Modelling and |
| | | |Methodology TC, Vocabulary TC, |
| | | |Clinical Decision Support |
|1.1 |19 Feb |M. Kernberg |SR-XML, Document Ontology and Element |
| |2003 | |Components |
|1.2 |28 Mar |S Heard |ADL Minor changes, terminology |
| |2003 | |independence |
|1.3 |8 Apr 2003|S Heard |ADL Language independence, additional |
| | | |languages and terminology approaches |
|1.4 |11 Apr |T Beale |ADL Re-organisation of structure |
| |2003 | | |
|1.5 |14 Apr |S Heard |ADL Upgraded Apgar significantly. |
| |2003 | | |
|1.6 |15 Apr |T Beale |ADL Review |
| |2003 | | |
|1.6.2 |16 Apr |T Beale/S Heard |ADL Added BP example, Foreign |
| |2003 | |Languages section |
|1.7 |September |P Elkin |Draft Proposal for HL7 Memphis |
| |9, 2003 | |Meeting; Integration of OWL Model |
|2.1 |November |M Kernberg and P|Revisions based on HL7 Memphis Meeting|
| |30, 2003 |Elkin, T Beale, |2003; Integration of ADL Model; |
| | |and S Heard |Integration of OCL Constraint Language|
| | | |for HL7 Artifacts; Integration of SML |
| | | |for Expert Contributions |
|2.5 |September,|P. Elkin, T |Revisions to the Spec based on the |
| |2004 |Beale, R. Hamm, |Conf Call feedback and the KR work on |
| | |S Heard |Templates and Archetypes. |
Table of Contents 1. ABSTRACT 8 2. INTRODUCTION 8 Intent of this document 8 What is the mechanism of templates and archetypes? 8 What is the intended purpose of a template and archetype? 10 How do templates and archetypes differ from related HL7 artifacts? 11 SCOPE OF HL7 V3 TEMPLATES AND ARCHETYPES 14
Guiding principles 14
In scope 14
Out of scope 15 3. HL7 Definition of Terms 15 4. ARCHITECTURAL OVERVIEW: RELATIONSHIP OF TECHNICAL FORMALISMS AND THE RIM
16 5. TEMPLATES AS GENERAL CONSTRAINTS ON HL7 ARTIFACTS 18 Template and archetype requirements 18 Template and archetype design 18 Template and archetype assertions 18 Static assertions 18 Co-occurrence assertions 19 Containment assertions 20 Logic assertions 20 Normative template and archetype representation 20 Template and archetype declaration 20 Template and archetype registration 21 Template and archetype repository 21 Template and archetype metadata 21 9. OCL: GENERAL CONSTRAINTS ON HL7 ARTIFACTS 70 Object Constraint Language Specification 70 Contents 70
Topic Page 70
9.1 Overview 70
9.1.1 Why OCL? 70
9.1.2 Where to Use OCL 71
9.2 Introduction 72
9.2.1 Legend 72
9.2.2 Example Class Diagram 72
9.3 Relation to the UML Metamodel 72
9.3.1 Self 72
9.3.2 Specifying the UML context 73
9.3.3 Invariants 73
9.3.4 Pre- and Postconditions 74
9.3.5 Package context 74
9.3.6 General Expressions 75
9.4 Basic Values and Types 75
9.4.1 Types from the UML Model 75
9.4.2 Enumeration Types 76
9.4.3 Let Expressions and «definition» Constraints 76
9.4.4 Type Conformance 76
9.4.5 Re-typing or Casting 77
9.4.6 Precedence Rules 78
9.4.7 Use of Infix Operators 78
9.4.8 Keywords 78
9.4.9 Comment 78
9.4.10 Undefined Values 79
9.5 Objects and Properties 79
9.5.1 Properties 79
9.5.2 Properties: Attributes 80
9.5.3 Properties: Operations 80
9.5.4 Properties: Association Ends and Navigation 80
9.5.5 Navigation to Association Classes 82
9.5.6 Navigation from Association Classes 83
9.5.7 Navigation through Qualified Associations 83
9.5.8 Using Pathnames for Packages 84
9.5.9 Accessing overridden properties of supertypes 84
9.5.10 Predefined properties on All Objects 85
9.5.11 Features on Classes Themselves 85
9.5.12 Collections 86
9.5.13 Collections of Collections 87
9.5.14 Collection Type Hierarchy and Type Conformance Rules 87
9.5.15 Previous Values in Postconditions 88
9.6 Collection Operations 88
9.6.1 Select and Reject Operations 89
9.6.2 Collect Operation 90
9.6.3 ForAll Operation 91
9.6.4 Exists Operation 91
9.6.5 Iterate Operation 92
9.6.6 Iterators in Collection Operations 93
9.6.7 Resolving Properties 93
9.7 The Standard OCL Package 93
9.8 Predefined OCL Types 94
9.8.1 Basic Types 94
9.8.2 Collection-Related Types 98
9.9 Grammar 105 10. TEMPLATE AND ARCHETYPE CONSTRAINTS ON CLINICAL DATA: SYNTAX 109 10.1 ADL Formalism 109 Introduction 109 Status 109 Syntax Overview 110
Typographical Conventions 110
Symbols 110
Archetype Structure 111
Body Part Syntax 111 Terminology Part 112 Identification 113 ISO Oid Id 113 Multi-axial Archetype Identifier 114 Archetype Metadata 115 Archetype Relationships 117 Composition 117 Specialization 117 Versions 118 Revisions 118 Relationship with Knowledge - Ontologies and Terminology 118
Design Time Node Names 118
Runtime Node Name Constraints 118
Values 119
Terminology Definitions and Bindings 119 Paths 120 Invariants 121 Templates 122 Foreign Languages 122 Archetype Examples 123 Blood Pressure 124 problem/SOAP Headings 127 Haematology result 131 Complete Blood Count (CBC) 132 APGAR 134 Template Examples 138
Ante-natal Visit 138
Diabetic Review Contact 138 Querying 138 Production Rules 139 Generic Syntax 139 O