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 OBSERVATION logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. OBSERVATION | |
Definition | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred. OBSERVATION data is expressed using the class HISTORY<T>, which guarantees that it is situated in time. OBSERVATION is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported phenomena, e.g. pain. Base definition for all types defined in FHIR type system. |
Short | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurredBase for all types and resources |
Comments | Not to be used for recording opinion or future statements of any kind, including instructions, intentions, plans etc. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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 |
26. OBSERVATION.protocol | |
Definition | Description of the method (i.e. how) the information in this entry was arrived at. For OBSERVATIONs, this is a description of the method or instrument used. For EVALUATIONs, how the evaluation was arrived at. For INSTRUCTIONs, how to execute the Instruction. This may take the form of references to guidelines, including manually followed and executable; knowledge references such as a paper in Medline; clinical reasons within a larger care process. |
Short | Description of the method (i.e. how) the information in this entry was arrived at |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
28. OBSERVATION.guideline-id | |
Definition | Optional external identifier of guideline creating this Entry if relevant. |
Short | Optional external identifier of guideline creating this Entry if relevant |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/OBJECT-REF |
Is Modifier | false |
30. OBSERVATION.data | |
Definition | The data of this observation, in the form of a history of values which may be of any complexity. |
Short | The data of this observation, in the form of a history of values which may be of any complexity |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |
32. OBSERVATION.state | |
Definition | Optional recording of the state of subject of this observation during the observation process, in the form of a separate history of values which may be of any complexity. State may also be recorded within the History of the data attribute. |
Short | Optional recording of the state of subject of this observation during the observation process |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. OBSERVATION | |
Definition | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred. OBSERVATION data is expressed using the class HISTORY<T>, which guarantees that it is situated in time. OBSERVATION is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported phenomena, e.g. pain. |
Short | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred |
Comments | Not to be used for recording opinion or future statements of any kind, including instructions, intentions, plans etc. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. OBSERVATION.data | |
Definition | The data of this observation, in the form of a history of values which may be of any complexity. |
Short | The data of this observation, in the form of a history of values which may be of any complexity |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |
4. OBSERVATION.state | |
Definition | Optional recording of the state of subject of this observation during the observation process, in the form of a separate history of values which may be of any complexity. State may also be recorded within the History of the data attribute. |
Short | Optional recording of the state of subject of this observation during the observation process |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. OBSERVATION | |
Definition | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred. OBSERVATION data is expressed using the class HISTORY<T>, which guarantees that it is situated in time. OBSERVATION is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported phenomena, e.g. pain. |
Short | Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred |
Comments | Not to be used for recording opinion or future statements of any kind, including instructions, intentions, plans etc. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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. OBSERVATION.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 |
26. OBSERVATION.protocol | |
Definition | Description of the method (i.e. how) the information in this entry was arrived at. For OBSERVATIONs, this is a description of the method or instrument used. For EVALUATIONs, how the evaluation was arrived at. For INSTRUCTIONs, how to execute the Instruction. This may take the form of references to guidelines, including manually followed and executable; knowledge references such as a paper in Medline; clinical reasons within a larger care process. |
Short | Description of the method (i.e. how) the information in this entry was arrived at |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
28. OBSERVATION.guideline-id | |
Definition | Optional external identifier of guideline creating this Entry if relevant. |
Short | Optional external identifier of guideline creating this Entry if relevant |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/OBJECT-REF |
Is Modifier | false |
30. OBSERVATION.data | |
Definition | The data of this observation, in the form of a history of values which may be of any complexity. |
Short | The data of this observation, in the form of a history of values which may be of any complexity |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |
32. OBSERVATION.state | |
Definition | Optional recording of the state of subject of this observation during the observation process, in the form of a separate history of values which may be of any complexity. State may also be recorded within the History of the data attribute. |
Short | Optional recording of the state of subject of this observation during the observation process |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/HISTORY<http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
Is Modifier | false |