FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EHR-STATUS.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-EHR-STATUS.html |
| URL | http://openehr.org/fhir/StructureDefinition/EHR-STATUS |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | EHR_STATUS |
| Title | EHR_STATUS |
| Realm | uv |
| Authority | hl7 |
| Description | Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole. NOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_STATUS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. + For example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_STATUS` object. |
| Type | http://openehr.org/fhir/StructureDefinition/EHR_STATUS |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | ITEM-STRUCTURE | ITEM_STRUCTURE |
| openehr.base#0.1.0-snapshot | LOCATABLE | LOCATABLE |
| openehr.base#0.1.0-snapshot | PARTY-SELF | PARTY_SELF |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EHR-STATUS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EHR_STATUS | C | 0..* | LOCATABLE | Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Is_archetype_root |
  subject | 1..1 | PARTY_SELF | The subject of this EHR. | |
 is_queryable | 1..1 | boolean | True if this EHR should be included in population queries, i. | |
| is_modifiable | 1..1 | boolean | True if the EHR, other than the `EHR_STATUS` object, is allowed to be written to. | |
 other_details | 0..1 | ITEM_STRUCTURE | Any other details of the EHR summary object, in the form of an archetyped `ITEM_STRUCTURE`. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "EHR-STATUS",
"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_status_class"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#concept"
},
{
"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-STATUS",
"version": "0.1.0-snapshot",
"name": "EHR_STATUS",
"title": "EHR_STATUS",
"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": "Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_STATUS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_STATUS` object.",
"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_STATUS",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "EHR_STATUS",
"path": "EHR_STATUS",
"short": "Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc.",
"definition": "Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_STATUS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_STATUS` object.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "Links_valid",
"severity": "error",
"human": "Links valid must be present",
"expression": "links.exists() implies links.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetyped_valid",
"severity": "error",
"human": "Archetyped valid must satisfy exclusive conditions",
"expression": "is_archetype_root() xor archetype_details .empty()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetype_node_id_valid",
"severity": "error",
"human": "Archetype node id valid must not be empty",
"expression": "archetype_node_id.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Is_archetype_root",
"severity": "error",
"human": "Is archetype root",
"expression": "is_archetype_root()"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EHR_STATUS.name",
"path": "EHR_STATUS.name",
"short": "Runtime name of this fragment, used to build runtime paths.",
"definition": "Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.archetype-node-id",
"path": "EHR_STATUS.archetype_node_id",
"short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
"definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_node_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.uid",
"path": "EHR_STATUS.uid",
"short": "Optional globally unique object identifier for root points of archetyped structures.",
"definition": "Optional globally unique object identifier for root points of archetyped structures.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.uid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.links",
"path": "EHR_STATUS.links",
"short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
"definition": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions.",
"min": 0,
"max": "*",
"base": {
"path": "LOCATABLE.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.archetype-details",
"path": "EHR_STATUS.archetype_details",
"short": "Details of archetyping used on this node.",
"definition": "Details of archetyping used on this node.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.feeder-audit",
"path": "EHR_STATUS.feeder_audit",
"short": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.feeder_audit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.subject",
"path": "EHR_STATUS.subject",
"short": "The subject of this EHR.",
"definition": "The subject of this EHR. The `_external_ref_` attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons.",
"min": 1,
"max": "1",
"base": {
"path": "EHR_STATUS.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-SELF"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.is-queryable",
"path": "EHR_STATUS.is_queryable",
"short": "True if this EHR should be included in population queries, i.",
"definition": "True if this EHR should be included in population queries, i.e. if this EHR is considered active in the population.",
"min": 1,
"max": "1",
"base": {
"path": "EHR_STATUS.is_queryable",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.is-modifiable",
"path": "EHR_STATUS.is_modifiable",
"short": "True if the EHR, other than the `EHR_STATUS` object, is allowed to be written to.",
"definition": "True if the EHR, other than the `EHR_STATUS` object, is allowed to be written to. The `EHR_STATUS` object itself can always be written to.",
"min": 1,
"max": "1",
"base": {
"path": "EHR_STATUS.is_modifiable",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.other-details",
"path": "EHR_STATUS.other_details",
"short": "Any other details of the EHR summary object, in the form of an archetyped `ITEM_STRUCTURE`.",
"definition": "Any other details of the EHR summary object, in the form of an archetyped `ITEM_STRUCTURE`.",
"min": 0,
"max": "1",
"base": {
"path": "EHR_STATUS.other_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "EHR_STATUS",
"path": "EHR_STATUS",
"short": "Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc.",
"definition": "Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_STATUS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_STATUS` object.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Is_archetype_root",
"severity": "error",
"human": "Is archetype root",
"expression": "is_archetype_root()"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.subject",
"path": "EHR_STATUS.subject",
"short": "The subject of this EHR.",
"definition": "The subject of this EHR. The `_external_ref_` attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons. ",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-SELF"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.is-queryable",
"path": "EHR_STATUS.is_queryable",
"short": "True if this EHR should be included in population queries, i.",
"definition": "True if this EHR should be included in population queries, i.e. if this EHR is considered active in the population.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.is-modifiable",
"path": "EHR_STATUS.is_modifiable",
"short": "True if the EHR, other than the `EHR_STATUS` object, is allowed to be written to.",
"definition": "True if the EHR, other than the `EHR_STATUS` object, is allowed to be written to. The `EHR_STATUS` object itself can always be written to.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EHR_STATUS.other-details",
"path": "EHR_STATUS.other_details",
"short": "Any other details of the EHR summary object, in the form of an archetyped `ITEM_STRUCTURE`.",
"definition": "Any other details of the EHR summary object, in the form of an archetyped `ITEM_STRUCTURE`.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"isModifier": false
}
]
}
}