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
| Page standards status: Informative | Maturity Level: 3 |
Definitions for the EXTRACT-CONTENT-ITEM logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT_CONTENT_ITEM | |
| Definition | Abstract model of a wrapper for one content item in an Extract, containing various meta-data. Indicates whether it was part of the primary set and what its original path was. Intended to be subtyped for wrappers of specific types of content. Base definition for all types defined in FHIR type system. |
| Short | Abstract model of a wrapper for one content item in an Extract, containing various meta-data.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())Item_validity: Item validity must be present ( is_masked xor item.exists()) |
| 2. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.is-primary | |
| Definition | True if the content item carried in this container was part of the primary set for the Extract, i.e. not added due to link-following. |
| Short | True if the content item carried in this container was part of the primary set for the Extract, i. |
| Control | 1..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EXTRACT_CONTENT_ITEM.is-changed | |
| Definition | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Short | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. EXTRACT_CONTENT_ITEM.is-masked | |
| Definition | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Short | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. EXTRACT_CONTENT_ITEM.item | |
| Definition | Content object. |
| Short | Content object. |
| Control | 0..1 |
| Type | Base |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT_CONTENT_ITEM | |
| Definition | Abstract model of a wrapper for one content item in an Extract, containing various meta-data. Indicates whether it was part of the primary set and what its original path was. Intended to be subtyped for wrappers of specific types of content. |
| Short | Abstract model of a wrapper for one content item in an Extract, containing various meta-data. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Item_validity: Item validity must be present (is_masked xor item.exists()) |
| 2. EXTRACT_CONTENT_ITEM.is-primary | |
| Definition | True if the content item carried in this container was part of the primary set for the Extract, i.e. not added due to link-following. |
| Short | True if the content item carried in this container was part of the primary set for the Extract, i. |
| Control | 1..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. EXTRACT_CONTENT_ITEM.is-changed | |
| Definition | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Short | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. EXTRACT_CONTENT_ITEM.is-masked | |
| Definition | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Short | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. EXTRACT_CONTENT_ITEM.item | |
| Definition | Content object. |
| Short | Content object. |
| Control | 0..1 |
| Type | Base |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT_CONTENT_ITEM | |
| Definition | Abstract model of a wrapper for one content item in an Extract, containing various meta-data. Indicates whether it was part of the primary set and what its original path was. Intended to be subtyped for wrappers of specific types of content. |
| Short | Abstract model of a wrapper for one content item in an Extract, containing various meta-data. |
| 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())Item_validity: Item validity must be present ( is_masked xor item.exists()) |
| 2. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.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. EXTRACT_CONTENT_ITEM.is-primary | |
| Definition | True if the content item carried in this container was part of the primary set for the Extract, i.e. not added due to link-following. |
| Short | True if the content item carried in this container was part of the primary set for the Extract, i. |
| Control | 1..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EXTRACT_CONTENT_ITEM.is-changed | |
| Definition | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Short | True if the content item carried in this container is any kind of change since last send, in repeat sending situations. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. EXTRACT_CONTENT_ITEM.is-masked | |
| Definition | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Short | True if the content of this item has not been included due to insufficient access rights of requestor. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. EXTRACT_CONTENT_ITEM.item | |
| Definition | Content object. |
| Short | Content object. |
| Control | 0..1 |
| Type | Base |
| Is Modifier | false |