Release 1.0.1 The openEHR Archetype Model Archetype Definition Language ADL 1.4 Editors: {T Beale, S Heard}a Revision: 1.4.0 Pages: 115 Date of issue: 13 Mar 2007 a. Ocean Informatics Keywords: EHR, ADL, health records, modelling, constraints EHR Extract EHR Demographic Integration Template OM Composition openEHR Archetype Profile Security Common Archetype OM ADL Data Structures Data Types Support © 2003-2007 The openEHR Foundation. The openEHR Foundation is an independent, non-profit community, facilitating the sharing of health records by consumers and clinicians via open-source, standards-based implementations. Founding David Ingram, Professor of Health Informatics, Chairman CHIME, University College London Founding Dr P Schloeffel, Dr S Heard, Dr D Kalra, D Lloyd, T Beale Members email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Copyright Notice © Copyright openEHR Foundation 2001 - 2007 All Rights Reserved 1. This document is protected by copyright and/or database right throughout the world and is owned by the openEHR Foundation. 2. You may read and print the document for private, non-commercial use. 3. You may use this document (in whole or in part) for the purposes of making presentations and education, so long as such purposes are non-commercial and are designed to comment on, further the goals of, or inform third parties about, openEHR. 4. You must not alter, modify, add to or delete anything from the document you use (except as is permitted in paragraphs 2 and 3 above). 5. You shall, in any use of this document, include an acknowledgement in the form: "© Copyright openEHR Foundation 2001-2007. All rights reserved. www.openEHR.org" 6. This document is being provided as a service to the academic community and on a non-commercial basis. Accordingly, to the fullest extent permitted under applicable law, the openEHR Foundation accepts no liability and offers no warranties in relation to the materials and documentation and their content. 7. If you wish to commercialise, license, sell, distribute, use or otherwise copy the materials and documents on this site other than as provided for in paragraphs 1 to 6 above, you must comply with the terms and conditions of the openEHR Free Commercial Use Licence, or enter into a separate written agreement with openEHR Foundation covering such activities. The terms and conditions of the openEHR Free Commercial Use Licence can be found at http://www.openehr.org/free_commercial_use.htm Date of Issue: 13 Mar 2007 Page 2 of 115 Editors:{T Beale, S Heard} © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Amendment Record Issue Details Raiser Completed R E L E A S E 1.0.1 1.4.0 CR-000203: Release 1.0 explanatory text improvements. T Beale 13 Mar 2007 Improve Archetype slot explanation. CR-000208: Improve ADL grammar for assertion expressions. T Beale CR-000160: Duration constraints. Added ISO 8601 patterns for S Heard duration in cADL. CR-000213: Correct ADL grammar for date/times to be prop- T Beale erly ISO8601-compliant. Include ‘T’ in cADL patterns and dADL and cADL Date/time, Time and Duration values. CR-000216: Allow mixture of W, D etc in ISO8601 Duration S Heard (deviation from standard). CR-000200: Correct Release 1.0 typographical errors. A Patterson R Chen S Garde T Beale CR-000225: Allow generic type names in ADL. M Forss CR-000226: Rename C_CODED_TEXT to C_CODE_PHRASE T Beale CR-000233: Define semantics for occurrences on K Atalag ARCHETYPE_INTERNAL_REF. CR-000241: Correct cADL grammar for archeype slot match S Heard expressions CR-000223: Clarify quoting rules in ADL A Patterson CR-000242: Allow non-inclusive two-sided ranges in ADL. S Heard CR-000245: Allow term bindings to paths in archetypes. S Heard R E L E A S E 1.0 1.3.1 CR-000136. Add validity rules to ADL document. T Beale 18 Jan 2006 CR-000171. Add validity check for cardinality & occurrences A Maldondo 1.3.0 CR-000141. Allow point intervals in ADL. Updated atomic S Heard 18 Jun 2005 types part of cADL section and dADL grammar section. CR-000142. Update dADL grammar to support assumed val- T Beale ues. CR-000143. Add partial date/time values to dADL syntax. T Beale CR-000149. Add URIs to dADL and remove query() syntax. T Beale CR-000153. Synchronise ADL and AOM for language T Beale attributes CR-000156. Update documentation of container types. T Beale CR-000138. Archetype-level assertions. T Beale R E L E A S E 0.95 1.2.1 CR-000125. C_QUANTITY example in ADL manual uses old T Beale 11 Feb 2005 dADL syntax. CR-000115. Correct "/[xxx]" path grammar error in ADL. T Beale Create new section describing ADL path syntax. CR-000127. Restructure archetype specifications. Remove T Beale clinical constraint types section of document. Editors:{T Beale, S Heard} Page 3 of 115 Date of Issue: 13 Mar 2007 © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Issue Details Raiser Completed 1.2 CR-000110. Update ADL document and create AOM docu- 15 Nov 2004 ment. T Beale Added explanatory material; added domain type support; rewrote of most dADL sections. Added section on assumed val- ues, “controlled” flag, nested container structures. Change lan- guage handling. Rewrote OWL section based on input from: A Rector - University of Manchester, UK, R Qamar - University Seville, Spain. I Román Martínez Various changes to assertions due to input from the DSTC. A Goodchild Z Z Tun Detailed review from Clinical Information Project, Australia. E Browne Remove UML models to “Archetype Object Model” docu- T Beale ment. Detailed review from UCL. T Austin CR-000103. Redevelop archetype UML model, add new key- T Beale words: allow_archetype, include, exclude. CR-000104. Fix ordering bug when use_node used. Required K Atalag parser rules for identifiers to make class and attribute identifiers distinct. Added grammars for all parts of ADL, as well as new UML diagrams. R E L E A S E 0.9 1.1 CR-000079. Change interval syntax in ADL. T Beale 24 Jan 2004 1.0 CR-000077. Add cADL date/time pattern constraints. S Heard, 14 Jan 2004 CR-000078. Add predefined clinical types. T Beale Better explanation of cardinality, occurrences and existence. 0.9.9 CR-000073. Allow lists of Reals and Integers in cADL. T Beale, 28 Dec 2003 CR-000075. Add predefined clinical types library to ADL. S Heard Added cADL and dADL object models. 0.9.8 CR-000070. Create Archetype System Description. T Beale, 29 Nov 2003 Moved Archetype Identification Section to new Archetype Sys- S Heard tem document. Copyright Assgined by Ocean Informatics P/L Australia to The openEHR Foundation. 0.9.7 Added simple value list continuation (“,...”). Changed path syn- T Beale 01 Nov 2003 tax so that trailing ‘/’ required for object paths. Remove ranges with excluded limits. Added terms and term lists to dADL leaf types. 0.9.6 Additions during HL7 WGM Memphis Sept 2003 T Beale 09 Sep 2003 0.9.5 Added comparison to other formalisms. Renamed CDL to T Beale 03 Sep 2003 cADL and dDL to dADL. Changed path syntax to conform (nearly) to Xpath. Numerous small changes. 0.9 Rewritten with sections on cADL and dDL. T Beale 28 July 2003 0.8.1 Added basic type constraints, re-arranged sections. T Beale 15 July 2003 0.8 Initial Writing T Beale 10 July 2003 Date of Issue: 13 Mar 2007 Page 4 of 115 Editors:{T Beale, S Heard} © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Trademarks “Microsoft” and “.Net” are registered trademarks of the Microsoft Corporation. “Java” is a registered trademark of Sun Microsystems. “Linux” is a registered trademark of Linus Torvalds. Acknowledgements Sebastian Garde, Central Qld University, Australia, for german translations. Editors:{T Beale, S Heard} Page 5 of 115 Date of Issue: 13 Mar 2007 © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Date of Issue: 13 Mar 2007 Page 6 of 115 Editors:{T Beale, S Heard} © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 Table of Contents 1 Introduction.............................................................................11 1.1 Purpose.................................................................................................11 1.2 Related Documents..............................................................................11 1.3 Nomenclature.......................................................................................11 1.4 Status....................................................................................................11 1.5 Peer review..........................................................................................12 1.6 Conformance........................................................................................12 2 Overview.................................................................................13 2.1 What is ADL?......................................................................................13 2.1.1 Structure.........................................................................................13 2.1.2 An Example...................................................................................14 2.1.3 Semantics.......................................................................................15 2.2 Computational Context........................................................................16 2.3 XML form of Archetypes....................................................................16 2.4 Changes From Previous Versions........................................................17 2.4.1 Version 1.4 from Version 1.3.........................................................17 2.4.2 Version 1.3 from Version 1.2.........................................................17 2.4.3 Version 1.2 from Version 1.1.........................................................18 2.4.4 The Future: ADL Version 2.0........................................................19 2.5 Tools.....................................................................................................20 3 File Encoding and Character Quoting.................................21 3.1 File Encoding.......................................................................................21 3.2 Special Character Sequences...............................................................22 4 dADL - Data ADL..................................................................23 4.1 Overview..............................................................................................23 4.2 Basics...................................................................................................24 4.2.1 Scope of a dADL Document..........................................................24 4.2.2 Keywords.......................................................................................24 4.2.3 Reserved Characters......................................................................24 4.2.4 Comments......................................................................................25 4.2.5 Information Model Identifiers.......................................................25 4.2.6 Semi-colons...................................................................................25 4.3 Paths.....................................................................................................25 4.4 Structure...............................................................................................26 4.4.1 General Form.................................................................................26 4.4.1.1 Outer Delimiters ..........................................................................................26 4.4.1.2 Paths ............................................................................................................27 4.4.2 Empty Sections..............................................................................27 4.4.3 Container Objects..........................................................................27 4.4.3.1 Paths ............................................................................................................29 4.4.4 Nested Container Objects..............................................................29 4.4.4.1 Paths ............................................................................................................30 4.4.5 Adding Type Information..............................................................30 4.4.6 Associations and Shared Objects...................................................31 4.4.6.1 Paths ............................................................................................................32 4.5 Leaf Data - Built-in Types...................................................................32 Editors:{T Beale, S Heard} Page 7 of 115 Date of Issue: 13 Mar 2007 © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 4.5.1 Primitive Types.............................................................................32 4.5.1.1 Character Data ............................................................................................32 4.5.1.2 String Data ..................................................................................................32 4.5.1.3 Integer Data .................................................................................................33 4.5.1.4 Real Data .....................................................................................................33 4.5.1.5 Boolean Data ...............................................................................................33 4.5.1.6 Dates and Times ..........................................................................................33 4.5.2 Intervals of Ordered Primitive Types............................................34 4.5.3 Other Built-in Types......................................................................35 4.5.3.1 URIs ............................................................................................................35 4.5.3.2 Coded Terms ...............................................................................................35 4.5.4 Lists of Built-in Types...................................................................35 4.6 Plug-in Syntaxes..................................................................................36 4.7 Expression of dADL in XML..............................................................36 4.8 Syntax Specification............................................................................38 4.8.1 Grammar........................................................................................39 4.8.2 Symbols.........................................................................................44 4.9 Syntax Alternatives.............................................................................46 4.9.1 Container Attributes......................................................................46 5 cADL - Constraint ADL........................................................49 5.1 Overview.............................................................................................49 5.2 Basics...................................................................................................50 5.2.1 Keywords......................................................................................50 5.2.2 Comments......................................................................................51 5.2.3 Information Model Identifiers.......................................................51 5.2.4 Node Identifiers.............................................................................51 5.2.5 Natural Language..........................................................................51 5.3 Structure..............................................................................................52 5.3.1 Complex Objects...........................................................................52 5.3.2 Attribute Constraints.....................................................................53 5.3.2.1 Existence .....................................................................................................53 5.3.3 Single-valued Attributes................................................................54 5.3.4 Container Attributes......................................................................55 5.3.4.1 Cardinality ...................................................................................................55 5.3.4.2 Occurrences .................................................................................................55 5.3.5 “Any” Constraints.........................................................................56 5.3.6 Object Node Identification and Paths............................................57 5.3.7 Internal References........................................................................59 5.3.8 Archetype Slots.............................................................................60 5.3.9 Placeholder Constraints.................................................................62 5.3.10 Mixed Structures...........................................................................63 5.4 Constraints on Primitive Types...........................................................63 5.4.1 Constraints on String.....................................................................64 5.4.1.1 List of Strings ..............................................................................................64 5.4.1.2 Regular Expression .....................................................................................64 5.4.2 Constraints on Integer...................................................................65 5.4.2.1 List of Integers ............................................................................................65 5.4.2.2 Interval of Integer .......................................................................................66 5.4.3 Constraints on Real.......................................................................66 5.4.4 Constraints on Boolean.................................................................66 Date of Issue: 13 Mar 2007 Page 8 of 115 Editors:{T Beale, S Heard} © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 5.4.5 Constraints on Character................................................................66 5.4.5.1 List of Characters ........................................................................................66 5.4.5.2 Regular Expression .....................................................................................66 5.4.6 Constraints on Dates, Times and Durations...................................67 5.4.6.1 Date, Time and Date/Time ..........................................................................67 5.4.6.2 Duration Constraints ...................................................................................68 5.4.7 Constraints on Lists of Primitive types..........................................69 5.4.8 Assumed Values.............................................................................69 5.5 Syntax Specification............................................................................70 5.5.1 Grammar........................................................................................70 5.5.2 Symbols.........................................................................................74 6 Assertions................................................................................79 6.1 Overview..............................................................................................79 6.2 Keywords.............................................................................................79 6.3 Operators..............................................................................................79 6.3.1 Arithmetic Operators.....................................................................79 6.3.2 Equality Operators.........................................................................80 6.3.3 Relational Operators......................................................................80 6.3.4 Boolean Operators.........................................................................80 6.3.5 Quantifiers.....................................................................................80 6.4 Operands..............................................................................................80 6.5 Precedence and Parentheses.................................................................81 6.6 Future...................................................................................................81 6.6.1 Variables........................................................................................81 6.7 Syntax Specification............................................................................82 6.7.1 Grammar........................................................................................82 7 ADL Paths ..............................................................................85 7.1 Overview..............................................................................................85 7.2 Relationship with W3C Xpath.............................................................85 7.3 Path Syntax..........................................................................................86 7.3.1 Grammar........................................................................................86 7.3.2 Symbols.........................................................................................86 8 ADL - Archetype Definition Language................................89 8.1 Introduction..........................................................................................89 8.2 Basics...................................................................................................89 8.2.1 Keywords.......................................................................................89 8.2.2 Node Identification........................................................................89 8.2.3 Local Constraint Codes..................................................................90 8.3 Header Sections...................................................................................90 8.3.1 Archetype Section..........................................................................90 8.3.2 Controlled Indicator.......................................................................90 8.3.3 Specialise Section..........................................................................90 8.3.4 Concept Section.............................................................................91 8.3.5 Language Section and Language Translation................................91 8.3.6 Description Section........................................................................91 8.4 Definition Section................................................................................93 8.4.1 Design-time and Run-time paths...................................................94 8.5 Invariant Section..................................................................................95 Editors:{T Beale, S Heard} Page 9 of 115 Date of Issue: 13 Mar 2007 © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org Archetype Definition Language ADL 1.4 Rev 1.4.0 8.6 Ontology Section.................................................................................95 8.6.1 Overview.......................................................................................95 8.6.2 Ontology Header Statements.........................................................96 8.6.3 Term_definitions Section..............................................................96 8.6.4 Constraint_definition Section........................................................97 8.6.5 Term_binding Section...................................................................97 8.6.6 Constraint_binding Section...........................................................99 8.7 Revision History Section.....................................................................99 8.8 Validity Rules....................................................................................100 8.8.1 Global Archetype Validity...........................................................100 8.8.2 Coded Term Validity...................................................................100 8.8.3 Definition Section.......................................................................100 8.9 Syntax Specification..........................................................................101 8.9.1 Grammar......................................................................................101 8.9.2 Symbols.......................................................................................102 9 Customising ADL................................................................. 105 9.1 Introduction.......................................................................................105 9.1.1 Custom Syntax............................................................................106 10 Relationship of ADL to Other Formalisms.......................109 10.1 Overview...........................................................................................109 10.2 Constraint Syntaxes...........................................................................109 10.2.1 OCL (Object Constraint Language)............................................109 10.3 Ontology Formalisms........................................................................109 10.3.1 OWL (Web Ontology Language)................................................109 10.3.2 KIF (Knowledge Interchange Format)........................................111 10.4 XML-based Formalisms....................................................................112 10.4.1 XML-schema...............................................................................112 Date of Issue: 13 Mar 2007 Page 10 of 115 Editors:{T Beale, S Heard} © 2003-2007 The openEHR Foundation. email: [email protected] web: http://www.openEHR.org