EHR - OpenEHR Base package v0.1.0

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

Key Elements Table
Differential Table
Snapshot Table

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.
Short	The EHR object is the root object and access point of an EHR for a subject of care.Base for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	contributions-valid: Contributions valid (`contributions.all(type().is_equal('CONTRIBUTION'))`) ehr-access-valid: Ehr access valid (`ehr_access.type().is_equal ('VERSIONED_EHR_ACCESS')`) ehr-status-valid: Ehr status valid (`ehr_status.type().is_equal('VERSIONED_EHR_STATUS')`) compositions-valid: Compositions valid (`compositions.all(type().is_equal ('VERSIONED_COMPOSITION'))`) directory-valid: Directory valid must be present (`directory.exists() implies directory.type().is_equal ('VERSIONED_FOLDER')`) folders-valid: Folders valid must be present (`folders.exists() implies folders.all(type().is_equal('VERSIONED_FOLDER'))`) directory-in-folders: Directory in folders must be present (`folders.exists() implies folders.item(1) = directory`)
2. EHR.system-id
Definition	The identifier of the logical EHR management system in which this EHR was created.
Short	The identifier of the logical EHR management system in which this EHR was created.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
4. EHR.ehr-id
Definition	The unique identifier of this EHR. NOTE: is is strongly recommended that a UUID always be used for this field.
Short	The unique identifier of this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
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`.
Short	List of contributions causing changes to this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
8. EHR.ehr-status
Definition	Reference to `EHR_STATUS` object for this EHR.
Short	Reference to `EHR_STATUS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
10. EHR.ehr-access
Definition	Reference to `EHR_ACCESS` object for this EHR.
Short	Reference to `EHR_ACCESS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
12. EHR.compositions
Definition	Master list of all Versioned Composition references in this EHR.
Short	Master list of all Versioned Composition references in this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
14. EHR.directory
Definition	Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.
Short	Optional directory structure for this EHR.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
16. EHR.time-created
Definition	Time of creation of the EHR.
Short	Time of creation of the EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/DV_DATE_TIME
Is Modifier	false
18. EHR.folders
Definition	Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.
Short	Optional additional Folder structures for this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
20. EHR.tags
Definition	Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.
Short	Optional list of tags associated with this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false

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.
Short	The EHR object is the root object and access point of an EHR for a subject of care.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	contributions-valid: Contributions valid (`contributions.all(type().is_equal('CONTRIBUTION'))`) ehr-access-valid: Ehr access valid (`ehr_access.type().is_equal ('VERSIONED_EHR_ACCESS')`) ehr-status-valid: Ehr status valid (`ehr_status.type().is_equal('VERSIONED_EHR_STATUS')`) compositions-valid: Compositions valid (`compositions.all(type().is_equal ('VERSIONED_COMPOSITION'))`) directory-valid: Directory valid must be present (`directory.exists() implies directory.type().is_equal ('VERSIONED_FOLDER')`) folders-valid: Folders valid must be present (`folders.exists() implies folders.all(type().is_equal('VERSIONED_FOLDER'))`) directory-in-folders: Directory in folders must be present (`folders.exists() implies folders.item(1) = directory`)
2. EHR.system-id
Definition	The identifier of the logical EHR management system in which this EHR was created.
Short	The identifier of the logical EHR management system in which this EHR was created.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
4. EHR.ehr-id
Definition	The unique identifier of this EHR. NOTE: is is strongly recommended that a UUID always be used for this field.
Short	The unique identifier of this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
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`.
Short	List of contributions causing changes to this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
8. EHR.ehr-status
Definition	Reference to `EHR_STATUS` object for this EHR.
Short	Reference to `EHR_STATUS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
10. EHR.ehr-access
Definition	Reference to `EHR_ACCESS` object for this EHR.
Short	Reference to `EHR_ACCESS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
12. EHR.compositions
Definition	Master list of all Versioned Composition references in this EHR.
Short	Master list of all Versioned Composition references in this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
14. EHR.directory
Definition	Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.
Short	Optional directory structure for this EHR.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
16. EHR.time-created
Definition	Time of creation of the EHR.
Short	Time of creation of the EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/DV_DATE_TIME
Is Modifier	false
18. EHR.folders
Definition	Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.
Short	Optional additional Folder structures for this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
20. EHR.tags
Definition	Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.
Short	Optional list of tags associated with this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false

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.
Short	The EHR object is the root object and access point of an EHR for a subject of care.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	contributions-valid: Contributions valid (`contributions.all(type().is_equal('CONTRIBUTION'))`) ehr-access-valid: Ehr access valid (`ehr_access.type().is_equal ('VERSIONED_EHR_ACCESS')`) ehr-status-valid: Ehr status valid (`ehr_status.type().is_equal('VERSIONED_EHR_STATUS')`) compositions-valid: Compositions valid (`compositions.all(type().is_equal ('VERSIONED_COMPOSITION'))`) directory-valid: Directory valid must be present (`directory.exists() implies directory.type().is_equal ('VERSIONED_FOLDER')`) folders-valid: Folders valid must be present (`folders.exists() implies folders.all(type().is_equal('VERSIONED_FOLDER'))`) directory-in-folders: Directory in folders must be present (`folders.exists() implies folders.item(1) = directory`)
2. EHR.system-id
Definition	The identifier of the logical EHR management system in which this EHR was created.
Short	The identifier of the logical EHR management system in which this EHR was created.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
4. EHR.ehr-id
Definition	The unique identifier of this EHR. NOTE: is is strongly recommended that a UUID always be used for this field.
Short	The unique identifier of this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID
Is Modifier	false
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`.
Short	List of contributions causing changes to this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
8. EHR.ehr-status
Definition	Reference to `EHR_STATUS` object for this EHR.
Short	Reference to `EHR_STATUS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
10. EHR.ehr-access
Definition	Reference to `EHR_ACCESS` object for this EHR.
Short	Reference to `EHR_ACCESS` object for this EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
12. EHR.compositions
Definition	Master list of all Versioned Composition references in this EHR.
Short	Master list of all Versioned Composition references in this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
14. EHR.directory
Definition	Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.
Short	Optional directory structure for this EHR.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
16. EHR.time-created
Definition	Time of creation of the EHR.
Short	Time of creation of the EHR.
Control	1..1
Type	http://openehr.org/fhir/StructureDefinition/DV_DATE_TIME
Is Modifier	false
18. EHR.folders
Definition	Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.
Short	Optional additional Folder structures for this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false
20. EHR.tags
Definition	Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.
Short	Optional list of tags associated with this EHR.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/OBJECT_REF
Is Modifier	false

IG © 2022+ openEHR + HL7. Package openehr.base#0.1.0 based on FHIR 5.0.0. Generated 2026-08-23
Links: Table of Contents | QA Report