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 ACTION logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. ACTION | |
Definition | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another. Base definition for all types defined in FHIR type system. |
Short | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow.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() ) |
2. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.time | |
Definition | Point in time at which this action completed. To indicate an unknown time, use a |
Short | Point in time at which this action completed. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
32. ACTION.ism-transition | |
Definition | Details of transition in the Instruction state machine caused by this Action. |
Short | Details of transition in the Instruction state machine caused by this Action. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ISM-TRANSITION |
Is Modifier | false |
34. ACTION.instruction-details | |
Definition | Details of the Instruction that caused this Action to be performed, if there was one. |
Short | Details of the Instruction that caused this Action to be performed, if there was one. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/INSTRUCTION-DETAILS |
Is Modifier | false |
36. ACTION.description | |
Definition | Description of the action that has been performed, in the form of an archetyped structure. |
Short | Description of the action that has been performed, in the form of an archetyped structure. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. ACTION | |
Definition | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another. |
Short | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. ACTION.time | |
Definition | Point in time at which this action completed. To indicate an unknown time, use a |
Short | Point in time at which this action completed. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
4. ACTION.ism-transition | |
Definition | Details of transition in the Instruction state machine caused by this Action. |
Short | Details of transition in the Instruction state machine caused by this Action. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ISM-TRANSITION |
Is Modifier | false |
6. ACTION.instruction-details | |
Definition | Details of the Instruction that caused this Action to be performed, if there was one. |
Short | Details of the Instruction that caused this Action to be performed, if there was one. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/INSTRUCTION-DETAILS |
Is Modifier | false |
8. ACTION.description | |
Definition | Description of the action that has been performed, in the form of an archetyped structure. |
Short | Description of the action that has been performed, in the form of an archetyped structure. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. ACTION | |
Definition | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another. |
Short | Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. |
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() ) |
2. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.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. ACTION.time | |
Definition | Point in time at which this action completed. To indicate an unknown time, use a |
Short | Point in time at which this action completed. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME |
Is Modifier | false |
32. ACTION.ism-transition | |
Definition | Details of transition in the Instruction state machine caused by this Action. |
Short | Details of transition in the Instruction state machine caused by this Action. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ISM-TRANSITION |
Is Modifier | false |
34. ACTION.instruction-details | |
Definition | Details of the Instruction that caused this Action to be performed, if there was one. |
Short | Details of the Instruction that caused this Action to be performed, if there was one. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/INSTRUCTION-DETAILS |
Is Modifier | false |
36. ACTION.description | |
Definition | Description of the action that has been performed, in the form of an archetyped structure. |
Short | Description of the action that has been performed, in the form of an archetyped structure. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |