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/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions

Logical Model: EHR - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the EHR logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. EHR
Definition

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


Base definition for all types defined in FHIR type system.

ShortThe EHR object is the root object and access point of an EHR for a subject of careBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHR.system-id
Definition

The identifier of the logical EHR management system in which this EHR was created.

ShortThe identifier of the logical EHR management system in which this EHR was created
Control1..*
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
4. EHR.ehr-id
Definition

The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.

ShortThe unique identifier of this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
6. EHR.contributions
Definition

List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and VERSIONED_FOLDER.

ShortList of contributions causing changes to this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
8. EHR.ehr-status
Definition

Reference to EHR_STATUS object for this EHR.

ShortReference to EHR_STATUS object for this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
10. EHR.ehr-access
Definition

Reference to EHR_ACCESS object for this EHR.

ShortReference to EHR_ACCESS object for this EH
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
12. EHR.compositions
Definition

Master list of all Versioned Composition references in this EHR.

ShortMaster list of all Versioned Composition references in this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
14. EHR.directory
Definition

Optional directory structure for this EHR. If present, this is a reference to the first member of folders.

ShortOptional directory structure for this EHR. If present, this is a reference to the first member of folders
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
16. EHR.time-created
Definition

Time of creation of the EHR.

ShortTime of creation of the EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
18. EHR.folders
Definition

Optional additional Folder structures for this EHR. If set, the directory attribute refers to the first member

ShortOptional additional Folder structures for this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
20. EHR.tags
Definition

Optional list of tags associated with this EHR. Tag target values can only be within the same EHR.

ShortOptional list of tags associated with this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. EHR
Definition

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

ShortThe EHR object is the root object and access point of an EHR for a subject of care
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHR.system-id
Definition

The identifier of the logical EHR management system in which this EHR was created.

ShortThe identifier of the logical EHR management system in which this EHR was created
Control1..*
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
4. EHR.ehr-id
Definition

The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.

ShortThe unique identifier of this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
6. EHR.contributions
Definition

List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and VERSIONED_FOLDER.

ShortList of contributions causing changes to this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
8. EHR.ehr-status
Definition

Reference to EHR_STATUS object for this EHR.

ShortReference to EHR_STATUS object for this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
10. EHR.ehr-access
Definition

Reference to EHR_ACCESS object for this EHR.

ShortReference to EHR_ACCESS object for this EH
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
12. EHR.compositions
Definition

Master list of all Versioned Composition references in this EHR.

ShortMaster list of all Versioned Composition references in this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
14. EHR.directory
Definition

Optional directory structure for this EHR. If present, this is a reference to the first member of folders.

ShortOptional directory structure for this EHR. If present, this is a reference to the first member of folders
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
16. EHR.time-created
Definition

Time of creation of the EHR.

ShortTime of creation of the EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
18. EHR.folders
Definition

Optional additional Folder structures for this EHR. If set, the directory attribute refers to the first member

ShortOptional additional Folder structures for this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
20. EHR.tags
Definition

Optional list of tags associated with this EHR. Tag target values can only be within the same EHR.

ShortOptional list of tags associated with this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. EHR
Definition

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

ShortThe EHR object is the root object and access point of an EHR for a subject of care
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHR.system-id
Definition

The identifier of the logical EHR management system in which this EHR was created.

ShortThe identifier of the logical EHR management system in which this EHR was created
Control1..*
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
4. EHR.ehr-id
Definition

The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.

ShortThe unique identifier of this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
6. EHR.contributions
Definition

List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and VERSIONED_FOLDER.

ShortList of contributions causing changes to this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
8. EHR.ehr-status
Definition

Reference to EHR_STATUS object for this EHR.

ShortReference to EHR_STATUS object for this EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
10. EHR.ehr-access
Definition

Reference to EHR_ACCESS object for this EHR.

ShortReference to EHR_ACCESS object for this EH
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
12. EHR.compositions
Definition

Master list of all Versioned Composition references in this EHR.

ShortMaster list of all Versioned Composition references in this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
14. EHR.directory
Definition

Optional directory structure for this EHR. If present, this is a reference to the first member of folders.

ShortOptional directory structure for this EHR. If present, this is a reference to the first member of folders
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
16. EHR.time-created
Definition

Time of creation of the EHR.

ShortTime of creation of the EHR
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
18. EHR.folders
Definition

Optional additional Folder structures for this EHR. If set, the directory attribute refers to the first member

ShortOptional additional Folder structures for this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
20. EHR.tags
Definition

Optional list of tags associated with this EHR. Tag target values can only be within the same EHR.

ShortOptional list of tags associated with this EHR
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse