OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package
0.1.0 - First Draft
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
| Official URL: http://openehr.org/fhir/StructureDefinition/EHR-STATUS | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 3 | Computable Name: EHR_STATUS | ||
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.
Original Source: specifications.openehr.org
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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: Links_valid, Archetyped_valid, Archetype_node_id_valid, Is_archetype_root |
  name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
 archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | EHR_STATUS | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | EHR_STATUS | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
| Links_valid | error | EHR_STATUS | Links valid must be present |
links.exists() implies links.empty().not()
|
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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: Links_valid, Archetyped_valid, Archetype_node_id_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | EHR_STATUS | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | EHR_STATUS | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
| Links_valid | error | EHR_STATUS | Links valid must be present |
links.exists() implies links.empty().not()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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: Links_valid, Archetyped_valid, Archetype_node_id_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | EHR_STATUS | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | EHR_STATUS | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
| Links_valid | error | EHR_STATUS | Links valid must be present |
links.exists() implies links.empty().not()
|
Differential View
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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: Links_valid, Archetyped_valid, Archetype_node_id_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| 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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | EHR_STATUS | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | EHR_STATUS | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Is_archetype_root | error | EHR_STATUS | Is archetype root |
is_archetype_root()
|
| Links_valid | error | EHR_STATUS | Links valid must be present |
links.exists() implies links.empty().not()
|