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 logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT | |
| Definition | Generic model of an Extract of some information from a repository. Base definition for all types defined in FHIR type system. |
| Short | Generic model of an Extract of some information from a repository.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())Sequence_nr_valid: Sequence nr valid must satisfy range constraints ( null # TODO: manual translation needed) |
| 2. EXTRACT.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.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.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.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.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.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.chapters | |
| Definition | The content extracted and serialised from the source repository for this Extract. |
| Short | The content extracted and serialised from the source repository for this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-CHAPTER |
| Is Modifier | false |
| 16. EXTRACT.specification | |
| Definition | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Short | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-SPEC |
| Is Modifier | false |
| 18. EXTRACT.request-id | |
| Definition | Reference to causing Request, if any. |
| Short | Reference to causing Request, if any. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 20. EXTRACT.time-created | |
| Definition | Creation time of this Extract |
| Short | Creation time of this Extract |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
| Is Modifier | false |
| 22. EXTRACT.system-id | |
| Definition | Identifier of creating system. |
| Short | Identifier of creating system. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 24. EXTRACT.sequence-nr | |
| Definition | Number of this Extract response in sequence of responses to Extract request identified by |
| Short | Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EXTRACT.participations | |
| Definition | Participations relevant to the creation of this Extract. |
| Short | Participations relevant to the creation of this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-PARTICIPATION |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT | |
| Definition | Generic model of an Extract of some information from a repository. |
| Short | Generic model of an Extract of some information from a repository. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Sequence_nr_valid: Sequence nr valid must satisfy range constraints (null # TODO: manual translation needed) |
| 2. EXTRACT.chapters | |
| Definition | The content extracted and serialised from the source repository for this Extract. |
| Short | The content extracted and serialised from the source repository for this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-CHAPTER |
| Is Modifier | false |
| 4. EXTRACT.specification | |
| Definition | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Short | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-SPEC |
| Is Modifier | false |
| 6. EXTRACT.request-id | |
| Definition | Reference to causing Request, if any. |
| Short | Reference to causing Request, if any. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 8. EXTRACT.time-created | |
| Definition | Creation time of this Extract |
| Short | Creation time of this Extract |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
| Is Modifier | false |
| 10. EXTRACT.system-id | |
| Definition | Identifier of creating system. |
| Short | Identifier of creating system. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 12. EXTRACT.sequence-nr | |
| Definition | Number of this Extract response in sequence of responses to Extract request identified by |
| Short | Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EXTRACT.participations | |
| Definition | Participations relevant to the creation of this Extract. |
| Short | Participations relevant to the creation of this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-PARTICIPATION |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EXTRACT | |
| Definition | Generic model of an Extract of some information from a repository. |
| Short | Generic model of an Extract of some information from a repository. |
| 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())Sequence_nr_valid: Sequence nr valid must satisfy range constraints ( null # TODO: manual translation needed) |
| 2. EXTRACT.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.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.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.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.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.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.chapters | |
| Definition | The content extracted and serialised from the source repository for this Extract. |
| Short | The content extracted and serialised from the source repository for this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-CHAPTER |
| Is Modifier | false |
| 16. EXTRACT.specification | |
| Definition | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Short | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-SPEC |
| Is Modifier | false |
| 18. EXTRACT.request-id | |
| Definition | Reference to causing Request, if any. |
| Short | Reference to causing Request, if any. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 20. EXTRACT.time-created | |
| Definition | Creation time of this Extract |
| Short | Creation time of this Extract |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
| Is Modifier | false |
| 22. EXTRACT.system-id | |
| Definition | Identifier of creating system. |
| Short | Identifier of creating system. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID |
| Is Modifier | false |
| 24. EXTRACT.sequence-nr | |
| Definition | Number of this Extract response in sequence of responses to Extract request identified by |
| Short | Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EXTRACT.participations | |
| Definition | Participations relevant to the creation of this Extract. |
| Short | Participations relevant to the creation of this Extract. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT-PARTICIPATION |
| Is Modifier | false |