the ehr archetype model the template object model · pdf filethe template object model (tom)...

Release 1

The openEHR Archetype Model

The Template Object Model (TOM)

Keywords: EHR, ADL, health records, archetypes, templates

Editors: {T Beale, S Heard}a

a. Ocean Informatics

Revision: 0.5 Pages: 19 Date of issue: 13 Mar 2007

Data StructuresData Types

DemographicEHR

Security

EHR Extract

Archetype OM

Support

Common

Integration

Composition openEHR Archetype ProfileTemplate OM

ADL

( in development)

© 2005-2007 The openEHR Foundation

The openEHR Foundation is an independent, non-profit community, facilitating the sharing of health records by consumers and clinicians via open-source, standards-based implementations.

Founding Chairman

David Ingram, Professor of Health Informatics, CHIME, University College London

Founding Members

Dr P Schloeffel, Dr S Heard, Dr D Kalra, D Lloyd, T Beale

email: [email protected] web: http://www.openEHR.org

http://www.openEHR.org

The Template Object Model (TOM)Rev 0.5

Copyright Notice

© Copyright openEHR Foundation 2001 - 2007All Rights Reserved

1. This document is protected by copyright and/or database right throughout the world and is owned by the openEHR Foundation.

2. You may read and print the document for private, non-commercial use. 3. You may use this document (in whole or in part) for the purposes of making

presentations and education, so long as such purposes are non-commercial and are designed to comment on, further the goals of, or inform third parties about, openEHR.

4. You must not alter, modify, add to or delete anything from the document you use (except as is permitted in paragraphs 2 and 3 above).

5. You shall, in any use of this document, include an acknowledgement in the form: "© Copyright openEHR Foundation 2001-2007. All rights reserved. www.openEHR.org"

6. This document is being provided as a service to the academic community and on a non-commercial basis. Accordingly, to the fullest extent permitted under applicable law, the openEHR Foundation accepts no liability and offers no warranties in relation to the materials and documentation and their content.

7. If you wish to commercialise, license, sell, distribute, use or otherwise copy the materials and documents on this site other than as provided for in paragraphs 1 to 6 above, you must comply with the terms and conditions of the openEHR Free Commercial Use Licence, or enter into a separate written agreement with openEHR Foundation covering such activities. The terms and conditions of the openEHR Free Commercial Use Licence can be found at http://www.openehr.org/free_commercial_use.htm

Date of Issue: 13 Mar 2007 of 19 Editors:{T Beale, S Heard}

© 2005-2007 The openEHR Foundationemail: [email protected] web: http://www.openEHR.org


Amendment Record

Issue Details Raiser Completed

R E L E A S E 1.0.1

0.5 Minor content modifications. T Beale 13 Mar 2007

R E L E A S E 1.0

0.5rc1 CR-000178. Add Template Object Model to AM. Initial Writing

T Beale 10 Nov 2005

R E L E A S E 0.96

Editors:{T Beale, S Heard} of 19 Date of Issue: 13 Mar 2007



Trademarks

Microsoft is a trademark of the Microsoft Corporation



The Template Object Model (TOM) IntroductionRev 0.5

1 Introduction

1.1 PurposeThis document describes an object model for openEHR templates, based only upon the generallyaccepted semantics of object models (typified by the OMG UML meta-model). The model presentedhere can be used as a basis for building software that processes archetypes and templates, independentof their persistent representation. As a specification, it can be treated as an API for templates.

It is recommended that the openEHR ADL and AOM documents be read in conjunction with thisdocument, since they contain a detailed explanation of the semantics of archetypes.

1.2 Related DocumentsPrerequisite documents for reading this document include:

• The openEHR Architecture OverviewRelated documents include:

• The openEHR Archetype Definition Language (ADL)• The openEHR Archetype Object Model (AOM)

1.3 NomenclatureIn this document, the term ‘attribute’ denotes any stored property of a type defined in an objectmodel, including primitive attributes and any kind of relationship such as an association or aggrega-tion. XML ‘attributes’ are always referred to explicitly as ‘XML attributes’.

1.4 StatusThis document is under development, and is published as a proposal for input to standards processesand implementation works.

The latest version of this document can be found in PDF format at http://svn.openehr.org/spec-ification/BRANCHES/Release-1.0.1-candidate/publishing/architecture/am/tom.pdf.New versions are announced on [email protected].

Blue text indicates sections under active development.

THIS DOCUMENT IS UNDER ACTIVE DEVELOPMENT AND IS NOT YET SUBJECT TOARB CONTROL.

1.5 Background

1.5.1 What is a Template?The openEHR template concept is related to openEHR archetypes. Where archetypes define widelyre-usable components of information, templates are locally defined and encapsulate local usage ofarchetypes, and relevant preferences. In informal terms, templates include the following semantics:

archetype ‘chaining’: choice of archetypes to make up a larger structure, specified viaindicating identifiers of archetypes to fill slots in higher-level archetypes;



http://svn.openehr.org/specification/BRANCHES/Release-1.0.1-candidate/publishing/architecture/am/tom.pdf

http://svn.openehr.org/specification/BRANCHES/Release-1.0.1-candidate/publishing/architecture/am/tom.pdf

mailto:[email protected]

mailto:[email protected]

Introduction The Template Object Model (TOM)Rev 0.5

local optionality: narrowing of some or all 0..1 constraints to either 1..1 (mandatory) or 0..0(removal) according to local needs;

tightened constraints: tightening of other constraints, including cardinality, value ranges,terminology value sets and so on;

default values: choice of default values for use in templated structure at runtime.

At runtime, templates are used with archetypes to create data and to control its modification. Tem-plate design is usually strongly linked to the design of corresponding screen forms.

1.6 ToolsVarious tools exist for creating and processing templates. The openEHR tools are available in sourceand binary form from the website (http://www.openEHR.org).



http://www.openEHR.org

The Template Object Model (TOM) The Template Object ModelRev 0.5

2 The Template Object Model

2.1 Design BackgroundAn underpinning principle of openEHR is the use of archetypes and templates, which are formalmodels of domain concepts controlling data structure and content of data. The elements of this archi-tecture are twofold.

• The openEHR Reference Model (RM), defining the structure and semantics of information.• The openEHR Archetype Model (AM), defining the structure and semantics of archetypes

and templates. The AM consists of the archetype language definition language (ADL), theArchetype Object Model (AOM), the openEHR Archetype profile (OAP), and the TemplateObject Model (TOM).

This document describes the Template Object Model, which is used with the Archetype Object Modelas a basis for archetype-processing software.

2.2 Package StructureThe openEHR template package is illustrated in FIGURE 1.

Two forms of templates are used in openEHR. The form created by template design tools is known asthe ‘specification’ form, since it specifies the contents of a template using references to archetypesand other additions. The specification form is defined in the am.template.template_spec package.The second form is the ‘operational’ form, created by processing a template specification so as to par-tially pre-populate terminology value sets, expand out references to other templates and archetypes,and create runtime structures that representing other aspects of the specification. The operationalform is specified in the operational_template package.

FIGURE 1 openehr.am.template Package in context

archetype

am

openehr_profile

template

template_spec operational_template



The Template Object Model The Template Object Model (TOM)Rev 0.5



The Template Object Model (TOM) The Template_spec PackageRev 0.5

3 The Template_spec Package

3.1 OverviewTo Be Continued:



TEMPLATE_CONSTRAINT_SPECconstraint: C_OBJECT

ATE_DEFAULTE_SPECt_value: ANY

TEMPLATE_NODE_CONSTRAINT_SPEC

onstraints

*

TEMPLATE_OBJECT_NODE_CONSTRAINT_SPEC

s

AUTHORED_RESOURCE

template_spec

FIGURE 2 The openehr.am.template.template_spec Package

fillers*

TEMPLATE_SPECtemplate_id: TEMPLATE_ID

TEMPLATE_ARCHETYPE_SPECarchetype: ARCHETYPEarchetype_id: ARCHETYPE_ID

TEMPLATE_NODE_SPECpath: Stringsource: ARCHETYPE_CONSTRAINTtarget: ARCHETYPE_CONSTRAINT

path_specs

*

TEMPLATE_ATTRIBUTE_SPECsource: C_ATTRIBUTEtarget: C_ATTRIBUTE

TEMPLATE_OBJECT_SPECsource: C_OBJECTtarget: C_OBJECT

TEMPLATE_CARDINALITY_SPECcardinality: CARDINALITY

TEMPLATE_EXISTENCE_SPECexistence: Interval<INTEGER>

TEMPL_VALUdefaul

TEMPLATE_OCCURRENCES_SPECoccurrences: Interval<INTEGER>

definition

1

TEMPLATE_SLOT_SPECpath: String

slot_owner1slot_specs *

owner1

TEMPLATE_SLOT_FILLER

c

TEMPLATE_ATTRIBUTE_NODE_CONSTRAINT_SPEC

constraints

*constraint

*

The Template Object Model (TOM) The Template_spec PackageRev 0.5

3.1.1 Example(TEMPLATE_SPEC) <

definition = <archetype_id = <openEHR-EHR-COMPOSITION.report.v1>slot_specs = <

[“/content”] = <path = </content>fillers = <

[“findings”] = <archetype_id = <openEHR-EHR-SECTION.findings.v1>slot_specs = <

[“items”] = <path = <items>fillers = <

[“histology”] = <cardinality = <min = <1> max = <1>>archetype_id = <openEHR-EHR-

OBSERVATION.histology.v1>>

>>

>>[“summary”] = <

archetype_id = <openEHR-EHR-SECTION.summary.v1>slot_specs = <

[“items”] = <path = <items>fillers = <

[“clinical_synopsis”] = <archetype_id = <openEHR-EHR-

EVALUATION.clinical_synopsis.v1>>[“problem-diagnosis-histological”] = <

archetype_id = <openEHR-EHR-EVALUATION.problem-diagnosis-histological.v1>

path_specs = <path = </data[at0001]/items[at0031]>[1] = <

cardinality = <max = <0>>>

>>

>>

>>

>>

>>

>

3.2 Class Definitions



The Template_spec Package The Template Object Model (TOM)Rev 0.5

3.2.1 TEMPLATE_SPEC Class

CLASS TEMPLATE_SPEC

Purpose

Use

Abstract Signature Meaning

template_id: ARCHETYPE_ID

Invariant xxx



The Template Object Model (TOM) The Operational_template PackageRev 0.5

4 The Operational_template Package

4.1 OverviewTo Be Continued:

4.2 Class Definitions

4.2.1 TEMPLATE Class

CLASS TEMPLATE

Purpose

Use

Abstract Signature Meaning

template_id: TEMPLATE_ID

Invariant xxx

FIGURE 3 The openehr.am.template.operational_template Package

operational_template

TEMPLATEtemplate_id: TEMPLATE_ID

TEMPLATE_DEFAULT_VALUEpath: OG_PATHvalue: ANY

default_values

*root1 C_COMPLEX_OBJECT



The Operational_template Package The Template Object Model (TOM)Rev 0.5




A ReferencesPublications1 Beale T. Archetypes: Constraint-based Domain Models for Future-proof Information Systems.

OOPSLA 2002 workshop on behavioural semantics. Available at http://www.deepthought.com.au/it/archetypes.html.

2 Beale T. Archetypes: Constraint-based Domain Models for Future-proof Information Systems. 2000. Available at http://www.deepthought.com.au/it/archetypes.html.

3 Beale T, Heard S. The Archetype Definition Language (ADL). See http://www.openehr.org/re-positories/spec-dev/latest/publishing/architecture/archetypes/lan-guage/ADL/REV_HIST.html.

4 Heard S, Beale T. Archetype Definitions and Principles. See http://www.openehr.org/reposi-tories/spec-dev/latest/publishing/architecture/archetypes/princi-ples/REV_HIST.html.

5 Heard S, Beale T. The openEHR Archetype System. See http://www.openehr.org/reposito-ries/spec-dev/latest/publishing/architecture/archetypes/system/REV_HIST.ht-ml.

Resources6 openEHR. EHR Reference Model. See http://www.openehr.org/repositories/spec-

dev/latest/publishing/architecture/top.html.



http://www.deepthought.com.au/it/archetypes.html

http://www.deepthought.com.au/it/archetypes.html

http://www.openehr.org/repositories/spec-dev/latest/publishing/architecture/archetypes/system/REV_HIST.html



http://www.openehr.org/repositories/spec-dev/latest/publishing/architecture/archetypes/principles/REV_HIST.html



http://www.openehr.org/repositories/spec-dev/latest/publishing/architecture/archetypes/language/ADL/REV_HIST.html



http://www.openehr.org/repositories/spec-dev/latest/publishing/architecture/top.html

http://www.openehr.org/repositories/spec-dev/latest/publishing/architecture/top.html




END OF DOCUMENT