EHR Extract Information Model

Acknowledgements

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

  • University College London - Centre for Health Informatics and Multi-professional Education (CHIME);

  • Ocean Informatics;

Special thanks to David Ingram, Emeritus Professor of Health Informatics at UCL, who provided a vision and collegial working environment ever since the days of GEHR (1992).

Preface

Purpose

This document defines the openEHR Data Types This document describes the architecture of the openEHR EHR Extract Information Model. This model formally defines the concepts of ‘extract request’, ‘extract’, various kinds of content including openEHR and non-openEHR, and a message wrapper. It covers use cases including EHR system communication, other clinical content messaging, and EHR system synchronisation, as well as providing an equivalent of the ISO 13606 EHR Extract.

The intended audience includes:

  • Standards bodies producing health informatics standards;

  • Academic groups using openEHR;

  • The open source healthcare community;

  • Solution vendors;

  • Medical informaticians and clinicians interested in health information.

  • Health data managers.

Related Documents

Prerequisite documents for reading this document include:

Status

This specification is in the STABLE state. The development version of this document can be found at https://specifications.openehr.org/releases/RM/latest/ehr_extract.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 technical mailing list.

Issues may be raised on the specifications Problem Report tracker.

To see changes made due to previously reported issues, see the RM 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.

Amendment Record

Issue Details Raiser Completed

RM Release 1.0.4

2.1.2

SPECPUB-3. Re-instate inheritance from descendants of X_VERSIONED_OBJECT<T> to X_VERSIONED_OBJECT from Release 1.0.2 (lost in original UML conversion).

T Beale

25 May 2016

RM Release 1.0.3

2.1.1

SPECRM-30. Correct documentation errors in EHR_EXTRACT class (remove text about generic parameters).

R Chen,
H Frankel,
T Beale

10 Oct 2015

SPECRM-24. Correct EHR Extract IM typographical errors.

P Gummer,
T Beale

SPECRM-13. Convert various fields to coded in EHR Extract.
EXTRACT_SPEC.type, EXTRACT_ACTION_REQUEST.action and EXTRACT_UPDATE_SPEC.trigger_events are converted to coded types.

H Frankel,
T Beale

2.1

SPECRM-14: Various EHR Extract model improvements:
Remove EXTRACT_SPEC.includes_directory and directory_archetype; remove EXTRACT_ENTITY_CONTENT class;
make EXTRACT_FOLDER classes the main containment structure; move X_VERSIONED_OBJECT to openEHR_extract package;
change EXTRACT.request_id to a HIER_OBJECT_ID;
change GENERIC_EXTRACT_ITEM.other_details to Hash<String, String>.

H Frankel,
T Beale

29 Jun 2011

SPECRM-6. Correct modelling inconsistency of every EXTRACT_CHAPTER being related to a single Entity.

T Beale

Release 1.0.1

2.0

SPEC-189. Add LOCATABLE.parent. New invariant in EHR_EXTRACT.

T Beale

20 Feb 2007

SPECRM-10: Upgrade EHR_EXTRACT to Release-1.0. Major redevelopment.
Added X_VERSIONED_OBJECT, X_VERSIONED_FOLDER, X_VERSIONED_COMPOSITION, X_VERSIONED_EHR_ACCESS, X_VERSIONED_EHR_STATUS, X_VERSIONED_PARTY.

T Beale

SPEC-219: Use constants instead of literals to refer to terminology in RM.

R Chen

Release 0.95

1.3.5

SPEC-118. Make package names lower case.

T Beale

10 Dec 2004

Release 0.9

1.3.4

SPEC-41. Visually differentiate primitive types in openEHR documents.

D Lloyd

04 Oct 2003

1.3.3

SPEC-13. Change key class names, according to CEN ENV 13606.

S Heard, D Kalra, D Lloyd, T Beale

15 Sep 2003

1.3.2

SPEC-3, SPEC-4 (changes to versioning and LOCATABLE). MESSAGE_CONTENT now inherits from LOCATABLE.

T Beale, Z Tun

18 Mar 2003

1.3.1

Formally validated using ISE Eiffel 5.2. Revised structure of MESSAGE class to align better with CEN 13606-4. Renamed EHR_EXTRACT.hca_authorising to originator, similar to 13606.

T Beale

26 Feb 2003

1.3

Changes post CEN WG meeting Rome Feb 2003. Added attestations to X_TRANSACTION class. Significantly improved documentation of requirements, comparison to CEN 13606-4.

T Beale,
S Heard,
D Kalra,
D Lloyd

07 Feb 2003

1.2.2

Minor corrections to diagrams and class definitions.

Z Tun

08 Jan 2003

1.2.1

Added senders_reference to conform to CEN 13606-4:2000 section 7.4.

T Beale

04 Jan 2003

1.2

Rewritten and restructured as two packages.

T Beale

07 Nov 2002

1.1

Moved part of EHR_EXTRACT into MESSAGE. Allow for multilevel archetypable Folder structures.

T Beale,
D Kalra,
D Lloyd

07 Oct 2002

1.0

Taken from EHR RM.

T Beale

07 Oct 2002

Sections