Changes between Version 4 and Version 5 of Support Information Model


Ignore:
Timestamp:
Aug 27, 2008, 8:42:18 PM (16 years ago)
Author:
KOBAYASHI, Shinji
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Support Information Model

    v4 v5  
    114114
    115115Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    116 
    117 ==== Table of Contents ==== #LinkTarget_15625
    118 ----
    119  * [wiki:"Support Information Model Copyright Notice" Copyright Notice]
    120  * [wiki:"Support Information Model Amendment Record" Amendment Record]
    121  * [wiki:"Support Information Model Table of Contents" Table of Contents]
    122  * [wiki:"Support Information Model 1 Introduction" 1 Introduction]
    123    * [wiki:"Support Information Model 1.1 Purpose" 1.1 Purpose]
    124    * [wiki:"Support Information Model 1.2 Related Documents" 1.2 Related Documents]
    125    * [wiki:"Support Information Model 1.3 Status" 1.3 Status]
    126    * [wiki:"Support Information Model 1.4 Peer review" 1.4 Peer review]
    127    * [wiki:"Support Information Model 1.5 Conformance" 1.5 Conformance]
    128  * [wiki:"Support Information Model 2 Support Package" 2 Support Package]
    129    * [wiki:"Support Information Model 2.1 Overview" 2.1 Overview]
    130    * [wiki:"Support Information Model 2.2 Class Definitions" 2.2 Class Definitions]
    131      * [wiki:"Support Information Model 2.2.1 EXTERNAL_ENVIRONMENT_ACCESS Class" 2.2.1 EXTERNAL_ENVIRONMENT_ACCESS Class]
    132  * [wiki:"Support Information Model 3 Assumed Types" 3 Assumed Types]
    133    * [wiki:"Support Information Model 3.1 Overview" 3.1 Overview]
    134    * [wiki:"Support Information Model 3.2 Inbuilt Primitive Types" 3.2 Inbuilt Primitive Types]
    135      * [wiki:"Support Information Model 3.2.1 Any Type" 3.2.1 Any Type]
    136      * [wiki:"Support Information Model 3.2.2 Ordered Type" 3.2.2 Ordered Type]
    137      * [wiki:"Support Information Model 3.2.3 Numeric Type" 3.2.3 Numeric Type]
    138      * [wiki:"Support Information Model 3.2.4 Ordered_numeric Type" 3.2.4 Ordered_numeric Type]
    139      * [wiki:"Support Information Model 3.2.5 Boolean Type" 3.2.5 Boolean Type]
    140      * [wiki:"Support Information Model 3.2.6 Real Type" 3.2.6 Real Type]
    141    * [wiki:"Support Information Model 3.3 Assumed Library Types" 3.3 Assumed Library Types]
    142      * [wiki:"Support Information Model 3.3.1 String Type" 3.3.1 String Type]
    143        * [wiki:"Support Information Model 3.3.1.1 UNICODE" 3.3.1.1 UNICODE]
    144      * [wiki:"Support Information Model 3.3.2 Aggregate Type" 3.3.2 Aggregate Type]
    145      * [wiki:"Support Information Model 3.3.3 List Type" 3.3.3 List Type]
    146      * [wiki:"Support Information Model 3.3.4 Set Type" 3.3.4 Set Type]
    147      * [wiki:"Support Information Model 3.3.5 Array Type" 3.3.5 Array Type]
    148      * [wiki:"Support Information Model 3.3.6 Hash Type" 3.3.6 Hash Type]
    149      * [wiki:"Support Information Model 3.3.7 Interval Type" 3.3.7 Interval Type]
    150    * [wiki:"Support Information Model 3.4 Date/Time Types" 3.4 Date/Time Types]
    151      * [wiki:"Support Information Model 3.4.1 TIME_DEFINITIONS Class" 3.4.1 TIME_DEFINITIONS Class]
    152      * [wiki:"Support Information Model 3.4.2 ISO8601_DATE Class" 3.4.2 ISO8601_DATE Class]
    153      * [wiki:"Support Information Model 3.4.3 ISO8601_TIME Class" 3.4.3 ISO8601_TIME Class]
    154      * [wiki:"Support Information Model 3.4.4 ISO8601_DATE_TIME Class" 3.4.4 ISO8601_DATE_TIME Class]
    155      * [wiki:"Support Information Model 3.4.5 ISO8601_TIMEZONE Class" 3.4.5 ISO8601_TIMEZONE Class]
    156      * [wiki:"Support Information Model 3.4.6 ISO8601_DURATION Class" 3.4.6 ISO8601_DURATION Class]
    157  * [wiki:"Support Information Model 4 Identification Package" 4 Identification Package]
    158    * [wiki:"Support Information Model 4.1 Overview" 4.1 Overview]
    159      * [wiki:"Support Information Model 4.1.1 Requirements" 4.1.1 Requirements]
    160    * [wiki:"Support Information Model 4.2 Design" 4.2 Design]
    161      * [wiki:"Support Information Model 4.2.1 Primitive Identifiers" 4.2.1 Primitive Identifiers]
    162      * 4.2.2 Composite Identifiers
    163      * 4.2.3 References
    164    * [wiki:"Support Information Model 4.3 Class Descriptions" 4.3 Class Descriptions]
    165      * 4.3.1 UID Class
    166      * 4.3.2 ISO_OID Class
    167      * 4.3.3 UUID Class
    168      * 4.3.4 INTERNET_ID Class
    169        * 4.3.4.1 Syntax
    170      * 4.3.5 OBJECT_ID Class
    171      * 4.3.6 UID_BASED_ID Class
    172        * 4.3.6.1 Identifier Syntax
    173      * 4.3.7 HIER_OBJECT_ID Class
    174      * 4.3.8 OBJECT_VERSION_ID Class
    175        * 4.3.8.1 Identifier Syntax
    176      * 4.3.9 VERSION_TREE_ID Class
    177        * 4.3.9.1 Syntax
    178      * 4.3.10 ARCHETYPE_ID Class
    179        * 4.3.10.1 Archetype ID Syntax
    180      * 4.3.11 TEMPLATE_ID Class
    181      * 4.3.12 TERMINOLOGY_ID Class
    182        * 4.3.12.1 Identifier Syntax
    183      * 4.3.13 GENERIC_ID Class
    184      * 4.3.14 OBJECT_REF Class
    185      * 4.3.15 ACCESS_GROUP_REF Class
    186      * 4.3.16 PARTY_REF Class
    187      * 4.3.17 LOCATABLE_REF Class
    188  * [wiki:"Support Information Model 5 Terminology Package" 5 Terminology Package]
    189    * 5.1 Overview
    190    * 5.2 Service Interface
    191      * 5.2.1 Code Sets
    192      * 5.2.2 Terminologies
    193      * 5.2.3 Terms and Codes in the openEHR Reference Model
    194    * 5.3 Identifiers
    195      * 5.3.1 Code Set Identifiers
    196      * 5.3.2 Terminology Identifiers
    197    * 5.4 Class Definitions
    198      * 5.4.1 TERMINOLOGY_SERVICE Class
    199      * 5.4.2 TERMINOLOGY_ACCESS Class
    200      * 5.4.3 CODE_SET_ACCESS Class
    201      * 5.4.4 OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS Class
    202      * 5.4.5 OPENEHR_CODE_SET_IDENTIFIERS Class
    203  * [wiki:"Support Information Model 6 Measurement Package" 6 Measurement Package]
    204    * 6.1 Overview
    205    * 6.2 Service Interface
    206      * 6.2.1 Class Definitions
    207        * 6.2.1.1 MEASUREMENT_SERVICE Class
    208  * [wiki:"Support Information Model 7 Definition Package" 7 Definition Package]
    209    * 7.1 Overview
    210    * 7.2 Class Definitions
    211      * 7.2.1 OPENEHR_DEFINITIONS Class
    212      * 7.2.2 BASIC_DEFINITIONS Class
    213  * [wiki:"Support Information Model A References" A References]
    214    * A.1 General
    215 
    216 
    217 == Introduction == #LinkTarget_15939
    218 === 1.1 Purpose === #LinkTarget_15941
    219 This document describes the openEHR Support Reference Model, whose semantics are used by all openEHR Reference Models. The intended audience includes:
    220 
    221  * Standards bodies producing health informatics standards;
    222  * Software development organisations developing EHR systems;
    223  * Academic groups studying the EHR;
    224  * The open source healthcare community.
    225 
    226 === 1.2 Related Documents === #LinkTarget_15957
    227 Prerequisite documents for reading this document include:
    228 
    229  * The openEHR Architecture Overview
    230  * The openEHR Modelling Guide
    231 
    232 === 1.3 Status === #LinkTarget_15967
    233 This document is under development, and is published as a proposal for input to standards processes and implementation works.
    234 
    235 This document is available at [http://svn.openehr.org/specification/TAGS/Release-1.0.1/publishing/architecture/rm/support_im.pdf http://svn.openehr.org/specification/TAGS/Release] [http://svn.openehr.org/specification/TAGS/Release-1.0.1/publishing/architecture/rm/support_im.pdf 1.0.1/publishing/architecture/rm/support_im.pdf.]
    236 
    237 The latest version of this document can be found at [http://svn.openehr.org/specification/TRUNK/publishing/architecture/rm/support_im.pdf http://svn.openehr.org/specifica] [http://svn.openehr.org/specification/TRUNK/publishing/architecture/rm/support_im.pdf tion/TRUNK/publishing/architecture/rm/support_im.pdf.]
    238 
    239 Blue text indicates sections under active development.
    240 
    241 === 1.4 Peer review === #LinkTarget_15979
    242 Areas where more analysis or explanation is required are indicated with “to be continued” paragraphs like the following:
    243 
    244 To Be Continued: more work required
    245 
    246 Reviewers are encouraged to comment on and/or advise on these paragraphs as well as the main content. Please send requests for information to [mailto:info@gehr.org info@openEHR.org. Feedback should preferably be] provided on the mailing list [mailto:openehr-technical@openehr.org openehr-technical@openehr.org, or by private email.]
    247 
    248 === 1.5 Conformance === #LinkTarget_15987
    249 Conformance of a data or software artifact to an openEHR Reference Model specification is determined by a formal test of that artifact against the relevant openEHR Implementation Technology Specification(s) (ITSs), such as an IDL interface or an XML-schema. Since ITSs are formal, automated derivations from the Reference Model, ITS conformance indicates RM conformance.
    250 
    251 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 9 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    252 
    253   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    254 
    255 Introduction [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    256 
    257 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 10 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    258 
    259 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    260 
    261 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Support Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    262 
    263 == Support Package == #LinkTarget_16016
    264 === 2.1 Overview === #LinkTarget_16019
    265 The Support Reference Model comprises types used throughout the openEHR models, including assumed primitive types defined outside of openEHR. The package structure is illustrated in [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16040 FIGURE]
    266 
    267 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16040 1.]  The assumed_types ‘pseudo-package’ stands for types assumed by the openEHR specifcations to exist in an implementation technology, such as a programming language, schema language or database environment. The four Support packages define the semantics respectively for constants, terminology access, access to externally defined scientific units and conversion information. The class EXTERNAL_ENVIRONMENT_ACCESS is a mixin class providing access to the service interface classes.
    268 
    269 support
    270 
    271 ==== definition ====
    272 identification
    273 
    274 ||assumed_types||
    275 ||FIGURE 1||rm.support and assumed_types Packages||
    276 ||2.2 2.2.1||Class Definitions EXTERNAL_ENVIRONMENT_ACCESS Class||
    277 
    278 ||CLASS||EXTERNAL_ENVIRONMENT_ACCESS (abstract)||
    279 ||Purpose||A mixin class providing access to services in the external environment.||
    280 ||Functions||Signature||Meaning||
    281 ||||eea_terminology_svc: TERMINOLOGY_SERVICE||Return an interface to the terminology service||
    282 ||||eea_measurement_svc: MEASUREMENT_SERVICE||Return an interface to the measurement service||
    283 
    284 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 11 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    285 
    286   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    287 
    288 Support Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    289 
    290 Terminology_service_exists: eea_terminology_svc /= Void Measurement_service_exists: eea_measurement_svc /= Void
    291 
    292 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 12 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    293 
    294 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    295 
    296 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    297 
    298 == Assumed Types == #LinkTarget_16093
    299 === 3.1 Overview === #LinkTarget_16095
    300 This section describes types assumed by all openEHR models. The set of types chosen here is based on a common set from various published sources, including:
    301 
    302  * ISO 11404 (2003 revision) general purpose data types;
    303  * ISO 8601 (2004) date/time specification;
    304  * Well-known interoperability formalisms, including OMG IDL, W3C XML-schema;
    305  * Well-known object-oriented programming languages, including Java, C#, C++ and Eiffel.
    306 
    307 The intention in openEHR is twofold. Firstly, to ensure that openEHR software based on the models integrates as easily as possible with existing implementation technologies, and secondly, to make the minimum possible assumptions about types found in implementation formalisms, while making sufficient assumptions to both enable openEHR models to be conveniently specified. The ISO 11404 (2003) standard contains basic semantics of “general purpose data types” (GPDs) for information technology, and is used here as a normative basis for describing assumptions about types. The operations and properties described here are compatible with those used in ISO 11404, but not always the same, as 11404 does not use object-oriented functions. For example, the notional function has(!x:T) (test for presence of a value in a set) defined on the type Set<T> below is not defined on the ISO 11404 Set type; instead, the function !IsIn(x: T; s: Set<T>) is defined. However, in object-oriented formalisms, the function !IsIn defined on a Set type would usually mean ‘subset of’. In the interests of clarity for developers, an object-oriented style of functions and properties has been used here.
    308 
    309 !ISO8601:2004 is used as the definitional basis for assumed date/time types, since it is commonly used [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16711 around the world, and is also the basis for the date/time types in W3C XML-schema. See section 3.4] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16711 on page 22]  below for details of dates and times.
    310 
    311 Two groups of assumed types are identified: primitive types, which are those built in to a formalism’s type system, and library types, which are assumed to be available in a (class) library defined in the formalism. Thus, the type Boolean is always assumed to exist in a formalism, while the type Array<T> is assumed to be available in a library. For practical purposes, these two categories do not matter that much - whether String is really a library class (the usual case) or an inbuilt type doesn’t make much difference to the programmer. They are shown separately here mainly as an explanatory convenience.
    312 
    313 The assumptions that openEHR makes about existing types are documented below in terms of interface definitions. Each of these definitions contains only the assumptions required for the given type to be used in the openEHR Reference Model -it is not by any means a complete interface definition. The name and semantics of any function used here for an assumed type might not be identical to those found in some implementation technologies. Any mapping required should be stated in the relevant implementation technology specification (ITS). To give a concrete example, where the assumed Set<T> type defined below has an operation has(item: T): Boolean which is used throughout the openEHR specifications, Java has the method contains() on its Set<T> class. In a Java implementation, the contains() method should then be used throughout the openEHR classes as expressed in Java, in place of the has() method.
    314 
    315 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 13 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    316 
    317   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    318 
    319 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    320 
    321 === 3.2 Inbuilt Primitive Types === #LinkTarget_16135
    322 The following types consititute the minimum set of primitive types assumed by openEHR of an implementation formalism.
    323 
    324 ||Type name in openEHR||Description||ISO 11404 Type||
    325 ||Octet||represents a type whose value is an 8-bit value.||Octet||
    326 ||Character||represents a type whose value is a member of an 8-bit character-set (ISO: “repertoire”).||Character||
    327 ||Boolean||represents logical True/False values; usually physically represented as an integer, but need not be||Boolean||
    328 ||||||||
    329 ||Integer||represents 32-bit integers||Integer||
    330 ||Real||represents 32-bit real numbers in any interoperable representation, including single-width IEEE floating point||Real||
    331 ||Double||type which represents 64-bit real numbers, in any interoperable representation including double-precision IEEE floating point.||Real||
    332 
    333 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16193 FIGURE 2]  illustrates the built-in primitive types. Simple inheritance relationships are shown which facilitate the type descriptions below. A class “Any” is used to stand for the usual top-level class in all object-oriented type systems, typically called something like “Any” or “Object”. Inheritance from or subsitutability for an Any class is not assumed in openEHR (hence the dotted lines in the UML). It is used here to enable basic operations like ‘=’ to be described once for the type Any, rather than in every subtype. The type Ordered_numeric is on the other hand assumed for purposes of specification in the openEHR data_types.quantity package, and is intended to be mapped to an equivalent type in a real type system (e.g. in Java, java.lang.Number). Here it is assumed that the operations defined on Ordered_numericare available on the types Integer, Realand Double in implementation type systems, where relevant. Data-oriented implementation type systems such as XML-schema do not have such operations.
    334 
    335 ''Any ''
    336 
    337 ==== Octet ====
    338 Character
    339 
    340 Boolean
    341 
    342 ''Ordered ''
    343 
    344 ''Numeric ''
    345 
    346 ''Ordered_numeric ''
    347 
    348 FIGURE 2  Primitive Types Assumed by openEHR
    349 
    350 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 14 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    351 
    352 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    353 
    354 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    355 
    356 3.2.1 Any Type
    357 
    358 ||INTERFACE||Any (abstract)||
    359 ||Description||Abstract supertype. Usually maps to a type like “Any” or “Object” in an object system. Defined here to provide the value and reference equality semantics.||
    360 ||Abstract||Signature||Meaning||
    361 ||||is_equal (other: Any): Boolean||Value equality||
    362 ||Functions||Signature||Meaning||
    363 ||||infix ‘=’ (other: Any): Boolean||Reference equality||
    364 ||||instance_of (a_type: String)||Dynamic type of object as a String. Used for type name matching.||
    365 ||Invariants||||
    366 
    367 3.2.2 Ordered Type
    368 
    369 ||INTERFACE||Ordered (abstract)||
    370 ||Purpose||Abstract notional parent class of ordered, types i.e. types on which the ‘<‘ operator is defined.||
    371 ||Abstract||Signature||Meaning||
    372 ||||infix ‘<’ (other: like Current): Boolean||Arithmetic comparison. In conjunction with ‘=’, enables the definition of the operators ‘>’, ‘>=’, ‘<=’, ‘<>’. In real type systems, this operator might be defined on another class for comparability.||
    373 ||Invariants||||
    374 
    375 3.2.3 Numeric Type
    376 
    377 ||INTERFACE||Numeric (abstract)||
    378 ||Purpose||Abstract notional parent class of numeric types, which are types which have various arithmetic and comparison operators defined.||
    379 ||Abstract||Signature||Meaning||
    380 
    381 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 15 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    382 
    383   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    384 
    385 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    386 
    387 ||INTERFACE||Numeric (abstract)||
    388 ||||infix "*" (other: like Current): like Current require other_exists: other /= void ensure result_exists: Result /= void||Product by `other'. Actual type of result depends on arithmetic balancing rules.||
    389 ||||infix "+" (other: like Current): like Current require other_exists: other /= void ensure result_exists: Result /= void commutative: equal (Result, other + Current)||Sum with `other' (commutative). Actual type of result depends on arithmetic balancing rules.||
    390 ||||infix "-" (other: like Current): like Current require other_exists: other /= void ensure result_exists: Result /= void||Result of subtracting `other'. Actual type of result depends on arithmetic balancing rules.||
    391 ||Invariants||||
    392 
    393 3.2.4 Ordered_numeric Type
    394 
    395 ||INTERFACE||Ordered_numeric (abstract)||
    396 ||Purpose||Abstract notional parent class of ordered, numeric types, which are types with ‘<‘ and arithmetic operators defined.||
    397 ||Inherit||ORDERED, NUMERIC||
    398 ||Function||Signature||Meaning||
    399 ||Invariants||||
    400 
    401 3.2.5 Boolean Type
    402 
    403 ||INTERFACE||Boolean||||
    404 ||Purpose||Boolean type used for two-valued mathematical logic.||||
    405 ||Function||Signature||||Meaning||
    406 
    407 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 16 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    408 
    409 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    410 
    411 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    412 
    413   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    414 
    415 ||INTERFACE||Boolean||
    416 ||||infix "and" (other: Boolean): Boolean require other_exists: other /= void ensure de_morgan: Result = not (not Current or not other) commutative: Result = (other and Current)||Logical conjunction||
    417 ||||infix "and then" (other: Boolean): Boolean require other_exists: other /= void ensure de_morgan: Result = not (not Current or else not other)||Boolean semi-strict conjunction with other||
    418 ||||infix "or" (other: Boolean): Boolean require other_exists: other /= void ensure de_morgan: Result = not (not Current and not other) commutative: Result = (other or Current) consistent_with_semi_strict: Result implies (Current or else other)||Boolean disjunction with other||
    419 ||||infix "or else" (other: Boolean): Boolean require other_exists: other /= void ensure de_morgan: Result = not (not Current and then not other)||Boolean semi-strict disjunction with `other'||
    420 ||||infix "xor" (other: Boolean): Boolean require other_exists: other /= void ensure definition: Result = ((Current or other) and not (Current and other))||Boolean exclusive or with `other'||
    421 
    422 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 17 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    423 
    424 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    425 
    426 ||INTERFACE||Boolean||
    427 ||||infix "implies" (other: Boolean): Boolean require other_exists: other /= void ensure definition: Result = (not Current or else other)||Boolean implication of `other' (semi-strict)||
    428 ||Invariants||involutive_negation: is_equal (not (not Current)) non_contradiction: not (Current and (not Current)) completeness: Current or else (not Current)||
    429 
    430 3.2.6 Real Type
    431 
    432 ||INTERFACE||Real||
    433 ||Purpose||Type used to represent decimal numbers. Typically corresponds to a single-precision floating point value in most languages.||
    434 ||Function||Signature||Meaning||
    435 ||||floor: Integer||Return the greatest integer no greater than the value of this object.||
    436 ||Invariants||||
    437 
    438 === 3.3 Assumed Library Types === #LinkTarget_16425
    439 The types described in this section are also assumed to be fairly standard in implementation technologies by openEHR, but usually come from type libraries rather than being built into the type system of implementation formalisms.
    440 
    441 ||Type name in openEHR||Description||ISO 11404: 2003 Type||
    442 ||String||represents unicode-enabled strings||Character-String/Sequence||
    443 ||Array<T>||physical container of items indexed by number||Array||
    444 ||List<T>||container of items, implied order, non-unique membership||Sequence||
    445 ||Set<T>||container of items, no order, unique membership||Set||
    446 ||Hash<T,!U:Comparable>||a table of values of any type T, keyed by values of any basic comparable type U, typically String or Integer, but may be more complex types, e.g. a coded term type.||Table||
    447 ||Interval<T>||Intervals with open or closed upper and lower bounds.||-||
    448 
    449 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 18 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    450 
    451 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    452 
    453 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    454 
    455 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16487 FIGURE 3 illustrates the assumed library types. As with the assumed primitive types, inheritance and] abstract classes are used for convenience of the definitions below, but are not formally assumed in openEHR.
    456 
    457 ''Any ''
    458 
    459 T
    460 
    461 T->Ordered
    462 
    463 ''Aggregate''
    464 
    465 ==== String ====
    466 Interval
    467 
    468 FIGURE 3  Library Types Assumed by openEHR
    469 
    470 3.3.1 String Type
    471 
    472 ||INTERFACE||String||
    473 ||Description||Strings of characters, as used to represent textual data in any natural or formal language.||
    474 ||Functions||Signature||Meaning||
    475 ||||infix ‘+’ (other: String): String||Concatenation operator - causes ‘other’ to be appended to this string||
    476 ||||is_empty: Boolean||True if string is empty, i.e. equal to “”.||
    477 ||||is_integer: Boolean||True if string can be parsed as an integer.||
    478 ||||as_integer: Integer require is_integer||Return the integer corresponding to the integer value represented in this string.||
    479 ||Invariants||||
    480 
    481 ==== 3.3.1.1 UNICODE ==== #LinkTarget_16522
    482 It is assumed in the openEHR specifications that Unicode is supported by the type String. Unicode is needed for all Asian, Arabic and other script languages, for both data values (particularly plain text and coded text) and for many predefined string attributes of the classes in the openEHR Reference Model. It encompasses all existing character sets. In openEHR, UTF-8 encoding is assumed.
    483 
    484 === 3.3.2 Aggregate Type === #LinkTarget_16525
    485 Abstract parent of of the aggregate types List<T>, Set<T>, Array<T> and Hash<T,K>.
    486 
    487 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 19 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    488 
    489   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    490 
    491 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    492 
    493 ||INTERFACE||Aggregate <T> (abstract)||
    494 ||Functions||Signature||Meaning||
    495 ||||has (v: T): Boolean||Test for membership of a value||
    496 ||||count: Integer||Number of items in container||
    497 ||||is_empty: Boolean||True if container is empty.||
    498 ||Invariants||||
    499 
    500 3.3.3 List Type
    501 
    502 ||INTERFACE||List <T> (abstract)||
    503 ||Description||Ordered container that may contain duplicates.||
    504 ||Functions||Signature||Meaning||
    505 ||||first: T||Return first element.||
    506 ||||last: T||Return last element.||
    507 ||Invariants||First_validity: not is_empty implies first /= Void Last_validity: not is_empty implies last /= Void||
    508 
    509 3.3.4 Set Type
    510 
    511 ||INTERFACE||Set <T> (abstract)||
    512 ||Description||Unordered container that may not contain duplicates.||
    513 ||Functions||Signature||Meaning||
    514 ||Invariants||||
    515 
    516 3.3.5 Array Type
    517 
    518 ||INTERFACE||Array <T> (abstract)||
    519 ||Description||Container whose storage is assumed to be contiguous.||
    520 ||Functions||Signature||Meaning||
    521 ||Invariants||||
    522 
    523 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 20 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    524 
    525 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    526 
    527 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    528 
    529 3.3.6 Hash Type
    530 
    531 ||INTERFACE||Hash <T, U: Comparable>||
    532 ||Description||Type representing a keyed table of values. T is the value type, and U the type of the keys.||
    533 ||Functions||Signature||Meaning||
    534 ||||has_key (a_key: U): Boolean||Test for membership of a key||
    535 ||||item (a_key: U): T||Return item for key ‘a_key’. Equivalent to ISO 11404 fetch operation.||
    536 ||Invariants||||
    537 
    538 3.3.7 Interval Type
    539 
    540 ||INTERFACE||Interval <!T:Ordered>||
    541 ||Purpose||Interval of ordered items.||
    542 ||Attributes||Signature||Meaning||
    543 ||||lower: T||lower bound||
    544 ||||upper: T||upper bound||
    545 ||||lower_unbounded: Boolean||lower boundary open (i.e. = -infinity)||
    546 ||||upper_unbounded: Boolean||upper boundary open (i.e. = +infinity)||
    547 ||||lower_included: Boolean||lower boundary value included in range if not lower_unbounded||
    548 ||||upper_included: Boolean||upper boundary value included in range if not upper_unbounded||
    549 ||Functions||Signature||Meaning||
    550 ||||has(e:T): Boolean||True if (lower_unbounded or ((lower_included and v >= lower) or v > lower)) and (upper_unbounded or ((upper_included and v <= upper or v < upper)))||
    551 
    552 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 21 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    553 
    554   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    555 
    556 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    557 
    558 Lower_included_valid: lower_unbounded implies not lower_included Upper_included_valid: upper_unbounded implies not upper_included Limits_consistent: (not upper_unbounded and not lower_unbounded) implies lower <= upper Limits_comparable: (not upper_unbounded and not lower_unbounded) implies lower.strictly_comparable_to(upper)
    559 
    560 === 3.4 Date/Time Types === #LinkTarget_16711
    561 Although the ISO 11404 (2003) standard defines a date-and-time type generator (section 8.1.6), and a timeinterval type (section 10.1.6), a more widely used specification of date/times is given by ISO !8601:2004, which is used as the normative basis for both string literal representation and properties used within openEHR. The types are shown in [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_16718 FIGURE 4.]
    562 
    563 ''Any ''
    564 
    565 ''Ordered ''
    566 
    567 TIME_DEFINITIONS
    568 
    569 ISO 8601 semantics not used in openEHR include:
    570 
    571  * “expanded” dates, which have year numbers of greater than 4 digits, and may be negative; in openEHR, only 4-digit year numbers are assumed;
    572  * the YYYY-WW-DD method of expressing dates (since this is imprecise and difficult to compute with due to variable week starting dates, and not required in health);
    573  * partial date/times with fractional minutes or hours, e.g. hh,hhh or mm,mm; in openEHR, only fractional seconds are supported;
    574  * the interval syntax. Intervals of date/times are supported in openEHR, but their syntax form is defined by ADL, and is standardised across all comparable types, not just dates and times.
    575 
    576 ==== Deviations from the published standard include the following: ====
    577  * durations are supposed to take the form of PnnW or PnnYnnMnnDTnnHnnMnnS, but in openEHR, the W (week) designator can be used in combination with the other designators, since it is very common to state durations of pregnancy as some combination of weeks and days.
    578  * partial variants of ISO8601_DATE_TIME can include missing hours, days and months, whereas ISO !8601:2004 (section 4.3.3 c) only allows missing seconds and minutes. The reasons for this deviation are:
    579 
    580 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 22 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    581 
    582 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    583 
    584 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    585 
    586 -the same deviation is used in HL7v2 and HL7v3 TS (timestamp) type, i.e. there are data in existing clinical systems matching this specification;
    587 
    588 -in a typed object model, this deviation is more sensible anyway; the ISO 8601 rule is most likely a limitation of the purely syntactic means of expression. In real systems where a timestamp/date-time is specified in a screen form, it makes sense to allow it to be as partial as possible, rather than artifically restricted to only missing seconds and minutes.
    589 
    590 •         the time !24:00:00 (or 240000) is not allowed anywhere, whereas in !ISO8601:2004 it appears to be legal at least for times. This deviation is also appears to be used in HL7v2 and HL7v3 (where midnight is defined as the time !00:00:00), and is preferable to the documented standard, since a date/time with time of !24:00:00 is really the next day, i.e. the date part is then incorrect.
    591 
    592 The following class definitions provide an object-oriented expression of the semantics of the subset of ISO !8601:2004 used by openEHR.
    593 
    594 See [http://www.cl.cam.ac.uk/%7Emgk25/iso-time.html http://www.cl.cam.ac.uk/~mgk25/iso-time.html]  and the official ISO standard for ISO 8601 details. Note that in the date, time and date_time formats shown below, ‘Z’ and ‘T’ are literals. In the duration class shown below, ‘P’, ‘Y’, ‘M’, ‘W’, ‘D’, ‘H’, ‘S’ and ‘T’ are literals.
    595 
    596 3.4.1 TIME_DEFINITIONS Class
    597 
    598   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    599 
    600 ||INTERFACE||TIME_DEFINITIONS||
    601 ||Purpose||Definitions for date/time classes. Note that the timezone limits are set by where the international dateline is. Thus, time in New Zealand is quoted using !+12:00, not !-12:00.||
    602 ||Constants||Signature||Meaning||
    603 ||1..1||Seconds_in_minute: Integer = 60||||
    604 ||1..1||Minutes_in_hour: Integer = 60||||
    605 ||1..1||Hours_in_day: Integer = 24||||
    606 ||1..1||Nominal_days_in_month: Real = 30.42||Used for conversions of durations containing months to days and / or seconds.||
    607 ||1..1||Max_days_in_month: Integer = 31||Used for validity checking.||
    608 ||1..1||Days_in_year: Integer = 365||||
    609 ||1..1||Days_in_leap_year: Integer = 366||||
    610 ||1..1||Max_days_in_year: Integer = Days_in_leap_year||Used for validity checking.||
    611 
    612 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 23 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    613 
    614 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    615 
    616 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    617 
    618 ||INTERFACE||TIME_DEFINITIONS||
    619 ||1..1||Nominal_days_in_year: Real = 365.24||Used for conversions of durations containing years to days and / or seconds.||
    620 ||1..1||Days_in_week: Integer = 7||||
    621 ||1..1||Months_in_year: Integer = 12||||
    622 ||1..1||Min_timezone_hour: Integer ensure Result = 12||Minimum hour value of a timezone (note that the -ve sign is supplied in the ISO8601_TIMEZONE class).||
    623 ||1..1||Max_timezone_hour: Integer ensure Result = 13||Maximum hour value of a timezone.||
    624 ||Functions||Signature||Meaning||
    625 ||||valid_year (y: Integer): Boolean ensure Result = y >= 0||True if y >= 0||
    626 ||||valid_month (m: Integer): Boolean ensure Result = m >= 1 and m <= Months_in_year||True if m >= 1 and m <= Months_in_year||
    627 ||||valid_day (y, m, d: Integer): Boolean ensure Result = d >= 1 and d <= days_in_month(m, y)||True if d >= 1 and d <= days_in_month(m, y)||
    628 ||||valid_hour (h, m, s: Integer): Boolean ensure Result = (h >= 0 and h < Hours_in_day) or (h = Hours_in_day and m = 0 and s = 0)||True if (h >= 0 and h < Hours_in_day) or (h = Hours_in_day and m = 0 and s = 0)||
    629 ||||valid_minute (m: Integer): Boolean ensure Result = m >= 0 and m < Minutes_in_hour||True if m >= 0 and m < Minutes_in_hour||
    630 
    631 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 24 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    632 
    633 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    634 
    635 ||INTERFACE||TIME_DEFINITIONS||
    636 ||||valid_second (s: Integer): Boolean ensure Result = s >= 0 and s < Seconds_in_minute||True if s >= 0 and s < Seconds_in_minute||
    637 ||||valid_fractional_second (fs: Double): Boolean ensure Result = fs >= 0.0 and fs < 1.0||True if fs >= 0.0 and fs < 1.0||
    638 ||Invariants||||
    639 
    640 3.4.2 ISO8601_DATE Class
    641 
    642   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    643 
    644 ||INTERFACE||ISO8601_DATE||
    645 ||Purpose||Represents an absolute point in time, as measured on the Gregorian calendar, and specified only to the day.||
    646 ||Inherit||ORDERED, TIME_DEFINITIONS||
    647 ||Function||Signature||Meaning||
    648 ||||as_string: String||ISO8601 string for date, in format YYYYMMDD or YYYY-MM-DD, or a partial invariant. See valid_iso8601_date for validity.||
    649 ||||year: Integer||Year.||
    650 ||||month: Integer require not month_unknown||Month in year.||
    651 ||||day: Integerrequire not day_unknown||Day in month.||
    652 ||||month_unknown: Boolean||Indicates whether month in year is unknown. If so, the date is of the form “YYYY”.||
    653 ||||day_unknown: Boolean||Indicates whether day in month is unknown. If so, and month is known, the date is of the form “YYYY-MM” or “YYYYMM”.||
    654 ||||is_partial: Boolean||True if this date is partial, i.e. if day or more is missing.||
    655 
    656 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 25 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    657 
    658 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    659 
    660 ||INTERFACE||ISO8601_DATE||
    661 ||||is_extended: Boolean||True if this date uses ‘-’ separators.||
    662 ||||infix ‘<’ (other: like Current): Boolean||Arithmetic comparison with other date. True if this date is closer to the origin than other.||
    663 ||||valid_iso8601_date||String is a valid ISO 8601 date, i.e. takes the||
    664 ||||(s: String): Boolean||complete form: • YYYYMMDD or the extended form: • YYYY-MM-DD or one of the partial forms: • YYYYMM • YYYY or the equivalent extended form: • YYYY-MM Where: • YYYY is the string form of any positive number in the range “0000” - “9999” (zero-filled to four digits) • MM is “01” “12” (zero-filled to two digits) • DD is “01” - “31” (zero-filled to two digits) The combinations of YYYY, MM, DD numbers must be correct with respect to the Gregorian calendar.||
    665 ||Invariants||Year_valid: valid_year(year) Month_valid: not month_unknown implies valid_month(month) Day_valid: not day_unknown implies valid_day(year, month, day) Partial_validity: month_unknown implies day_unknown||
    666 
    667 3.4.3 ISO8601_TIME Class
    668 
    669 ||INTERFACE||ISO8601_TIME||
    670 ||Purpose||Represents an absolute point in time from an origin usually interpreted as meaning the start of the current day, specified to the second. A small deviation to the ISO !8601:2004 standard in this class is that the time !24:00:00 is not allowed, for consistency with ISO8601_DATE_TIME.||
    671 ||Inherit||ORDERED, TIME_DEFINITIONS||
    672 ||Function||Signature||Meaning||
    673 
    674 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 26 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    675 
    676 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    677 
    678 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    679 
    680 ||INTERFACE||||ISO8601_TIME||
    681 ||||as_string: String||||ISO8601 string for time, i.e. in form: hhmmss[,sss][Z|±hh[mm]] or the extended form: hh:mm:ss[,sss][Z|±hh[mm]], or a partial invariant. See valid_iso8601_time for validity.||
    682 ||||hour: Integer||||Hour in day, in 24-hour time.||
    683 ||||minute: Integer require not minute_unknown||||Minute in hour.||
    684 ||||second: Integer require not second_unknown||||Second in minute.||
    685 ||||fractional_second: Double require not second_unknown||||Fractional seconds.||
    686 ||||has_fractional_second: Boolean||||True if the fractional_second part is signficant (i.e. even if = 0.0).||
    687 ||||timezone: ISO8601_TIMEZONE minute_unknown: Boolean||||Time zone; may be Void. Indicates whether minute is unknown. If so, the time is of the form “hh”.||
    688 ||||
    689 ||||second_unknown: Boolean||||Indicates whether second is unknown. If so and month is known, the time is of the form “!hh:mm” or “hhmm”.||
    690 ||||is_partial: Boolean||||True if this time is partial, i.e. if seconds or more is missing.||
    691 ||||is_extended: Boolean||||True if this time uses ‘:’ separators.||
    692 ||||is_decimal_sign_comma: Boolean||||True if this time has a decimal part indicated by ‘,’ (comma) rather than ‘.’ (period).||
    693 ||||infix ‘<’ (other: like Current): Boolean||||Arithmetic comparison with other time. True if this date is closer to previous midnight than other.||
    694 
    695 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 27 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    696 
    697   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    698 
    699 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    700 
    701 ||INTERFACE||ISO8601_TIME||
    702 ||||valid_iso8601_time||String is a valid ISO 8601 date, i.e. takes the||
    703 ||||(s: String): Boolean||form: • hhmmss[,sss][Z | ±hh[mm]] or the extended form: • !hh:mm:ss[,sss][Z | ±hh[mm]] or one of the partial forms: • hhmm or hh or the extended form: • !hh:mm with an additional optional timezone indicator of: • Z or ±hh[mm] Where: • hh is “00” - “23” (0-filled to two digits) • mm is “00” - “59” (0-filled to two digits) • ss is “00” - “60” (0-filled to two digits) • sss is any numeric string, representing an optional fractional second • Z is a literal meaning UTC (modern replacement for GMT), i.e. timezone +0000 • ±hh[mm], i.e. +hhmm, +hh, -hhmm, -hh indicating the timezone.||
    704 ||Invariants||Hour_valid: valid_hour(hour, minute, second) Minute_valid: not minute_unknown implies valid_minute(minute) Second_valid: not second_unknown implies valid_second(second) Fractional_second_valid: has_fractional_second implies (not second_unknown and valid_fractional_second(fractional_second)) Partial_validity: minute_unknown implies second_unknown||
    705 
    706 3.4.4 ISO8601_DATE_TIME Class
    707 
    708 ||INTERFACE||ISO8601_DATE_TIME||
    709 ||Purpose||Represents an absolute point in time, specified to the second. Note that this class includes 2 deviations from ISO !8601:2004: • for partial date/times, any part of the date/time up to the month may be missing, not just seconds and minutes as in the standard; • the time !24:00:00 is not allowed, since it would mean the date was really on the next day.||
    710 ||Inherit||ORDERED, TIME_DEFINITIONS||
    711 ||Function||Signature||Meaning||
    712 
    713 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 28 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    714 
    715 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    716 
    717 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    718 
    719   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    720 
    721 ||INTERFACE||ISO8601_DATE_TIME||
    722 ||||as_string: String ensure valid_iso8601_date_time(Result)||ISO8601 string for date/time, in format YYYYMMDDThhmmss[,sss][Z | ±hh[mm]] or in extended format !YYYY-MM-DDThh:mm:ss[,sss][Z | ±hh[mm]] or a partial variant; see valid_iso8601_date_time() below.||
    723 ||||year: Integer||year||
    724 ||||month: Integerrequire not month_unknown||month in year||
    725 ||||day: Integerrequire not day_unknown||day in month||
    726 ||||hour: Integerrequire not hour_unknown||hour in day||
    727 ||||minute: Integer require not minute_unknown||minute in hour||
    728 ||||second: Integerrequire not second_unknown||second in minute||
    729 ||||fractional_second: Double require has_fractional_second||fractional seconds||
    730 ||||has_fractional_second: Boolean||True if the fractional_second part is signficant (i.e. even if = 0.0).||
    731 ||||timezone: ISO8601_TIMEZONE||Timezone; may be Void.||
    732 ||||month_unknown: Boolean||Indicates whether month in year is unknown.||
    733 ||||day_unknown: Boolean||Indicates whether day in month is unknown.||
    734 ||||hour_unknown: Boolean||Indicates whether hour in day is known.||
    735 ||||minute_unknown: Boolean||Indicates whether minute in hour is known.||
    736 ||||second_unknown: Boolean||Indicates whether minute in hour is known.||
    737 ||||is_partial: Boolean||True if this date is partial, i.e. if seconds or more is missing.||
    738 
    739 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 29 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    740 
    741 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    742 
    743 ||INTERFACE||ISO8601_DATE_TIME||
    744 ||||is_decimal_sign_comma: Boolean||True if this time has a decimal part indicated by ‘,’ (comma) rather than ‘.’ (period).||
    745 ||||infix ‘<’ (other: like Current): Boolean||Arithmetic comparison with other date/time. True if this date/time is closer to origin than other.||
    746 ||||is_extended: Boolean||True if this date/time uses ‘-’, ‘:’ separators.||
    747 ||||valid_iso8601_date_time||String is a valid ISO 8601 date-time, i.e.||
    748 ||||(s: String): Boolean||takes the form: • YYYYMMDDThhmmss[,sss] [Z | ±hh[mm]] or the extended form: • !YYYY-MM-DDThh:mm:ss[,sss] [Z | ±hh[mm]] or one of the partial forms: • YYYYMMDDThhmm • YYYYMMDDThh or the equivalent extended forms: • !YYYY-MM-DDThh:mm • YYYY-MM-DDThh (meanings as in DV_DATE, DV_TIME) and the values in each field are valid.||
    749 ||Invariants||Year_valid: valid_year(year) Month_valid: valid_month(month) Day_valid: valid_day(year, month, day) Hour_valid: valid_hour(hour, minute, second) Minute_valid: not minute_unknown implies valid_minute(minute) Second_valid: not second_unknown implies valid_second(second) Fractional_second_valid: has_fractional_second implies (not second_unknown and valid_fractional_second(fractional_second)) Partial_validity_year: not month_unknown Partial_validity_month: not month_unknown Partial_validity_day: not day_unknown Partial_validity_hour: not hour_unknown Partial_validity_minute: minute_unknown implies second_unknown||
    750 
    751 3.4.5 ISO8601_TIMEZONE Class
    752 
    753 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 30 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    754 
    755 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    756 
    757 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Assumed Types Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    758 
    759 ||INTERFACE||ISO8601_TIMEZONE||
    760 ||Inherit||TIME_DEFINITIONS||
    761 ||Function||Signature||Meaning||
    762 ||||as_string: String||ISO8601 timezone string, in format • Z | ±hh[mm] where: • hh is “00” - “23” (0-filled to two digits) • mm is “00” - “59” (0-filled to two digits) • Z is a literal meaning UTC (modern replacement for GMT), i.e. timezone +0000||
    763 ||||hour: Integer||Hour part of timezone - in the range 00 - 13||
    764 ||||minute: Integer require not minute_unknown||Minute part of timezone. Generally 00 or 30.||
    765 ||||sign: Integer||Direction of timezone expresssed as +1 or -1.||
    766 ||||is_gmt: Boolean||True if timezone is UTC, i.e. +0000||
    767 ||||minute_unknown: Boolean||Indicates whether minute part known.||
    768 ||Invariants||Min_hour_valid: sign = -1 implies hour > 0 and hour <= Min_timezone_hour Max_hour_valid: sign = 1 implies hour > 0 and hour <= Max_timezone_hour Minute_valid: not minute_unknown implies valid_minute(minute) Sign_valid: sign = 1 or sign = -1||
    769 
    770 3.4.6 ISO8601_DURATION Class
    771 
    772 ||INTERFACE||ISO8601_DURATION||
    773 ||Purpose||Represents a period of time corresponding to a difference between two time-points.||
    774 ||Inherit||ORDERED, TIME_DEFINITIONS||
    775 ||Function||Signature||Meaning||
    776 ||||as_string: String||ISO8601 string for duration, in format • P[nnY][nnM][nnW][nnD][T[nnH][nnM][nnS]]||
    777 ||||years: Integer||number of years of nominal 365-day length||
    778 ||||months: Integer||number of months of nominal 30 day length||
    779 ||||weeks: Integer||number of 7 day weeks||
    780 
    781 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 31 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    782 
    783   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    784 
    785 Assumed Types [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    786 
    787 ||INTERFACE||ISO8601_DURATION||
    788 ||||days: Integer||number of 24 hour days||
    789 ||||hours: Integer||number of 60 minute hours||
    790 ||||minutes: Integer||number of 60 second minutes||
    791 ||||seconds: Integer||number of seconds||
    792 ||||fractional_second: Double||fractional seconds||
    793 ||||infix ‘<’ (other: like Current): Boolean||Arithmetic comparison with other duration. True if this duration is smaller than other.||
    794 ||||valid_iso8601_duration (s: String): Boolean||String is a valid ISO 8601 duration, i.e. takes the form: • P[nnY][nnM][nnW][nnD][T[nnH][nnM][nnS]] Where each nn represents a number of years, months, etc. nnW represents a number of 7day weeks. Note: allowing the W designator in the same expression as other designators is an exception to the published standard, but necessary in clinical information (typically for representing pregnancy duration).||
    795 ||||is_decimal_sign_comma: Boolean||True if this time has a decimal part indicated by ‘,’ (comma) rather than ‘.’ (period).||
    796 ||||to_seconds: Double||Total number of seconds equivalent (including fractional) of entire duration.||
    797 ||Invariants||years_valid: years >= 0 months_valid: months >= 0 weeks_valid: weeks >= 0 days_valid: days >= 0 hours_valid: hours >= 0 minutes_valid: minutes >= 0 seconds_valid: seconds >= 0 fractional_second_valid: fractional_second >= 0.0 and fractional_second < 1.0||
    798 
    799 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 32 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    800 
    801 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    802 
    803 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    804 
    805 == Identification Package == #LinkTarget_17411
    806 === 4.1 Overview === #LinkTarget_17413
    807 The rm.support.identification package describes a model of references and identifiers for information entities and is illustrated in [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_17418 FIGURE 5] .
    808 
    809 identification
    810 
    811 FIGURE 5  rm.support.identification Package
    812 
    813 === 4.1.1 Requirements === #LinkTarget_17420
    814 Identification of entities both in the real world and in information systems is a non-trivial problem. The needs for identification across systems in a health information environment include the following:
    815 
    816  * real world identifiers such as social security numbers, veterans affairs ids etc can be recorded as required by health care facilities, enterprise policies, or legislation;
    817  * identifiers for informational entities which represent real world entities or processes should be unique;
    818  * it should be possible to determine if two identifiers refer to information entities that represent the same real world entity, even if instances of the information entities are maintained in different systems;
    819  * versions or changes to real-world entity-linked informational entities (which may create new information instances) should be accounted for in two ways:
    820 
    821 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 33 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    822 
    823   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    824 
    825 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    826 
    827 -        it should be possible to tell if two identifiers refer to distinct versions of the same
    828 
    829 informational entity in the same version tree;
    830 
    831 -        it should not be possible to confuse same-named versions of informational entities
    832 
    833 maintained in multiple systems which purport to represent the same real world
    834 
    835 entity. E.g. there is no guarantee that two systems’ “latest” version of the Person
    836 
    837 “Dr Jones” is the same.
    838 
    839 Medico-legal use of information relies on previous states of information being
    840 
    841 distinguishable from other previous states and the current state.
    842 
    843 •         It should be possible for an entity in one system or service (such as the EHR) to refer to an entity in another system or service in such a way that: -the target of the reference is easily finable within the shared environment, and
    844 
    845 -        the reference does is valid regardless of the physical architecture of servers and applications.
    846 
    847 The following subsections describe some of the features and challenges of identification.
    848 
    849 Identification of Real World Entities (RWEs)
    850 
    851 Real world entities such as people, car engines, invoices, and appointments can all be assigned identifiers. Although many of these are designed to be unique within a jurisdiction, they are often not, due to data entry errors, bad design (ids that are too small or incorporate some non-unique characteristic of the identified entities), bad process (e.g. non-synchronised id issuing points); identity theft (e.g. via theft of documents of proof or hacking). In general, while some real world identifiers (RWIs) are “nearly unique”, none can be guaranteed so. It should also be the case that if two RWE identifiers are equal, they refer to the same RWE, but this is often not the case. For practical purposes, RWIs cannot be regarded as computationally safe for making the inferences described here.
    852 
    853 Identification of Informational Entities (IEs)
    854 
    855 As soon as information systems are used to record facts about RWEs, the situation becomes more complex because of the intangible nature of information. In particular:
    856 
    857  * the same RWE can be represented simultaneously on more than one system (‘spatial multiplicity’);
    858  * the same RWE may be represented by more than one “version” of the same IE in a system (‘temporal multiplicity’).
    859 
    860 At first sight, it appears that there can also be purely informational entities, i.e. IEs which do not refer to any RWE, such as books, online-only documents and software. However, as soon as one considers an example it becomes clear that there is always a notional ‘definitive’ or ‘authoritative’ (i.e. trusted) version of every such entity. These entities can better be understood as ‘virtual RWEs’. Thus it can still be said that multiple IEs may refer to any given RWE.
    861 
    862 The underlying reason for the multiplicity of IEs is that ‘reality’ - time and space - in computer systems is not continuous but discrete, and each ‘entity’ is in fact just a snapshot of certain attribute values of a RWE, at a point in time, in a particular system. If identifiers are assigned to IEs without regard to versions or duplicates, then no assertion can be made about the identified RWE when two IE ids are compared.
    863 
    864 Identification of Versions
    865 
    866 The notion of ‘versioning’ applies only to informational entities, i.e. distinct instances of content each representing a snapshot of some logical entity. Where such instances are stored and managed in versioned containers within a versioning system of some kind, explicit identification of the versions is
    867 
    868 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 34 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    869 
    870 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    871 
    872 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    873 
    874 required. The requirements are discussed in detail in the Common IM, change_control package. They can be summarised as follows:
    875 
    876  * it must be possible to distinguish two versions of the same logical entity, i.e. know from the identifier if they are the same or different versions of the same thing;
    877  * it must be possible to distinguish two versions of the same logical entity created in two distinct systems;
    878  * it must be possible to tell the relationship between the items in a versioned lineage, from the version identifiers.
    879 
    880 Referencing of Informational Entities
    881 
    882 Within a distributed information environment, there is a need for entities not connected by direct references in the same memory space to be able to refer to each other. There are two competing requirements:
    883 
    884  * that the separation of objects in a distributed computing environment not compromise the semantics of the model;
    885  * that different types of information can be managed relatively independently; for example EHR and demographic information can be managed by different groups in an organisation or community, each with at least some freedom to change implementation and model details.
    886 
    887 === 4.2 Design === #LinkTarget_17533
    888 This package models only informational identifiers, i.e. transparent identifiers understood by openEHR or related computational systems. Real World Entity Identifiers such as driver’s license numbers are modelled using the data type DV_IDENTIFIER. This is not to imply that such identifiers are any less systematic or well-managed than the system identifiers defined here, only that from the point of view of openEHR, they have the same status as other informational attributes such as name, address etc of a Person.
    889 
    890 A key design decision has been to choose a string representation for all identifiers, with subparts being made available by appropriate functions which perform simple parsing on the string. This ensures that the data representation of identifiers (e.g. in XML) is as small as possible, while not losing object-oriented typing.
    891 
    892 === 4.2.1 Primitive Identifiers === #LinkTarget_17538
    893 Three kinds of types are defined in this package. The abstract UIDtype and its subtypes correspond to permanent, computationally reliable, primitive identifiers. Such identifiers are regarded as ‘primitive’ because they are treated as having no further internal structure, in the sense that part of such an identifier is not in general meaningful. The three subtypes UUID, ISO_OID and INTERNET_ID all have these properties, and are commonly accepted ways of uniquely identifying entities in computer systems. In openEHR (and generally in health informatics) they are usually used as parts of other identifiers.
    894 
    895 A consequence of the string representation approach used in these classes is that to set an attribute of type UID from a string value, as would be done when reading from a database, deserialising from XML or another text form, a piece of code that inspects the string structure has to be used in order to decide which of the subtypes of UID it is. This is a safe thing to do, since all three subtypes have mutually exclusive string patterns, and can easily be distinguished.
    896 
    897 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 35 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    898 
    899   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    900 
    901 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    902 
    903 === 4.2.2 Composite Identifiers === #LinkTarget_17560
    904 The OBJECT_ID type and its hierarchy of subtypes correspond to composite identifier types whose structure and semantics are defined by openEHR (rather than external organisations), and are the main means of identifying information items in an openEHR system. The abstract type UID_BASED_IDand its two subtypes HIER_OBJECT_IDand OBJECT_VERSION_IDprovide respectively, UID-based identifiers for non-versioned and versioned items. The design of the latter subtype is explained in the openEHR Common IM, change_control package.
    905 
    906 The other subtypes, ARCHETYPE_ID and TERMINOLOGY_ID define different kinds of identifier, the former being a multi-axial identifier for archetypes, and the latter being a globally unique single string identifier for terminologies. The ARCHETYPE_ID class explicitly includes archetype version as part of the identifier, while terminology identifier values are assumed to include this, either as part of the name (e.g. as is done in the US National Library of Medicine UMLS identifiers - see http://www.nlm.nih.gov/research/umls/metaa1.html ), or according to the syntax defined in [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_18094 section 4.3.12]  below.
    907 
    908 Identifying Versions
    909 
    910 The OBJECT_VERSION_ID defines the semantics of the scheme used in openEHR for identifying versions, and uses a three-part identifier, consisting of:
    911 
    912 •         object_id: the identifier of the version container, in the form of an UID;
    913 
    914  * version_tree_id: the location in the version tree, as a 1- or 3-part numeric identifier, where the latter variant expresses branching; this is modelled using the VERSION_TREE_ID type;
    915  * creating_system_id: the identifier of the system in which this version was created, or type UID.
    916 
    917 Under this scheme, multiple versions in the same container all have the same value for object_id, while their location in the version tree is given by the combination of the version tree identifier and the identifier of the creating system.
    918 
    919 The requirements on the third part of the identifier are that it be unique per system, and that it be easy to obtain or generate. It is also helpful if it is a meaningful identifier. The two most practical candidates appear to be GUIDs (which are not meaningful, but are easy to generate) and reverse internet  domain identifiers, as recommended in ![3] (these are easy to determine if the system has an internet  address, and are meaningful and directly processible, however unconnected systems pose a problem). ISO Oids might also be used. All of these identifier types are accommodated via the use of UID.
    920 
    921 A full explanation of the version identification scheme and its capabilities is given in the change_control section of the Common IM.
    922 
    923 === 4.2.3 References === #LinkTarget_17585
    924 All OBJECT_IDs are used as identifier attributes within the thing they identify, in the same way as a database primary key. To refer to an identified object from another object, an instance of the class OBJECT_REF should generally be used, in the same way as a database foreign key. The class OBJECT_REF is provided as a means of distributed referencing, and includes the object namespace (typically !1:1 with some service, such as “terminology”) and type. The general principle of object references is to be able to refer to an object available in a particular namespace or service. Usually they are used to refer to objects in other services, such as a demographic entity from within an EHR, but they may be used to refer to local objects as well. The type may be the concrete type of the referred-to object (e.g. “GP”) or any proper ancestor (e.g. “PARTY”).
    925 
    926 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 36 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    927 
    928 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    929 
    930 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    931 
    932 4.3 Class Descriptions
    933 
    934 4.3.1 UID Class
    935 
    936 ||CLASS||UID (abstract)||
    937 ||Purpose||Abstract parent of classes representing unique identifiers which identify information entities in a durable way. UIDs only ever identify one IE in time or space and are never re-used.||
    938 ||HL7||The HL7v3 UID Data type.||
    939 ||Attributes||Signature||Meaning||
    940 ||||value: String||The value of the id.||
    941 ||Invariant||Value_exists: value /= Void and then not value.empty||
    942 
    943 4.3.2 ISO_OID Class
    944 
    945 ||CLASS||ISO_OID||
    946 ||Purpose||Model of ISO’s Object Identifier (oid) as defined by the standard ISO/IEC 8824 . Oids are formed from integers separated by dots. Each non-leaf node in an Oid starting from the left corresponds to an assigning authority, and identifies that authority’s namespace, inside which the remaining part of the identifier is locally unique.||
    947 ||HL7||The HL7v3 OID Data type.||
    948 ||Inherit||UID||
    949 ||Functions||Signature||Meaning||
    950 ||Invariant||||
    951 
    952 4.3.3 UUID Class
    953 
    954 ||CLASS||UUID||
    955 ||Purpose||Model of the DCE Universal Unique Identifier or UUID which takes the form of hexadecimal integers separated by hyphens, following the pattern 8-4-4-4-12 as defined by the Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A. Also known as a GUID.||
    956 ||HL7||The HL7v3 UUID Data type.||
    957 ||Inherit||UID||
    958 
    959 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 37 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    960 
    961   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    962 
    963 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    964 
    965 ||CLASS||||UUID||||
    966 ||Functions||Signature||||Meaning||
    967 ||Invariant||||||||
    968 
    969 4.3.4 INTERNET_ID Class
    970 
    971 ||CLASS||INTERNET_ID||
    972 ||Purpose||[http://www.ietf.org/rfc/rfc1034.txt Model[[BR]]of a reverse internet domain, as used to uniquely identify an internet[[BR]]domain. In the form of a dot-separated string in the reverse order of a[[BR]]domain name, specified by IETF RFC 1034 (http://www.ietf.org/rfc/rfc1034.txt).]||
    973 ||Inherit||UID||
    974 ||Functions||Signature||Meaning||
    975 ||Invariant||||
    976 
    977 4.3.4.1 Syntax
    978 
    979 According to IETF RFC1034, the syntax of a domain name follows the BNF grammar:
    980 
    981 domain: subdomain | ‘ ’ subdomain: label | subdomain ‘.’ label  label: letter [ [ ldh-str ] let-dig ] ldh-str: let-dig-hyp | let-dig-hyp ldh-str let-dig-hyp: let-dig | ‘-’ let-dig: letter | digit
    982 
    983 letter: any one of the 52 alphabetic characters A through Z in upper case and a through z in lower case
    984 
    985 digit: any one of the ten digits 0 through 9
    986 
    987 It can also be expressed using the regular expression:
    988 
    989 [a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9]))*
    990 
    991 4.3.5 OBJECT_ID Class
    992 
    993 ||CLASS||OBJECT_ID (abstract)||
    994 ||Purpose||Ancestor class of identifiers of informational objects. Ids may be completely meaningless, in which case their only job is to refer to something, or may carry some information to do with the identified object.||
    995 ||Use||Object ids are used inside an object to identify that object. To identify another object in another service, use an OBJECT_REF, or else use a UID for local objects identified by UID. If none of the subtypes is suitable, direct instances of this class may be used.||
    996 
    997 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 38 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    998 
    999 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1000 
    1001 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1002 
    1003 ||CLASS||OBJECT_ID (abstract)||
    1004 ||Attributes||Signature||Meaning||
    1005 ||||value: String||The value of the id in the form defined below.||
    1006 ||Invariant||Value_exists: value /= Void and then not value.empty||
    1007 
    1008 4.3.6 UID_BASED_ID Class
    1009 
    1010 ||CLASS||UID_BASED_ID (abstract)||
    1011 ||Purpose||Abstract model of UID-based identifiers consisting of a root part and an optional extension; lexical form: root ‘::’ extension||
    1012 ||Inherit||''OBJECT_ID ''||
    1013 ||Functions||Signature||Meaning||
    1014 ||1..1||root: UID||The identifier of the conceptual namespace in which the object exists, within the identification scheme. Returns the part to the left of the first ‘::’ separator, if any, or else the whole string.||
    1015 ||1..1||extension: String||Optional local identifier of the object within the context of the root identifier. Returns the part to the right of the first ‘::’ separator if any, or else any empty String.||
    1016 ||||has_extension: Boolean||True if extension /= Void||
    1017 ||Invariant||Root_valid: root /= Void Extension_validity: extension /= Void Has_extension_validity: extension.is_empty xor has_extension||
    1018 
    1019 ==== 4.3.6.1 Identifier Syntax ==== #LinkTarget_17794
    1020 The syntax of the value attribute by default follows the following production rules (EBNF):
    1021 
    1022 value: root [ ‘::’ extension ] root: uid -- see UID above extension: string
    1023 
    1024 4.3.7 HIER_OBJECT_ID Class
    1025 
    1026 Concrete type corresponding to hierarchical identifiers of the form defined by UID_BASED_ID.
    1027 
    1028 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 39 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1029 
    1030   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1031 
    1032 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1033 
    1034 ||CLASS||HIER_OBJECT_ID||
    1035 ||HL7||The HL7v3 II Data type.||
    1036 ||Inherit||''UID_BASED_ID ''||
    1037 ||Functions||Signature||Meaning||
    1038 ||Invariant||||
    1039 
    1040 4.3.8 OBJECT_VERSION_ID Class
    1041 
    1042 ||CLASS||OBJECT_VERSION_ID||
    1043 ||Purpose||Globally unique identifier for one version of a versioned object; lexical form: object_id ‘::’ creating_system_id ‘::’ version_tree_id||
    1044 ||Inherit||''UID_BASED_ID ''||
    1045 ||Functions||Signature||Meaning||
    1046 ||1..1||object_id: UID||Unique identifier for logical object of which this identifier identifies one version; normally the object_id will be the unique identifier of the version container containing the version referred to by this OBJECT_VERSION_ID instance.||
    1047 ||1..1||version_tree_id: VERSION_TREE_ID||Tree identifier of this version with respect to other versions in the same version tree, as either 1 or 3 part dot-separated numbers, e.g. “1”, “2.1.4”.||
    1048 ||1..1||creating_system_id: UID||Identifier of the system that created the Version corresponding to this Object version id.||
    1049 ||||is_branch: Boolean||True if this version identifier represents a branch.||
    1050 ||Invariants||Object_valid: object_id /= Void Version_tree_id_valid: version_tree_id /= Void creating_system_id_valid: creating_system_id /= Void||
    1051 
    1052 4.3.8.1 Identifier Syntax
    1053 
    1054 The string form of an OBJECT_VERSION_ID stored in its value attribute consists of three segments separated by double colons (“::”), i.e. (EBNF):
    1055 
    1056 value: object_id ‘::’ creating_system_id ‘::’ version_tree_id object_id: uid -- see UID below creating_system_id:
    1057 
    1058 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 40 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1059 
    1060 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1061 
    1062 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1063 
    1064 An example is as follows:
    1065 
    1066 F7C5C7B7-75DB-4b39-9A1E-C0BA9BFDBDEC::87284370-2D4B4e3d-A3F3-F303D2F4F34B::2
    1067 
    1068 4.3.9 VERSION_TREE_ID Class
    1069 
    1070 ||CLASS||VERSION_TREE_ID||
    1071 ||Purpose||Version tree identifier for one version. Lexical form: trunk_version [ ‘.’ branch_number ‘.’ branch_version ]||
    1072 ||Attributes||Signature||Meaning||
    1073 ||1..1||value: String||String form of this identifier.||
    1074 ||Functions||Signature||Meaning||
    1075 ||1..1||trunk_version: String||Trunk version number; numbering starts at 1.||
    1076 ||0..1||branch_number: String||Number of branch from the trunk point; numbering starts at 1.||
    1077 ||0..1||branch_version: String||Version of the branch; numbering starts at 1.||
    1078 ||1..1||is_branch: Boolean||True if this version identifier represents a branch, i.e. has branch_number and branch_version parts.||
    1079 ||1..1||is_first: Boolean||True if this version identifier corresponds to the first version, i.e. trunk_version = “1”||
    1080 ||Invariants||Value_valid: value /= Void and then not value.is_empty Trunk_version_valid: trunk_version /= Void and then trunk_version.is_integer and then trunk_version.as_integer >= 1 Branch_number_valid: branch_number /= Void implies branch_number.is_integer and then branch_number.as_integer >= 1 Branch_version_valid: branch_version /= Void implies branch_version.is_integer and then branch_version.as_integer >= 1 Branch_validity: (branch_number = Void and branch_version = Void ) xor (branch_number /= Void and branch_version /= Void ) Is_branch_validity: is_branch xor branch_number = Void Is_first_validity: not is_first xor trunk_version.is_equal(“1”)||
    1081 
    1082 4.3.9.1 Syntax
    1083 
    1084 The format of the value attribute is (EBNF):
    1085 
    1086 value: trunk_version [ ‘.’ branch_number ‘.’ branch_version ] trunk_version: { digit }+  branch_number: { digit }+  branch_version: { digit }+
    1087 
    1088 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 41 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1089 
    1090   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1091 
    1092 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1093 
    1094 4.3.10 ARCHETYPE_ID Class
    1095 
    1096 ||CLASS||ARCHETYPE_ID||
    1097 ||Purpose||Identifier for archetypes. Lexical form: rm_originator ‘-’ rm_name ‘-’ rm_entity ‘.’ concept_name { ‘-’ specialisation }* ‘.v’ number||
    1098 ||Inherit||''OBJECT_ID ''||
    1099 ||Functions||Signature||Meaning||
    1100 ||1..1||qualified_rm_entity: String||Globally qualified reference model entity, e.g. “openehr-composition-OBSERVATION”.||
    1101 ||1..1||domain_concept: String||Name of the concept represented by this archetype, including specialisation, e.g. “biochemistry_result-cholesterol”.||
    1102 ||1..1||rm_originator: String||Organisation originating the reference model on which this archetype is based, e.g. “openehr”, “cen”, “hl7”.||
    1103 ||1..1||rm_name: String||Name of the reference model, e.g. “rim”, “ehr_rm”, “en13606”.||
    1104 ||1..1||rm_entity: String||Name of the ontological level within the reference model to which this archetype is targeted, e.g. for openEHR, “folder”, “composition”, “section”, “entry”.||
    1105 ||1..1||specialisation: String||Name of specialisation of concept, if this archetype is a specialisation of another archetype, e.g. “cholesterol”.||
    1106 ||1..1||version_id: String||Version of this archetype.||
    1107 ||Invariant||Qualified_rm_entity_valid: qualified_rm_entity /= Void and then not qualified_rm_entity.is_empty Domain_concept_valid: domain_concept /= Void and then not domain_concept.is_empty Rm_originator_valid: rm_originator /= Void and then not rm_originator.is_empty Rm_name_valid: rm_name /= Void and then not rm_name.is_empty Rm_entity_valid: rm_entity /= Void and then not rm_entity.is_empty Specialisation_valid: specialisation /= Void implies not specialisation.is_empty Version_id_valid: version_id /= Void and then not version_id.is_empty||
    1108 
    1109 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 42 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1110 
    1111 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1112 
    1113 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1114 
    1115 4.3.10.1 Archetype ID Syntax
    1116 
    1117 Archetype identifiers are “multi-axial”, meaning that each identifier instance denotes a single archetype within a multi-dimensional space. In this case, the space is essentially a versioned 3-dimensional space, with the dimensions being:
    1118 
    1119  * reference model entity, i.e. target of archetype
    1120  * domain concept
    1121  * version
    1122 
    1123 As with any multi-axial identifier, the underlying principle of an archetype id is that all parts of the id must be able to be considered immutable. This means that no variable characteristic of an archetype
    1124 
    1125 (e.g. accrediting authority, which might change due to later accreditation by another authority, or may be multiple) can be included in its identifier. The syntax of an ARCHETYPE_ID is as follows (EBNF):
    1126 
    1127 archetype_id: qualified_rm_entity ‘.’ domain_concept ‘.’ version_id
    1128 
    1129 qualified_rm_entity: rm_originator ‘-’ rm_name ‘-’ rm_entity  rm_originator: V_NAME  rm_name: V_NAME  rm_entity: V_NAME
    1130 
    1131 domain_concept: concept_name { ‘-’ specialisation }*  concept_name: V_NAME  specialisation: V_NAME
    1132 
    1133 version_id: ‘v’ V_NUMBER
    1134 
    1135 NUMBER: ![0-9]*  NAME: [a-z][a-z0-9()/%$#&]*
    1136 
    1137 The field meanings are as follows:
    1138 
    1139 rm_originator: id of organisation originating the reference model on which this archetype is based;
    1140 
    1141 rm_name: id of the reference model on which the archetype is based;
    1142 
    1143 rm_entity: ontological level in the reference model;
    1144 
    1145 domain_concept: the domain concept name, including any specialisations;
    1146 
    1147 version_id: numeric version identifier;
    1148 
    1149 Examples of archetype identifiers include:
    1150 
    1151 • openehr-composition-SECTION.physical_examination.v2 • openehr-composition-SECTION.physical_examination-prenatal.v1
    1152 
    1153 • hl7-rim-act.progress_note.v1 • openehr-composition-OBSERVATION.progress_note-naturopathy.v2
    1154 
    1155 Archetypes can also be identified by other means, such as ISO oids.
    1156 
    1157 4.3.11 TEMPLATE_ID Class
    1158 
    1159 Identifier for templates. Lexical form to be determined.
    1160 
    1161 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 43 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1162 
    1163   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1164 
    1165 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1166 
    1167 ||CLASS||||TEMPLATE_ID||||
    1168 ||Inherit||''OBJECT_ID ''||||||
    1169 ||Functions||Signature||||||Meaning||
    1170 ||Invariant||||||||
    1171 
    1172 4.3.12 TERMINOLOGY_ID Class
    1173 
    1174 ||CLASS||TERMINOLOGY_ID||
    1175 ||Purpose||Identifier for terminologies such accessed via a terminology query service. In this class, the value attribute identifies the Terminology in the terminology service, e.g. “SNOMED-CT”. A terminology is assumed to be in a particular language, which must be explicitly specified. The value if the id attribute is the precise terminology id identifier, including actual release (i.e. actual “version”), local modifications etc; e.g. “ICPC2”. Lexical form: name [ ‘(’ version ‘)’ ]||
    1176 ||Inherit||''OBJECT_ID ''||
    1177 ||Functions||Signature||Meaning||
    1178 ||1..1||name: String||Return the terminology id (which includes the “version” in some cases). Distinct names correspond to distinct (i.e. non-compatible) terminologies. Thus the names “ICD10AM” and “ICD10” refer to distinct terminologies.||
    1179 ||1..1||version_id: String||Version of this terminology, if versioning supported, else the empty string.||
    1180 ||Invariants||Name_valid: name /= Void and then not name.is_empty Version_id_valid: version_id /= Void||
    1181 
    1182 4.3.12.1 Identifier Syntax
    1183 
    1184 The syntax of the value attribute is as follows:
    1185 
    1186 name [ ‘(’ version ‘)’ ]
    1187 
    1188 Examples of terminology identifiers include:
    1189 
    1190  * “snomed-ct”
    1191  * “ICD9(1999)”
    1192 
    1193 Versions should only be needed for those terminologies which break the rule that the thing being identified with a code loses or changes its meaning over versions of the terminology. This should not be the case for well known modern terminologies and ontologies, particularly those designed since the publication of Cimino’s ‘desiderata’ [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19407 "[1]"]  of which the principle of “concept permanance” is appli-
    1194 
    1195 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 44 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1196 
    1197 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1198 
    1199 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1200 
    1201 cable here - “A concept's meaning cannot change and it cannot be deleted from the vocabulary”. However, there maybe older terminologies, or specialised terminologies which may not have obeyed these rules, but which are still used; version ids should always be used for these.
    1202 
    1203 4.3.13 GENERIC_ID Class
    1204 
    1205 ||CLASS||GENERIC_ID||
    1206 ||Purpose||Generic identifier type for identifiers whose format is othterwise unknown to openEHR. Includes an attribute for naming the identification scheme (which may well be local).||
    1207 ||Inherit||''OBJECT_ID ''||
    1208 ||attributes||Signature||Meaning||
    1209 ||1..1||scheme: String||Name of the scheme to which this identifier conforms. Ideally this name will be recognisable globally but realistically it may be a local ad hoc scheme whose name is not controlled or standardised in any way.||
    1210 ||Invariants||Scheme_valid: scheme /= Void and then not scheme.is_empty||
    1211 
    1212 4.3.14 OBJECT_REF Class
    1213 
    1214 ||CLASS||OBJECT_REF||
    1215 ||Purpose||Class describing a reference to another object, which may exist locally or be maintained outside the current namespace, e.g. in another service. Services are usually external, e.g. available in a LAN (including on the same host) or the internet via Corba, SOAP, or some other distributed protocol. However, in small systems they may be part of the same executable as the data containing the Id.||
    1216 ||Attributes||Signature||Meaning||
    1217 ||1..1||id: ''OBJECT_ID ''||Globally unique id of an object, regardless of where it is stored.||
    1218 ||1..1||namespace: String||Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. “terminology”, “demographic”. These names are not yet standardised. Legal values for the namespace are “local” | “unknown” | “[a-zAZ]![a-zA-Z0-9_-:/&+?]*”||
    1219 
    1220 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 45 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1221 
    1222   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1223 
    1224 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1225 
    1226 ||CLASS||OBJECT_REF||
    1227 ||1..1||type: String||Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. “PARTY”, “PERSON”, “GUIDELINE” etc. These class names are from the relevant reference model. The type name “ANY” can be used to indicate that any type is accepted (e.g. if the type is unknown).||
    1228 ||Invariant||Id_exists: id /= Void Namespace_exists: namespace /= Void and then not namespace.is_empty Type_exists: type /= Void and then not type.is_empty||
    1229 
    1230 4.3.15 ACCESS_GROUP_REF Class
    1231 
    1232 ||CLASS||ACCESS_GROUP_REF||
    1233 ||Purpose||Reference to access group in an access control service.||
    1234 ||Inherit||OBJECT_REF||
    1235 ||Functions||Signature||Meaning||
    1236 ||Invariant||Type_validity: type.is_equal(“ACCESS_GROUP”)||
    1237 
    1238 4.3.16 PARTY_REF Class
    1239 
    1240 ||CLASS||PARTY_REF||
    1241 ||Purpose||Identifier for parties in a demographic or identity service. There are typically a number of subtypes of the PARTY class, including PERSON, ORGANISATION, etc. Abstract supertypes are allowed if the referenced object is of a type not known by the current implementation of this class (in other words, if the demographic model is changed by the addition of a new PARTY or ACTOR subtypes, valid PARTY_REFs can still be constructed to them).||
    1242 ||Inherit||OBJECT_REF||
    1243 ||Functions||Signature Meaning Type_validity: type.is_equal(“PERSON”) or type.is_equal(“ORGANISATION”) or type.is_equal(“GROUP”) or type.is_equal(“AGENT”)or type.is_equal(“ROLE”) or type.is_equal(“PARTY”) or type.is_equal(“ACTOR”)||
    1244 ||Invariant||
    1245 
    1246 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 46 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1247 
    1248 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1249 
    1250 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Identification Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1251 
    1252 4.3.17 LOCATABLE_REF Class
    1253 
    1254 ||CLASS||LOCATABLE_REF||
    1255 ||Purpose||Reference to a LOCATABLE instance inside the top-level content structure inside a VERSION<T>; the path attribute is applied to the object that VERSION.data points to.||
    1256 ||Inherit||OBJECT_REF||
    1257 ||Attributes||Signature||Meaning||
    1258 ||1..1 (redefined)||id: OBJECT_VERSION_ID||The identifier of the Version.||
    1259 ||0..1||path: String||The path to an instance in question, as an absolute path with respect to the object found at VERSION.data. An empty path means that the object referred to by id being specified.||
    1260 ||Functions||Signature||Meaning||
    1261 ||1..1||as_uri: String||A URI form of the reference, created by concatenating the following: “!ehr://” + id.value + “/” + path||
    1262 ||Invariant||Path_valid: path /= Void implies not path.is_empty||
    1263 
    1264 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 47 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1265 
    1266   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1267 
    1268 Identification Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1269 
    1270 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 48 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1271 
    1272 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1273 
    1274 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1275 
    1276 Terminology Package
    1277 
    1278 5.1 Overview
    1279 
    1280 This section describes the terminology package, which contains classes for accessing terminologies and code sets, including the openEHR Support Terminology, from within instances of classes defined in the reference model. The classes shown here would normally be inherited via the classes EXTERNAL_ENVIRONMENT_ACCESS and OPENEHR_DEFINITIONS, although the exact details of how this is done may vary depending on implementation language.
    1281 
    1282 5.2 Service Interface
    1283 
    1284 5.2.1 Code Sets
    1285 
    1286   A simple terminology service interface is defined according to FIGURE 6, enabling  openEHR code sets and terminology to be referenced formally from within the Reference Model. Two types of coded entities are distinguished in openEHR, and are accessible via the service interface. The first is codes from ‘code sets’, which are the kind of terminology where the code stands for itself, such as the ISO 639-1 language codes. The identifiers themselves of these code sets do not appear to be standardised, but names such as “ISO_639-1” are expected to be used (see below).
    1287 
    1288 In any case, code sets needed within the openEHR models themselves (e.g. for attributes whose value is a language code) are not referred to directly by an external name such as “ISO_639-1”, but via an internal constant, in this case, the constant Code_set_id_languages, whose value is defined to be “languages”. These constants are defined in the class OPENEHR_CODE_SET_IDENTIFIERS  in FIGURE
    1289 
    1290  6. The mapping between the internal identifiers and external names should be done in configuration files. The service function TERMINOLOGY_SERVICE.code_set_for_id() is used to retrieve code sets on the basis of a constant. The current mapping and external identifiers assumed in openEHR is defined in the openEHR Support Terminology document. This use of indirection is employed to ensure that the obsoleting and superseding of code-sets does not directly affect openEHR software.
    1291 
    1292 For code sets not mapped to internally used constants, i.e. code sets not required in the openEHR model itself, but otherwise known in the terminology service, the function TERMINOLOGY_SERVICE.code_set() can be used to retrieve these code sets by their external identifier.
    1293 
    1294 5.2.2 Terminologies
    1295 
    1296 Terminologies, including the openEHR Support Terminology are accessed via the TERMINOLOGY_SERVICEfunctions terminology() and terminology_identifiers(), where the argument includes “openehr”, “centc251” (for CEN TC/251codes) and names from the US NLM terminologies list (see below). The openEHR Terminology supports groups, and the set of groups required by the reference model is defined in the class OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS. These groups correspond to coded attributes found in the openEHR Reference Model.
    1297 
    1298 5.2.3 Terms and Codes in the openEHR Reference Model
    1299 
    1300 True coded attributes in the Reference Model (i.e. attributes of type DV_CODED_TEXT), such as FEEDER_AUDIT.change_type are defined by an invariant in the enclosing class, such as the following:
    1301 
    1302 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 49 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1303 
    1304   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1305 
    1306 terminology
    1307 
    1308 OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
    1309 
    1310 const Terminology_id_openehr: String is “openehr” const Group_id_audit_change_type: String is “audit change type” const Group_id_attestation_reason: String is “attestation reason” const Group_id_composition_category: String is “composition category” const Group_id_event_math_function: String is “event math function” const Group_id_instruction_states: String is “instruction states” const Group_id_instruction_transitions: String is “instruction transitions” const Group_id_null_flavours: String is “null flavours” const Group_id_property: String is “property” const Group_id_participation_function: String is “participation function” const Group_id_participation_mode: String is “participation mode” const Group_id_setting: String is “setting” const Group_id_term_mapping_purpose: String is “term mapping purpose” const Group_id_subject_relationship: String is “subject relationship” const Group_id_version_lifecycle_state: String is “version lifecycle state”
    1311 
    1312 valid_group_id(an_id: String): Boolean
    1313 
    1314 TERMINOLOGY_SERVICE
    1315 
    1316 OPENEHR_CODE_SET_IDENTIFIERS
    1317 
    1318 const Code_set_id_character_sets: String is “character sets” const Code_set_id_compression_algorithms: String is “compression algorithms” const Code_set_id_countries: String is “countries” const Code_set_id_integrity_check_algorithms: String is “integrity check algorithms” const Code_set_id_languages: String is “languages” const Code_set_id_media_types: String is “media types” const Code_set_id_normal_statuses: String is “normal statuses”
    1319 
    1320 valid_code_set_id(an_id: String): Boolean
    1321 
    1322 CODE_SET_ACCESS <<interface>>
    1323 
    1324 id: Stringall_codes: Set<CODE_PHRASE> has_lang (...): Boolean has_code (...): Boolean terminology (name: String): TERMINOLOGY_ACCESS code_set (name: String): CODE_SET_ACCESS code_set_for_id (id: String): CODE_SET_ACCESS has_terminology (name: String): Boolean has_code_set (name: String): Boolean terminology_identifiers: List<String>openehr_code_sets: Hash<String, String> code_set_identifiers: List<String>
    1325 
    1326 ||TERMINOLOGY_ACCESS <<interface>>||
    1327 ||||
    1328 ||id: Stringall_codes: Set<CODE_PHRASE> codes_for_group_id (...): Set<CODE_PHRASE> codes_for_group_name (...): Set<CODE_PHRASE> has_code_for_group_id (...): Boolean rubric_for_code (...): String||
    1329 
    1330 FIGURE 6 rm.support.terminology Package
    1331 
    1332 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1333 
    1334 Change_type_valid:terminology(Terminology_id_openehr).has_code_for_group_id  (Group_id_audit_change_type, change_type.defining_code)
    1335 
    1336 This is a formal way of saying that the attribute change_type must have a value such that its defining_code (its CODE_PHRASE) is in the set of CODE_PHRASEs in the openEHR Terminology which are in the group whose indentifier is Group_id_audit_change_type.
    1337 
    1338 A similar invariant is used for attributes of type CODE_PHRASE, which come from a code_set. The following invariant appears in the class ENTRY (rm.composition.content.entry package):
    1339 
    1340 Language_valid: media_type /= Void and then  code_set(Code_set_languages).has_code(language)
    1341 
    1342 5.3 Identifiers
    1343 
    1344 In openEHR, the identifier of a terminology or code set is found in the terminology_id attribute of the class CODE_PHRASE (Data Types Information Model, text package).
    1345 
    1346 5.3.1 Code Set Identifiers
    1347 
    1348 Internal code set identifiers (such as “languages”) used in openEHR are defined in the class OPENEHR_CODE_SET_IDENTIFIERS; assumed external identifiers (such as “ISO_639-1”) for code sets used by the openEHR Reference Model are defined in the openEHR Support Terminology document.
    1349 
    1350 5.3.2 Terminology Identifiers
    1351 
    1352 Valid identifiers that can be used for this attribute for terminologies include but are not limited to the following:
    1353 
    1354  * “openehr”
    1355  * “centc251”
    1356  * an identifier value from the first column of the US National Library or Medicine (NLM) UMLS terminology identifiers table below, in either of two forms:
    1357 
    1358 -as is, e.g. “ICD10AM_2000”, “ICPC93”;  -with any trailing section starting with an underscore removed, e.g. “ICD10AM”.
    1359 
    1360 Other identification schemes are used in some standards, such as ISO Oids. These are not specified for direct use in openEHR for various reasons:
    1361 
    1362  * they are not currently used by the NLM, and no definitive published list of terminology identifiers is available;
    1363  * ISO Oids are long identifiers and may significantly increase the size of persisted information due to the ubiquity of coded terms;
    1364  * determing the identity of the terminology in data always requires a request to a service containing the Oid / name mapping;
    1365  * there is a safety factor in having human readable terminology identifiers in the data.
    1366 
    1367 The use of Oid-based or other terminology identification schemes is not however incompatible with openEHR; all that is required is a terminology identifier / name mapping service or table.
    1368 
    1369 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 51 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1370 
    1371   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1372 
    1373 Terminology Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1374 
    1375 The following table is a snapshot of the US National Library of Medicine UMLS terminology identifiers list. A definitive up-to-date list may be found on the NLM website at http://www.nlm.nih.gov/research/umls/metaa1.html .
    1376 
    1377 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1378 
    1379 ||||UMLS 2003 Terminology Identifiers||
    1380 ||Identifier||Description||
    1381 ||AIR93||AI/RHEUM,1993||
    1382 ||ALT2000||Alternative Billing Concepts, 2000||
    1383 ||AOD2000||Alcohol and Other Drug Thesaurus, 2000||
    1384 ||BI98||Beth Israel Vocabulary, 1.0||
    1385 ||BRMP2002||Portuguese translation of the Medical Subject Headings, 2002||
    1386 ||BRMS2002||Spanish translation of the Medical Subject Headings, 2002||
    1387 ||CCPSS99||Canonical Clinical Problem Statement System, 1999||
    1388 ||CCS99||Clinical Classifications Software, 1999||
    1389 ||CDT4||Current Dental Terminology(CDT), 4||
    1390 ||COSTAR_89-95||COSTAR, 1989-1995||
    1391 ||CPM93||Medical Entities Dictionary, 1993||
    1392 ||CPT01SP||Physicians' Current Procedural Terminology, Spanish Translation, 2001||
    1393 ||CPT2003||Physicians' Current Procedural Terminology, 2003||
    1394 ||CSP2002||CRISP Thesaurus, 2002||
    1395 ||CST95||COSTART, 1995||
    1396 ||DDB00||Diseases Database, 2000||
    1397 ||DMD2003||German translation of the Medical Subject Headings, 2003||
    1398 ||DMDICD10_1995||German translation of ICD10, 1995||
    1399 ||DMDUMD_1996||German translation of UMDNS, 1996||
    1400 ||DSM3R_1987||DSM-III-R, 1987||
    1401 ||DSM4_1994||DSM-IV, 1994||
    1402 ||DUT2001||Dutch Translation of the Medical Subject Headings, 2001||
    1403 ||DXP94||DXplain, 1994||
    1404 ||FIN2003||Finnish translations of the Medical Subject Headings, 2003||
    1405 ||HCDT4||HCPCS Version of Current Dental Terminology(CDT), 4||
    1406 ||HCPCS03||Healthcare Common Procedure Coding System, 2003||
    1407 ||HCPT03||HCPCS Version of Current Procedural Terminology(CPT), 2003||
    1408 ||HHC96||Home Health Care Classification, 1996||
    1409 ||HL7_1998-2002||Health Level Seven Vocabulary, 1998-2002||
    1410 ||HLREL_1998||ICPC2E-ICD10 relationships from Dr. Henk Lamberts, 1998||
    1411 ||HPC99||Health Product Comparison System, 1999||
    1412 ||ICD10AE_1998||ICD10, American English Equivalents, 1998||
    1413 ||ICD10AMAE_2000||International Statistical Classification of Diseases and Related Health Problems, Australian Modification, Americanized English Equivalents, 2000||
    1414 ||ICD10AM_2000||International Statistical Classification of Diseases and Related Health Problems, 10th Revision, Australian Modification, January 2000 Release||
    1415 ||ICD10_1998||ICD10, 1998||
    1416 
    1417 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 52 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1418 
    1419 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1420 
    1421   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1422 
    1423 ||||UMLS 2003 Terminology Identifiers||
    1424 ||Identifier||Description||
    1425 ||ICD9CM_2003||ICD-9-CM, 2003||
    1426 ||ICPC2AE_1998||International Classification of Primary Care, Americanized English Equivalents, 2E, 1998||
    1427 ||ICPC2E_1998||International Classification of Primary Care 2nd Edition, Electronic, 2E, 1998||
    1428 ||ICPC2P_2000||International Classification of Primary Care, Version2-Plus, 2000||
    1429 ||ICPC93||International Classification of Primary Care, 1993||
    1430 ||ICPCBAQ_1993||ICPC, Basque Translation, 1993||
    1431 ||ICPCDAN_1993||ICPC, Danish Translation, 1993||
    1432 ||ICPCDUT_1993||ICPC, Dutch Translation, 1993||
    1433 ||ICPCFIN_1993||ICPC, Finnish Translation, 1993||
    1434 ||ICPCFRE_1993||ICPC, French Translation, 1993||
    1435 ||ICPCGER_1993||ICPC, German Translation, 1993||
    1436 ||ICPCHEB_1993||ICPC, Hebrew Translation, 1993||
    1437 ||ICPCHUN_1993||ICPC, Hungarian Translation, 1993||
    1438 ||ICPCITA_1993||ICPC, Italian Translation, 1993||
    1439 ||ICPCNOR_1993||ICPC, Norwegian Translation, 1993||
    1440 ||ICPCPAE_2000||International Classification of Primary Care ,Version2-Plus, Americanized English Equivalents, 2000||
    1441 ||ICPCPOR_1993||ICPC, Portuguese Translation, 1993||
    1442 ||ICPCSPA_1993||ICPC, Spanish Translation, 1993||
    1443 ||ICPCSWE_1993||ICPC, Swedish Translation, 1993||
    1444 ||INS2002||French translation of the Medical Subject Headings, 2002||
    1445 ||ITA2003||Italian translation of Medical Subject Headings, 2003||
    1446 ||JABL99||Online Congenital Multiple Anomaly/ Mental Retardation Syndromes, 1999||
    1447 ||LCH90||Library of Congress Subject Headings, 1990||
    1448 ||LNC205||LOINC, 2.05||
    1449 ||LOINC||LOINC||
    1450 ||MCM92||!McMaster University Epidemiology Terms, 1992||
    1451 ||MDDB99||!MasterDrug !DataBase, 1999||
    1452 ||MDR51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), 5.1||
    1453 ||MDRAE51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), American English Equivalents, 5.1||
    1454 ||MDREA51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), American English, with expanded abbreviations, 5.1||
    1455 ||MDREX51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), with expanded abbreviations, 5.1||
    1456 ||MDRPOR51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), 5.1, Portuguese Edition||
    1457 
    1458 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 53 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1459 
    1460 Terminology Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1461 
    1462 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1463 
    1464 ||||UMLS 2003 Terminology Identifiers||
    1465 ||Identifier||Description||
    1466 ||MDRSPA51||Medical Dictionary for Regulatory Activities Terminology (MedDRA), 5.1, Spanish Edition||
    1467 ||MIM93||Online Mendelian Inheritance in Man, 1993||
    1468 ||MMSL01||Multum !MediSource Lexicon, 2001||
    1469 ||MMX01||Micromedex DRUGDEX, 2001-08||
    1470 ||MSH2003_2002_10_24||Medical Subject Headings, 2002_10_24||
    1471 ||MTH||UMLS Metathesaurus||
    1472 ||MTHCH03||Metathesaurus CPT Hierarchical Terms, 2003||
    1473 ||MTHHH03||Metathesaurus HCPCS Hierarchical Terms, 2003||
    1474 ||MTHICD9_2003||Metathesaurus additional entry terms for ICD-9-CM, 2003||
    1475 ||MTHMST2001||Metathesaurus Version of Minimal Standard Terminology Digestive Endoscopy, 2001||
    1476 ||MTHMSTFRE_2001||Metathesaurus Version of Minimal Standard Terminology Digestive Endoscopy, French Translation, 2001||
    1477 ||MTHMSTITA_2001||Metathesaurus Version of Minimal Standard Terminology Digestive Endoscopy, Italian Translation, 2001||
    1478 ||NAN99||Classification of Nursing Diagnoses, 1999||
    1479 ||NCBI2001||NCBI Taxonomy, 2001||
    1480 ||NCI2001a||NCI Thesaurus, 2001a||
    1481 ||NCISEER_1999||NCISEER ICD Neoplasm Code Mappings, 1999||
    1482 ||NDDF01||!FirstDataBank National Drug !DataFile, 2001-07||
    1483 ||NEU99||Neuronames Brain Hierarchy, 1999||
    1484 ||NIC99||Nursing Interventions Classification, 1999||
    1485 ||NOC97||Nursing Outcomes Classification, 1997||
    1486 ||OMIM97||OMIM, Online Mendelian Inheritance in Man, 1997||
    1487 ||OMS94||Omaha System, 1994||
    1488 ||PCDS97||Patient Care Data Set, 1997||
    1489 ||PDQ2002||Physician Data Query, 2002||
    1490 ||PPAC98||Pharmacy Practice Activity Classification , 1998||
    1491 ||PSY2001||Thesaurus of Psychological Index Terms, 2001||
    1492 ||QMR96||Quick Medical Reference (QMR), 1996||
    1493 ||RAM99||QMR clinically related terms from Randolph A. Miller, 1999||
    1494 ||RCD99||Clinical Terms Version 3 (CTV3) (Read Codes), 1999||
    1495 ||RCDAE_1999||Read thesaurus, American English Equivalents, 1999||
    1496 ||RCDSA_1999||Read thesaurus Americanized Synthesized Terms, 1999||
    1497 ||RCDSY_1999||Read thesaurus, Synthesized Terms, 1999||
    1498 ||RUS2003||Russian Translation of MeSH, 2003||
    1499 ||RXNORM_03AA||RXNORM Project, META2003AA||
    1500 ||SNM2||SNOMED-2, 2||
    1501 ||SNMI98||SNOMED International, 1998||
    1502 
    1503 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 54 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1504 
    1505 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1506 
    1507 ||||UMLS 2003 Terminology Identifiers||
    1508 ||Identifier||Description||
    1509 ||SNOMED-CT||SNOMED International Clinical Terms, 2002||
    1510 ||SPN02||Standard Product Nomenclature, 2002||
    1511 ||SRC||Metathesaurus Source Terminology Names||
    1512 ||ULT93||UltraSTAR, 1993||
    1513 ||UMD2003||UMDNS: product category thesaurus, 2003||
    1514 ||UMLS||UMLS: National Library of Medicine, USA||
    1515 ||UWDA155||University of Washington Digital Anatomist, 1.5.5||
    1516 ||VANDF01||Veterans Health Administration National Drug File, 2001||
    1517 ||WHO97||WHO Adverse Reaction Terminology, 1997||
    1518 ||WHOFRE_1997||WHOART, French Translation, 1997||
    1519 ||WHOGER_1997||WHOART, German Translation, 1997||
    1520 ||WHOPOR_1997||WHOART, Portuguese Translation, 1997||
    1521 ||WHOSPA_1997||WHOART, Spanish Translation, 1997||
    1522 
    1523 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 55 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1524 
    1525   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1526 
    1527 Terminology Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1528 
    1529 5.4 Class Definitions
    1530 
    1531 5.4.1 TERMINOLOGY_SERVICE Class
    1532 
    1533 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1534 
    1535 ||CLASS||TERMINOLOGY_SERVICE||
    1536 ||Purpose||Defines an object providing proxy access to a terminology service.||
    1537 ||Inherit||OPENEHR_CODE_SET_IDENTIFIERS, OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS||
    1538 ||Functions||Signature||Meaning||
    1539 ||||terminology (name: String):||Return an interface to the terminology||
    1540 ||||TERMINOLOGY_ACCESS||named name. Allowable names include||
    1541 ||||require||• “openehr”||
    1542 ||||name /= Void and then has_terminology (name) ensure Result /= Void||[http://www.nlm.nih.gov/research/umls/metaa1.html • “centc251” • any name from are taken from the US NLM UMLS meta-data list at http://www.nlm.nih.gov/research/umls/metaa1.html]||
    1543 ||||code_set (name: String): CODE_SET_ACCESS require name /= Void and then has_code_set (name) ensure Result /= Void||Return an interface to the code_set identified by the external identifier name (e.g. “ISO_639-1”).||
    1544 ||||code_set_for_id(id: String): CODE_SET_ACCESS require id /= Void and then valid_code_set_id (id) ensure Result /= Void has_terminology (name: String): Boolean require name /= Void and then not name.is_empty||[http://www.nlm.nih.gov/research/umls/metaa1.html Return an interface to the code_set identified internally in openEHR by id. True if terminology named name known by this service. Allowable names include • “openehr” • “centc251” • any name from are taken from the US NLM UMLS meta-data list at http://www.nlm.nih.gov/research/umls/metaa1.html]||
    1545 ||||
    1546 
    1547 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 56 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1548 
    1549 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1550 
    1551 ||CLASS||TERMINOLOGY_SERVICE||
    1552 ||||has_code_set (name: String): Boolean require name /= Void and then not name.is_empty||True if code_set linked to internal name (e.g. “languages”) is available.||
    1553 ||||terminology_identifiers: List<String>||[http://www.nlm.nih.gov/research/umls/metaa1.html Set of all terminology identifiers known in the terminology service. Values from the US NLM UMLS meta-data list at http://www.nlm.nih.gov/research/umls/metaa1.html]||
    1554 ||||code_set_identifiers: List<String>||Set of all code set identifiers known in the terminology service.||
    1555 ||||openehr_code_sets: Hash<String, String>||Set of all code sets identifiers for which there is an internal openEHR name; returned as a Hash of ids keyed by internal name.||
    1556 ||Invariants||||
    1557 
    1558 5.4.2 TERMINOLOGY_ACCESS Class
    1559 
    1560 ||CLASS||TERMINOLOGY_ACCESS||
    1561 ||Purpose||Defines an object providing proxy access to a terminology.||
    1562 ||Functions||Signature||Meaning||
    1563 ||||id: String||Identification of this Terminology||
    1564 ||||all_codes: Set<CODE_PHRASE>||Return all codes known in this terminology||
    1565 ||||codes_for_group_id (group_id: String): Set<CODE_PHRASE>||Return all codes under grouper ‘group_id’ from this terminology||
    1566 ||||has_code_for_group_id (group_id: String; a_code: CODE_PHRASE): Boolean codes_for_group_name (name, lang: String): Set<CODE_PHRASE>||True if ‘a_code’ is known in group ‘group_id’ in the openEHR terminology. Return all codes under grouper whose name in ‘lang’ is ‘name’ from this terminology||
    1567 ||||
    1568 ||||rubric_for_code (code, lang: String): String||Return all rubric of code ‘code’ in language ‘lang’.||
    1569 ||Invariants||id_exists: id /= Void and then not id.is_empty||
    1570 
    1571 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 57 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1572 
    1573   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1574 
    1575 Terminology Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1576 
    1577 5.4.3 CODE_SET_ACCESS Class
    1578 
    1579 ||CLASS||CODE_SET_ACCESS||
    1580 ||Purpose||Defines an object providing proxy access to a code_set.||
    1581 ||Functions||Signature||Meaning||
    1582 ||||id: String||External identifier of this code set||
    1583 ||||all_codes: Set<CODE_PHRASE>||Return all codes known in this code set||
    1584 ||||has_lang (a_lang: CODE_PHRASE): Boolean||True if code set knows about ‘a_lang’||
    1585 ||||has_code (a_code: CODE_PHRASE): Boolean||True if code set knows about ‘a_code’||
    1586 ||Invariants||Id_valid: id /= Void and then not id.is_empty||
    1587 
    1588 5.4.4 OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS Class
    1589 
    1590 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1591 
    1592 ||CLASS||OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS||
    1593 ||Purpose||List of identifiers for groups in the openEHR terminology.||
    1594 ||Constants||Signature||Meaning||
    1595 ||||Terminology_id: Stringis “openehr”||Name of openEHR’s own terminology||
    1596 ||||Group_id_audit_change_type: String is “audit change type”||||
    1597 ||||Group_id_attestation_reason: String is “attestation reason”||||
    1598 ||||Group_id_composition_category: Stringis “composition category”||||
    1599 ||||Group_id_event_math_function: String is “event math function”||||
    1600 ||||Group_id_instruction_states: Stringis “instruction states”||||
    1601 ||||Group_id_instruction_transitions: String is “instruction transitions”||||
    1602 ||||Group_id_null_flavours: String is “null flavours”||||
    1603 
    1604 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 58 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1605 
    1606 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Terminology Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1607 
    1608 ||CLASS||OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS||
    1609 ||||Group_id_property: Stringis “property”||||
    1610 ||||Group_id_participation_function: Stringis “participation function”||||
    1611 ||||Group_id_participation_mode: String is “participation mode”||||
    1612 ||||Group_id_subject_relationship: String is “subject relationship”||||
    1613 ||||Group_id_setting: String is “setting”||||
    1614 ||||Group_id_term_mapping_purpose: String is “term mapping purpose”||||
    1615 ||||Group_id_version_lifecycle_state: Stringis “version lifecycle state”||||
    1616 ||Functions||Signature||Meaning||
    1617 ||||valid_terminology_group_id (an_id: String): Boolean||Validity function to test if an identifier is in the set defined by this class.||
    1618 ||Invariants||||
    1619 
    1620 5.4.5 OPENEHR_CODE_SET_IDENTIFIERS Class
    1621 
    1622 ||CLASS||OPENEHR_CODE_SET_IDENTIFIERS||
    1623 ||Purpose||List of identifiers for code sets in the openEHR terminology.||
    1624 ||Constants||Signature||Meaning||
    1625 ||||Code_set_id_character_sets: String is “character sets”||||
    1626 ||||Code_set_id_compression_algorithms: Stringis “compression algorithms”||||
    1627 ||||Code_set_id_countries: String is “countries”||||
    1628 ||||Code_set_id_integrity_check_algorithms: Stringis “integrity check algorithms”||||
    1629 ||||Code_set_id_languages: String is “languages”||||
    1630 
    1631 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 59 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1632 
    1633   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1634 
    1635 Terminology Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1636 
    1637 ||CLASS||OPENEHR_CODE_SET_IDENTIFIERS||
    1638 ||||Code_set_id_media_types: String is “media types”||||
    1639 ||||Code_set_id_normal_statuses: String is “normal statuses”||||
    1640 ||Functions||Signature||Meaning||
    1641 ||||valid_code_set_id (an_id: String): Boolean||Validity function to test if an identifier is in the set defined by this class.||
    1642 ||Invariants||||
    1643 
    1644 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 60 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1645 
    1646 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1647 
    1648 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Measurement Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1649 
    1650 Measurement Package
    1651 
    1652 6.1 Overview
    1653 
    1654 The Measurement package defines a minimum of semantics relating to quantitative measurement, units, and conversion, enabling the Quantity package of the openEHR Data Types Information Model to be correctly expressed. As for the Terminology package, a simple service interface is assumed, which provides useful functions to other parts of the reference model. The definitions underlying measurement and units come from a variety of sources, including:
    1655 
    1656  * CEN ENV 12435, Medical Informatics - Expression of results of measurements in health sciences (see [http://www.centc251.org/ http://www.centc251.org] );
    1657  * the Unified Code for Units of Measure (UCUM), developed by Gunther Schadow and Clement J. !McDonald of The Regenstrief Institute (available in HL7v3 ballot materials; [http://www.hl7.org/ http://www.hl7.org).]
    1658 
    1659 These of course rest in turn upon a vast amount of literature and standards, mainly from ISO on the subject of scientific measurement.
    1660 
    1661 6.2 Service Interface
    1662 
    1663 A simple measurement data service interface is defined according to [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19264 FIGURE 7] , enabling quantitative semantics to be used formally from within the Reference Model. Note that this service as currently defined in no way seeks to properly model the semantics of units, conversions etc - it provides only the minimum functions required by the openEHR Reference Model.
    1664 
    1665 measurement
    1666 
    1667 ||MEASUREMENT_SERVICE||
    1668 ||||
    1669 ||is_valid_units_string (units: String): Boolean units_equivalent (units1, units2: String): Boolean||
    1670 
    1671 ||FIGURE 7 rm.support.measurement Package||
    1672 ||6.2.1||Class Definitions||
    1673 ||6.2.1.1||MEASUREMENT_SERVICE Class||
    1674 
    1675 ||CLASS||MEASUREMENT_SERVICE||
    1676 ||Purpose Functions||Defines an object providing proxy access to a measurement information service. Signature Meaning||
    1677 ||||is_valid_units_string (units: String): Boolean require units /= Void True if the units string ‘units’ is a valid string according to the HL7 UCUM specification.||
    1678 
    1679 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 61 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1680 
    1681   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1682 
    1683 Measurement Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1684 
    1685 ||CLASS||MEASUREMENT_SERVICE||
    1686 ||||units_equivalent (units1, units2: String): Boolean require units1 /= Void and then is_valid_units_string(units1) units2 /= Void and then is_valid_units_string(units2)||True if two units strings correspond to the same measured property.||
    1687 ||Invariants||||
    1688 
    1689 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 62 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1690 
    1691 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1692 
    1693 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Definition Package Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1694 
    1695 Definition Package
    1696 
    1697 7.1 Overview
    1698 
    1699 The definition[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19330 package, illustrated in FIGURE 8, defines symbolic definitions used by the] openEHR models. Only a small number are currently defined.
    1700 
    1701 definition
    1702 
    1703 BASIC_DEFINITIONS
    1704 
    1705 CR: Character is ‘\015’  LF: Character is ‘\012’
    1706 
    1707 OPENEHR_DEFINITIONS
    1708 
    1709 ||FIGURE 8 rm.support.definition Package||
    1710 ||7.2||Class Definitions||
    1711 ||7.2.1||OPENEHR_DEFINITIONS Class||
    1712 
    1713 ||CLASS||OPENEHR_DEFINITIONS||
    1714 ||Purpose||Inheritance class to provide access to constants defined in other packages.||
    1715 ||Inherit||BASIC_DEFINITIONS||
    1716 ||Attributes||Signature||Meaning||
    1717 ||Invariants||||
    1718 
    1719 7.2.2 BASIC_DEFINITIONS Class
    1720 
    1721 ||CLASS||BASIC_DEFINITIONS||
    1722 ||Purpose||Defines globally used constant values.||
    1723 ||Attributes||Signature||Meaning||
    1724 ||||CR: Character is ‘\015’||Carriage return character||
    1725 ||||LF: Character is ‘\012’||Linefeed character||
    1726 ||Invariants||||
    1727 
    1728 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 63 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1729 
    1730   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1731 
    1732 Definition Package [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1733 
    1734 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 64 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1735 
    1736 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1737 
    1738 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] References Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1739 
    1740 A References
    1741 
    1742 ||A.1||General||
    1743 ||1||Cimino J J. Desiderata for Controlled Medical vocabularies in the Twenty-First Century. IMIA||
    1744 ||||WG6 Conference, Jacksonville, Florida, Jan 19-22, 1997.||
    1745 
    1746 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 65 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1747 
    1748   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org
    1749 
    1750 References [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model] Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1751 
    1752 Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19440 Page 66 of 67] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}]
    1753 
    1754 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15429 © 2003-2006 The openEHR Foundation]  email: info@openEHR.org web: !http://www.openEHR.org
    1755 
    1756 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15311 Support Information Model]
    1757 
    1758 Rev [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 1.6.0]
    1759 
    1760 END OF DOCUMENT
    1761 
    1762 [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15315 Editors:{T Beale, S Heard}, {D Kalra, D Lloyd}] [file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_19439 Page 67 of 67] Date of Issue:[file:///home/skoba/src/openehr-jp/adl/trunk/pdf2html/rm/support_im/support_im.htm#LinkTarget_15448 08 Apr 2007]
    1763 
    1764   © 2003-2006 The openEHR Foundation    email: info@openEHR.org web: !http://www.openEHR.org