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 INSTRUCTION logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. INSTRUCTION | |
Definition | Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms. Base definition for all types defined in FHIR type system. |
Short | Used to specify actions in the future.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() )Subject_validity: Subject validity must satisfy conditional constraints ( subject_is_self() implies subject.generating_type = “PARTY_SELF” )Other_participations_valid: Other participations valid must be present ( other_participations.exists() implies other_participations.empty().not() )Is_archetype_root: Is archetype root ( is_archetype_root() )Activities_valid: Activities valid must be present ( activities.exists() implies activities.empty().not() ) |
2. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
16. INSTRUCTION.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 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
18. INSTRUCTION.other-participations | |
Definition | Other participations at |
Short | Other participations at `ENTRY` level. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTICIPATION |
Is Modifier | false |
20. INSTRUCTION.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. INSTRUCTION.subject | |
Definition | Id of human subject of this
|
Short | Id of human subject of this `ENTRY`, e. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
24. INSTRUCTION.provider | |
Definition | Optional identification of provider of the information in this
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, e. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
26. INSTRUCTION.protocol | |
Definition | Description of the method (i.e. how) the information in this entry was arrived at. For |
Short | Description of the method (i. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
28. INSTRUCTION.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. INSTRUCTION.narrative | |
Definition | Mandatory human-readable version of what the Instruction is about. |
Short | Mandatory human-readable version of what the Instruction is about. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
Is Modifier | false |
32. INSTRUCTION.expiry-time | |
Definition | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other. |
Short | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
34. INSTRUCTION.wf-definition | |
Definition | Optional workflow engine executable expression of the Instruction. |
Short | Optional workflow engine executable expression of the Instruction. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-PARSABLE |
Is Modifier | false |
36. INSTRUCTION.activities | |
Definition | List of all activities in Instruction. |
Short | List of all activities in Instruction. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/ACTIVITY |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. INSTRUCTION | |
Definition | Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms. |
Short | Used to specify actions in the future. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | Activities_valid: Activities valid must be present (activities.exists() implies activities.empty().not() ) |
2. INSTRUCTION.narrative | |
Definition | Mandatory human-readable version of what the Instruction is about. |
Short | Mandatory human-readable version of what the Instruction is about. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
Is Modifier | false |
4. INSTRUCTION.expiry-time | |
Definition | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other. |
Short | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
6. INSTRUCTION.wf-definition | |
Definition | Optional workflow engine executable expression of the Instruction. |
Short | Optional workflow engine executable expression of the Instruction. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-PARSABLE |
Is Modifier | false |
8. INSTRUCTION.activities | |
Definition | List of all activities in Instruction. |
Short | List of all activities in Instruction. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/ACTIVITY |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. INSTRUCTION | |
Definition | Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms. |
Short | Used to specify actions in the future. |
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() )Subject_validity: Subject validity must satisfy conditional constraints ( subject_is_self() implies subject.generating_type = “PARTY_SELF” )Other_participations_valid: Other participations valid must be present ( other_participations.exists() implies other_participations.empty().not() )Is_archetype_root: Is archetype root ( is_archetype_root() )Activities_valid: Activities valid must be present ( activities.exists() implies activities.empty().not() ) |
2. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. INSTRUCTION.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. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
16. INSTRUCTION.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 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
18. INSTRUCTION.other-participations | |
Definition | Other participations at |
Short | Other participations at `ENTRY` level. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTICIPATION |
Is Modifier | false |
20. INSTRUCTION.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. INSTRUCTION.subject | |
Definition | Id of human subject of this
|
Short | Id of human subject of this `ENTRY`, e. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
24. INSTRUCTION.provider | |
Definition | Optional identification of provider of the information in this
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, e. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
26. INSTRUCTION.protocol | |
Definition | Description of the method (i.e. how) the information in this entry was arrived at. For |
Short | Description of the method (i. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
28. INSTRUCTION.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. INSTRUCTION.narrative | |
Definition | Mandatory human-readable version of what the Instruction is about. |
Short | Mandatory human-readable version of what the Instruction is about. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
Is Modifier | false |
32. INSTRUCTION.expiry-time | |
Definition | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other. |
Short | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
34. INSTRUCTION.wf-definition | |
Definition | Optional workflow engine executable expression of the Instruction. |
Short | Optional workflow engine executable expression of the Instruction. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-PARSABLE |
Is Modifier | false |
36. INSTRUCTION.activities | |
Definition | List of all activities in Instruction. |
Short | List of all activities in Instruction. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/ACTIVITY |
Is Modifier | false |