Archetype Identification

Acknowledgements

Primary Author

  • Thomas Beale, Ars Semantica, UK; openEHR International Board.

Contributors

This specification has benefited from input from the openEHR and wider health informatics community. The openEHR Foundation would like to recognise the following people and institutions.

  • Sebastian Garde PhD, Ocean Informatics

  • Heather Leslie MD, Ocean Informatics

  • Ian McNicoll MD, MSc, Ocean Informatics UK

  • Martin van der Meer, Code24, Netherlands

  • David Moner PhD, Universitat Politècnica de València, Spain

  • Erik Sundvall PhD, Linkoping University, Sweden

Trademarks

  • 'openEHR' is a registered trademark of The openEHR Foundation

  • 'SNOMED CT' is a registered trademark of IHTSDO

Supporters

The work reported in this paper has been funded by the following organisations:

Preface

Purpose

The purpose of this document is to describe an identification system for openEHR archetypes (including templates). This includes archetypes created by any organisation, including the openEHR Foundation, standards bodies and clinical modelling initiatives and government programmes.

The semantics covered include:

  • formal human-readable and machine identifiers;

  • versioning;

  • lifecycle management and states;

  • referencing artefacts from elsewhere;

  • deal with transfer and forking;

  • supporting integrity and non-repudiation.

Unless otherwise stated, in this document, the term 'artefact' refers specifically to these artefact types.

Related Documents

Prerequisite documents for reading this document include:

Related documents include:

Status

This specification is in the STABLE state. The development version of this document can be found at https://specifications.openehr.org/releases/AM/development/Identification.html.

Known omissions or questions are indicated in the text with a 'to be determined' paragraph, as follows:

TBD: (example To Be Determined paragraph)

Feedback

Feedback may be provided on the openEHR ADL forum.

Issues may be raised on the specifications Problem Report tracker.

To see changes made due to previously reported issues, see the AM component Change Request tracker.

Conformance

Conformance of a data or software artifact to an openEHR 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 derivations from underlying models, ITS conformance indicates model conformance.

Tools

Various tools exist for creating and processing archetypes. The ADL Workbench is a reference compiler, visualiser and editor. The openEHR tools can be downloaded from the website. Source projects can be found at the openEHR Github project.

Amendment Record

Issue Details Raiser, Implementer Completed

AM Release 2.3.0

0.7.9

SPECPUB-7: Convert citations to bibtex form.

T Beale

15 Dec 2019

0.7.8

SPECAM-58. Correct errors and improve examples - S Garde review Nov 2018. Change instance_uid to build_uid.

S Garde

18 Nov 2018

AM Release 2.2.0

AM Release 2.1.0

0.7.7

SPECAM-52Improve explanation of version number progression in section 4.2; correct version identifier grammar (addresses SPECPR-254).

E Sundvall

13 Feb 2018

Correct formatting, re-instate Archetype model diagram at start of section 3.

T Beale

28 Jan 2018

0.7.6

SPECAM-41. Correct 'unstable' to 'alpha'; correct version-related typo; update versioning incrementing rules.

S Garde

18 Jun 2017

AM Release 2.0.6

0.7.5

Replace '-unstable' with '-alpha' to be compatible with typical tools.

I McNicoll

01 Feb 2015

0.7.4

Replace '+uNNN' with '-unstable'; simplify the number after 'rc' to an integer build count.

S Garde,
I McNicoll,
H Leslie

29 Sep 2014

0.7.3

Remove build_count, replace with build_uid.

I McNicoll
T Beale

28 May 2014

0.7.2

Change ARCHEYTPE_HRID.commit_number to instance_uid. Build_count reset to 1 on each version change. Adjust diagrams and explanations.

S Garde
I McNicoll
T Beale

21 May 2014

0.7.1

Simplify development state in lifecycle; merge 'initial' and rename 'draft'.

S Garde
I McNicoll

09 May 2014

0.7.0

Rewrite referencing section; update 'problem description; further grammar improvements.

T Beale

20 Jun 2013

0.6.5

Remove errors and ambiguities to do with explanation of human readable identifier; improve nomenclature; rewrite grammar.

T Beale

15 Jun 2013

0.6.0

Major update based on CKM clinical group analysis, and feedback from the CIMI and openEHR communities.

S Garde
H Leslie
I McNicoll
T Beale

21 Apr 2013

0.2.0

Refinements to do with template identification.
Review from Medical Centrum Alkmaar (Netherlands).

T Beale
M van der Meer

01 Feb 2010

0.1.0

Initial Writing.

T Beale

09 Jul 2009

Sections