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/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 3 |
Definitions for the ENTRY logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ENTRY | |
| Definition | The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition. Base definition for all types defined in FHIR type system. |
| Short | The abstract parent of all ENTRY subtypesBase for all types and resources |
| Comments | An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ENTRY.name | |
| Definition | 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. ENTRY.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. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. |
| Short | Design-time archetype identifier of this node taken from its generating archetype |
| Comments | At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. ENTRY.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. ENTRY.links | |
| 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. |
| Short | Links to other archetyped structures |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/LINK |
| Is Modifier | false |
| 10. ENTRY.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. ENTRY.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 |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
| Is Modifier | false |
| 14. ENTRY.language | |
| Definition | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages. |
| Short | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages |
| Control | 1..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 16. ENTRY.encoding | |
| Definition | Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets. |
| Short | Name of character set in which text values in this Entry are encoded |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 18. ENTRY.other-participations | |
| Definition | Other participations at ENTRY level. |
| Short | Other participations at ENTRY level |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/PARTICIPATION |
| Is Modifier | false |
| 20. ENTRY.workflow-id | |
| Definition | Identifier of externally held workflow engine data for this workflow execution, for this subject of care. |
| Short | Identifier of externally held workflow engine data for this workflow execution, for this subject of care |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/OBJECT-REF |
| Is Modifier | false |
| 22. ENTRY.subject | |
| Definition | Id of human subject of this ENTRY, e.g.:
|
| Short | Id of human subject of this ENTRY, e.g. organ donor, foetus, a family member, or another clinically relevant person |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |
| 24. ENTRY.provider | |
| Definition | Optional identification of provider of the information in this ENTRY, which might be:
Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed. |
| Short | Optional identification of provider of the information in this ENTRY, which might be the patient, a patient agent, the clinician, a device |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ENTRY | |
| Definition | The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition. |
| Short | The abstract parent of all ENTRY subtypes |
| Comments | An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ENTRY.language | |
| Definition | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages. |
| Short | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages |
| Control | 1..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 4. ENTRY.encoding | |
| Definition | Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets. |
| Short | Name of character set in which text values in this Entry are encoded |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 6. ENTRY.other-participations | |
| Definition | Other participations at ENTRY level. |
| Short | Other participations at ENTRY level |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/PARTICIPATION |
| Is Modifier | false |
| 8. ENTRY.workflow-id | |
| Definition | Identifier of externally held workflow engine data for this workflow execution, for this subject of care. |
| Short | Identifier of externally held workflow engine data for this workflow execution, for this subject of care |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/OBJECT-REF |
| Is Modifier | false |
| 10. ENTRY.subject | |
| Definition | Id of human subject of this ENTRY, e.g.:
|
| Short | Id of human subject of this ENTRY, e.g. organ donor, foetus, a family member, or another clinically relevant person |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |
| 12. ENTRY.provider | |
| Definition | Optional identification of provider of the information in this ENTRY, which might be:
Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed. |
| Short | Optional identification of provider of the information in this ENTRY, which might be the patient, a patient agent, the clinician, a device |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ENTRY | |
| Definition | The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition. |
| Short | The abstract parent of all ENTRY subtypes |
| Comments | An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ENTRY.name | |
| Definition | 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. ENTRY.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. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. |
| Short | Design-time archetype identifier of this node taken from its generating archetype |
| Comments | At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. ENTRY.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. ENTRY.links | |
| 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. |
| Short | Links to other archetyped structures |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/LINK |
| Is Modifier | false |
| 10. ENTRY.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. ENTRY.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 |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
| Is Modifier | false |
| 14. ENTRY.language | |
| Definition | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages. |
| Short | Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages |
| Control | 1..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 16. ENTRY.encoding | |
| Definition | Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets. |
| Short | Name of character set in which text values in this Entry are encoded |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets) |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 18. ENTRY.other-participations | |
| Definition | Other participations at ENTRY level. |
| Short | Other participations at ENTRY level |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/PARTICIPATION |
| Is Modifier | false |
| 20. ENTRY.workflow-id | |
| Definition | Identifier of externally held workflow engine data for this workflow execution, for this subject of care. |
| Short | Identifier of externally held workflow engine data for this workflow execution, for this subject of care |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/OBJECT-REF |
| Is Modifier | false |
| 22. ENTRY.subject | |
| Definition | Id of human subject of this ENTRY, e.g.:
|
| Short | Id of human subject of this ENTRY, e.g. organ donor, foetus, a family member, or another clinically relevant person |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |
| 24. ENTRY.provider | |
| Definition | Optional identification of provider of the information in this ENTRY, which might be:
Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed. |
| Short | Optional identification of provider of the information in this ENTRY, which might be the patient, a patient agent, the clinician, a device |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
| Is Modifier | false |