OpenEHR Base package
0.1.0 - First Draft International flag

OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions

Logical Model: EHR

Official URL: http://openehr.org/fhir/StructureDefinition/EHR Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: EHR

The EHR object is the root object and access point of an EHR for a subject of care.

Original Source: specifications.openehr.org

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")

This structure is derived from Any

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")

This structure is derived from Any

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")

Differential View

This structure is derived from Any

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHR C 0..* Any The EHR object is the root object and access point of an EHR for a subject of care.
Constraints: Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders
... system_id 1..1 HIER_OBJECT_ID The identifier of the logical EHR management system in which this EHR was created.
... ehr_id 1..1 HIER_OBJECT_ID The unique identifier of this EHR.
... contributions 0..* OBJECT_REF List of contributions causing changes to this EHR.
... ehr_access 1..1 OBJECT_REF Reference to `EHR_ACCESS` object for this EHR.
... compositions 0..* OBJECT_REF Master list of all Versioned Composition references in this EHR.
... directory 0..1 OBJECT_REF Optional directory structure for this EHR.
... time_created 1..1 DV_DATE_TIME Time of creation of the EHR.
... folders 0..* OBJECT_REF Optional additional Folder structures for this EHR.
... tags 0..* OBJECT_REF Optional list of tags associated with this EHR.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Compositions_valid error EHR Compositions valid for_all c in compositions | c.type().is_equal (\"VERSIONED_COMPOSITION\")
Contributions_valid error EHR Contributions valid for_all c in contributions | c.type().is_equal(\"CONTRIBUTION\")
Directory_in_folders error EHR Directory in folders must be present folders.exists() implies folders.item(1) = directory
Directory_valid error EHR Directory valid must be present directory.exists() implies directory.type().is_equal (\"VERSIONED_FOLDER\")
Ehr_access_valid error EHR Ehr access valid ehr_access.type().is_equal (\"VERSIONED_EHR_ACCESS\")
Ehr_status_valid error EHR Ehr status valid ehr_status.type().is_equal(\"VERSIONED_EHR_STATUS\")
Folders_valid error EHR Folders valid must be present folders.exists() implies for_all f in folders | f.type().is_equal(\"VERSIONED_FOLDER\")

This structure is derived from Any

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 3

 

Other representations of profile: CSV, Excel