FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EHR.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-EHR.html |
| URL | http://openehr.org/fhir/StructureDefinition/EHR |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | EHR |
| Title | EHR |
| Realm | uv |
| Authority | hl7 |
| Description | The EHR object is the root object and access point of an EHR for a subject of care. |
| Type | http://openehr.org/fhir/StructureDefinition/EHR |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | Any | Any |
| openehr.base#0.1.0-snapshot | DV-DATE-TIME | DV_DATE_TIME |
| openehr.base#0.1.0-snapshot | HIER-OBJECT-ID | HIER_OBJECT_ID |
| openehr.base#0.1.0-snapshot | OBJECT-REF | OBJECT_REF |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EHR
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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_status | 1..1 | OBJECT_REF | Reference to `EHR_STATUS` object for 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. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "EHR",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/development/ehr.html#_ehr_class"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/EHR",
"version": "0.1.0-snapshot",
"name": "EHR",
"title": "EHR",
"status": "active",
"experimental": false,
"date": "2025-09-06T15:35:39+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "The EHR object is the root object and access point of an EHR for a subject of care. ",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://openehr.org/fhir/StructureDefinition/EHR",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/Any",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "EHR",
"path": "EHR",
"short": "The EHR object is the root object and access point of an EHR for a subject of care.",
"definition": "The EHR object is the root object and access point of an EHR for a subject of care. ",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "Contributions_valid",
"severity": "error",
"human": "Contributions valid",
"expression": "for_all c in contributions | c.type().is_equal(\\\"CONTRIBUTION\\\")"
},
{
"key": "Ehr_access_valid",
"severity": "error",
"human": "Ehr access valid",
"expression": "ehr_access.type().is_equal (\\\"VERSIONED_EHR_ACCESS\\\")"
},
{
"key": "Ehr_status_valid",
"severity": "error",
"human": "Ehr status valid",
"expression": "ehr_status.type().is_equal(\\\"VERSIONED_EHR_STATUS\\\")"
},
{
"key": "Compositions_valid",
"severity": "error",
"human": "Compositions valid",
"expression": "for_all c in compositions | c.type().is_equal (\\\"VERSIONED_COMPOSITION\\\")"
},
{
"key": "Directory_valid",
"severity": "error",
"human": "Directory valid must be present",
"expression": "directory.exists() implies directory.type().is_equal (\\\"VERSIONED_FOLDER\\\")"
},
{
"key": "Folders_valid",
"severity": "error",
"human": "Folders valid must be present",
"expression": "folders.exists() implies for_all f in folders | f.type().is_equal(\\\"VERSIONED_FOLDER\\\")"
},
{
"key": "Directory_in_folders",
"severity": "error",
"human": "Directory in folders must be present",
"expression": "folders.exists() implies folders.item(1) = directory"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EHR.system-id",
"path": "EHR.system_id",
"short": "The identifier of the logical EHR management system in which this EHR was created.",
"definition": "The identifier of the logical EHR management system in which this EHR was created.",
"min": 1,
"max": "1",
"base": {
"path": "EHR.system_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-id",
"path": "EHR.ehr_id",
"short": "The unique identifier of this EHR.",
"definition": "The unique identifier of this EHR.\n\nNOTE: is is strongly recommended that a UUID always be used for this field.",
"min": 1,
"max": "1",
"base": {
"path": "EHR.ehr_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier": false
},
{
"id": "EHR.contributions",
"path": "EHR.contributions",
"short": "List of contributions causing changes to this EHR.",
"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`.",
"min": 0,
"max": "*",
"base": {
"path": "EHR.contributions",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-status",
"path": "EHR.ehr_status",
"short": "Reference to `EHR_STATUS` object for this EHR.",
"definition": "Reference to `EHR_STATUS` object for this EHR.",
"min": 1,
"max": "1",
"base": {
"path": "EHR.ehr_status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-access",
"path": "EHR.ehr_access",
"short": "Reference to `EHR_ACCESS` object for this EHR.",
"definition": "Reference to `EHR_ACCESS` object for this EHR.",
"min": 1,
"max": "1",
"base": {
"path": "EHR.ehr_access",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.compositions",
"path": "EHR.compositions",
"short": "Master list of all Versioned Composition references in this EHR.",
"definition": "Master list of all Versioned Composition references in this EHR.",
"min": 0,
"max": "*",
"base": {
"path": "EHR.compositions",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.directory",
"path": "EHR.directory",
"short": "Optional directory structure for this EHR.",
"definition": "Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.",
"min": 0,
"max": "1",
"base": {
"path": "EHR.directory",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.time-created",
"path": "EHR.time_created",
"short": "Time of creation of the EHR.",
"definition": "Time of creation of the EHR.",
"min": 1,
"max": "1",
"base": {
"path": "EHR.time_created",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "EHR.folders",
"path": "EHR.folders",
"short": "Optional additional Folder structures for this EHR.",
"definition": "Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.",
"min": 0,
"max": "*",
"base": {
"path": "EHR.folders",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.tags",
"path": "EHR.tags",
"short": "Optional list of tags associated with this EHR.",
"definition": "Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.",
"min": 0,
"max": "*",
"base": {
"path": "EHR.tags",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "EHR",
"path": "EHR",
"short": "The EHR object is the root object and access point of an EHR for a subject of care.",
"definition": "The EHR object is the root object and access point of an EHR for a subject of care. ",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Contributions_valid",
"severity": "error",
"human": "Contributions valid",
"expression": "for_all c in contributions | c.type().is_equal(\\\"CONTRIBUTION\\\")"
},
{
"key": "Ehr_access_valid",
"severity": "error",
"human": "Ehr access valid",
"expression": "ehr_access.type().is_equal (\\\"VERSIONED_EHR_ACCESS\\\")"
},
{
"key": "Ehr_status_valid",
"severity": "error",
"human": "Ehr status valid",
"expression": "ehr_status.type().is_equal(\\\"VERSIONED_EHR_STATUS\\\")"
},
{
"key": "Compositions_valid",
"severity": "error",
"human": "Compositions valid",
"expression": "for_all c in compositions | c.type().is_equal (\\\"VERSIONED_COMPOSITION\\\")"
},
{
"key": "Directory_valid",
"severity": "error",
"human": "Directory valid must be present",
"expression": "directory.exists() implies directory.type().is_equal (\\\"VERSIONED_FOLDER\\\")"
},
{
"key": "Folders_valid",
"severity": "error",
"human": "Folders valid must be present",
"expression": "folders.exists() implies for_all f in folders | f.type().is_equal(\\\"VERSIONED_FOLDER\\\")"
},
{
"key": "Directory_in_folders",
"severity": "error",
"human": "Directory in folders must be present",
"expression": "folders.exists() implies folders.item(1) = directory"
}
],
"isModifier": false
},
{
"id": "EHR.system-id",
"path": "EHR.system_id",
"short": "The identifier of the logical EHR management system in which this EHR was created.",
"definition": "The identifier of the logical EHR management system in which this EHR was created. \n",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-id",
"path": "EHR.ehr_id",
"short": "The unique identifier of this EHR.",
"definition": "The unique identifier of this EHR.\n\nNOTE: is is strongly recommended that a UUID always be used for this field.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier": false
},
{
"id": "EHR.contributions",
"path": "EHR.contributions",
"short": "List of contributions causing changes to this EHR.",
"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`. ",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-status",
"path": "EHR.ehr_status",
"short": "Reference to `EHR_STATUS` object for this EHR.",
"definition": "Reference to `EHR_STATUS` object for this EHR.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.ehr-access",
"path": "EHR.ehr_access",
"short": "Reference to `EHR_ACCESS` object for this EHR.",
"definition": "Reference to `EHR_ACCESS` object for this EHR.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.compositions",
"path": "EHR.compositions",
"short": "Master list of all Versioned Composition references in this EHR.",
"definition": "Master list of all Versioned Composition references in this EHR.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.directory",
"path": "EHR.directory",
"short": "Optional directory structure for this EHR.",
"definition": "Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.time-created",
"path": "EHR.time_created",
"short": "Time of creation of the EHR.",
"definition": "Time of creation of the EHR.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "EHR.folders",
"path": "EHR.folders",
"short": "Optional additional Folder structures for this EHR.",
"definition": "Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "EHR.tags",
"path": "EHR.tags",
"short": "Optional list of tags associated with this EHR.",
"definition": "Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
}
]
}
}