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
| Page standards status: Informative | Maturity Level: 3 |
Definitions for the ELEMENT logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ELEMENT | |
| Definition | The leaf variant of Base definition for all types defined in FHIR type system. |
| Short | The leaf variant of `ITEM`, to which a `DATA_VALUE` instance is attached.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 | Links_valid: Links valid must be present (links.exists() implies links.empty().not())Archetyped_valid: Archetyped valid must satisfy exclusive conditions ( is_archetype_root() xor archetype_details .empty())Archetype_node_id_valid: Archetype node id valid must not be empty ( archetype_node_id.empty().not())Inv_is_null_valid: Inv is null valid ( is_null() = (value .empty()))Inv_null_flavour_indicated: Inv null flavour indicated must satisfy exclusive conditions ( is_null() xor null_flavour .empty())Inv_null_flavour_valid: Inv null flavour valid must satisfy conditional constraints ( is_null() implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code))Inv_null_reason_valid: Inv null reason valid must be present ( null_reason.exists() implies is_null()) |
| 2. ELEMENT.name | |
| 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. |
| Short | Runtime name of this fragment, used to build runtime paths. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
| Is Modifier | false |
| 4. ELEMENT.archetype-node-id | |
| 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. At an archetype root point, the value of this attribute is always the stringified form of the |
| Short | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. ELEMENT.uid | |
| Definition | Optional globally unique object identifier for root points of archetyped structures. |
| Short | Optional globally unique object identifier for root points of archetyped structures. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/UID-BASED-ID |
| Is Modifier | false |
| 8. ELEMENT.links | |
| Definition | Links to other archetyped structures (data whose root object inherits from |
| Short | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/LINK |
| Is Modifier | false |
| 10. ELEMENT.archetype-details | |
| Definition | Details of archetyping used on this node. |
| Short | Details of archetyping used on this node. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/ARCHETYPED |
| Is Modifier | false |
| 12. ELEMENT.feeder-audit | |
| 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. |
| 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. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
| Is Modifier | false |
| 14. ELEMENT.null-flavour | |
| Definition | Flavour of null value, e.g. |
| Short | Flavour of null value, e. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
| Is Modifier | false |
| 16. ELEMENT.value | |
| Definition | Property representing leaf value object of |
| Short | Property representing leaf value object of `ELEMENT`. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DATA-VALUE |
| Is Modifier | false |
| 18. ELEMENT.null-reason | |
| Definition | Optional specific reason for null value; if set, |
| Short | Optional specific reason for null value; if set, `_null_flavour_` must be set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ELEMENT | |
| Definition | The leaf variant of |
| Short | The leaf variant of `ITEM`, to which a `DATA_VALUE` instance is attached. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Inv_is_null_valid: Inv is null valid (is_null() = (value .empty()))Inv_null_flavour_indicated: Inv null flavour indicated must satisfy exclusive conditions ( is_null() xor null_flavour .empty())Inv_null_flavour_valid: Inv null flavour valid must satisfy conditional constraints ( is_null() implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code))Inv_null_reason_valid: Inv null reason valid must be present ( null_reason.exists() implies is_null()) |
| 2. ELEMENT.null-flavour | |
| Definition | Flavour of null value, e.g. |
| Short | Flavour of null value, e. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
| Is Modifier | false |
| 4. ELEMENT.value | |
| Definition | Property representing leaf value object of |
| Short | Property representing leaf value object of `ELEMENT`. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DATA-VALUE |
| Is Modifier | false |
| 6. ELEMENT.null-reason | |
| Definition | Optional specific reason for null value; if set, |
| Short | Optional specific reason for null value; if set, `_null_flavour_` must be set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ELEMENT | |
| Definition | The leaf variant of |
| Short | The leaf variant of `ITEM`, to which a `DATA_VALUE` instance is attached. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Links_valid: Links valid must be present (links.exists() implies links.empty().not())Archetyped_valid: Archetyped valid must satisfy exclusive conditions ( is_archetype_root() xor archetype_details .empty())Archetype_node_id_valid: Archetype node id valid must not be empty ( archetype_node_id.empty().not())Inv_is_null_valid: Inv is null valid ( is_null() = (value .empty()))Inv_null_flavour_indicated: Inv null flavour indicated must satisfy exclusive conditions ( is_null() xor null_flavour .empty())Inv_null_flavour_valid: Inv null flavour valid must satisfy conditional constraints ( is_null() implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code))Inv_null_reason_valid: Inv null reason valid must be present ( null_reason.exists() implies is_null()) |
| 2. ELEMENT.name | |
| 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. |
| Short | Runtime name of this fragment, used to build runtime paths. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
| Is Modifier | false |
| 4. ELEMENT.archetype-node-id | |
| 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. At an archetype root point, the value of this attribute is always the stringified form of the |
| Short | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. ELEMENT.uid | |
| Definition | Optional globally unique object identifier for root points of archetyped structures. |
| Short | Optional globally unique object identifier for root points of archetyped structures. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/UID-BASED-ID |
| Is Modifier | false |
| 8. ELEMENT.links | |
| Definition | Links to other archetyped structures (data whose root object inherits from |
| Short | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/LINK |
| Is Modifier | false |
| 10. ELEMENT.archetype-details | |
| Definition | Details of archetyping used on this node. |
| Short | Details of archetyping used on this node. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/ARCHETYPED |
| Is Modifier | false |
| 12. ELEMENT.feeder-audit | |
| 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. |
| 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. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
| Is Modifier | false |
| 14. ELEMENT.null-flavour | |
| Definition | Flavour of null value, e.g. |
| Short | Flavour of null value, e. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
| Is Modifier | false |
| 16. ELEMENT.value | |
| Definition | Property representing leaf value object of |
| Short | Property representing leaf value object of `ELEMENT`. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DATA-VALUE |
| Is Modifier | false |
| 18. ELEMENT.null-reason | |
| Definition | Optional specific reason for null value; if set, |
| Short | Optional specific reason for null value; if set, `_null_flavour_` must be set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
| Is Modifier | false |