OpenEHR Base package
0.1.0 - First Draft International flag

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

Logical Model: INSTRUCTION

Official URL: http://openehr.org/fhir/StructureDefinition/INSTRUCTION Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: INSTRUCTION

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.

Original Source: specifications.openehr.org

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Subject_validity, Other_participations_valid, Is_archetype_root, Activities_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... language 1..1 CODE_PHRASE Mandatory indicator of the localised language in which this Entry is written.
... encoding 1..1 CODE_PHRASE Name of character set in which text values in this Entry are encoded.
... other_participations 0..* PARTICIPATION Other participations at `ENTRY` level.
... workflow_id 0..1 OBJECT_REF Identifier of externally held workflow engine data for this workflow execution, for this subject of care.
... subject 1..1 PARTY_PROXY Id of human subject of this `ENTRY`, e.
... provider 0..1 PARTY_PROXY Optional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
... protocol 0..1 ITEM_STRUCTURE Description of the method (i.
... guideline_id 0..1 OBJECT_REF Optional external identifier of guideline creating this Entry if relevant.
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.
... activities 0..* ACTIVITY List of all activities in Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()
Archetype_node_id_valid error INSTRUCTION Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error INSTRUCTION Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Is_archetype_root error INSTRUCTION Is archetype root is_archetype_root()
Links_valid error INSTRUCTION Links valid must be present links.exists() implies links.empty().not()
Other_participations_valid error INSTRUCTION Other participations valid must be present other_participations.exists() implies other_participations.empty().not()
Subject_validity error INSTRUCTION Subject validity must satisfy conditional constraints subject_is_self() implies subject.generating_type = “PARTY_SELF”

This structure is derived from CARE_ENTRY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Activities_valid
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Subject_validity, Other_participations_valid, Is_archetype_root, Activities_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... language 1..1 CODE_PHRASE Mandatory indicator of the localised language in which this Entry is written.
... encoding 1..1 CODE_PHRASE Name of character set in which text values in this Entry are encoded.
... other_participations 0..* PARTICIPATION Other participations at `ENTRY` level.
... workflow_id 0..1 OBJECT_REF Identifier of externally held workflow engine data for this workflow execution, for this subject of care.
... subject 1..1 PARTY_PROXY Id of human subject of this `ENTRY`, e.
... provider 0..1 PARTY_PROXY Optional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
... protocol 0..1 ITEM_STRUCTURE Description of the method (i.
... guideline_id 0..1 OBJECT_REF Optional external identifier of guideline creating this Entry if relevant.
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.
... activities 0..* ACTIVITY List of all activities in Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()
Archetype_node_id_valid error INSTRUCTION Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error INSTRUCTION Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Is_archetype_root error INSTRUCTION Is archetype root is_archetype_root()
Links_valid error INSTRUCTION Links valid must be present links.exists() implies links.empty().not()
Other_participations_valid error INSTRUCTION Other participations valid must be present other_participations.exists() implies other_participations.empty().not()
Subject_validity error INSTRUCTION Subject validity must satisfy conditional constraints subject_is_self() implies subject.generating_type = “PARTY_SELF”

This structure is derived from CARE_ENTRY

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Subject_validity, Other_participations_valid, Is_archetype_root, Activities_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... language 1..1 CODE_PHRASE Mandatory indicator of the localised language in which this Entry is written.
... encoding 1..1 CODE_PHRASE Name of character set in which text values in this Entry are encoded.
... other_participations 0..* PARTICIPATION Other participations at `ENTRY` level.
... workflow_id 0..1 OBJECT_REF Identifier of externally held workflow engine data for this workflow execution, for this subject of care.
... subject 1..1 PARTY_PROXY Id of human subject of this `ENTRY`, e.
... provider 0..1 PARTY_PROXY Optional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
... protocol 0..1 ITEM_STRUCTURE Description of the method (i.
... guideline_id 0..1 OBJECT_REF Optional external identifier of guideline creating this Entry if relevant.
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.
... activities 0..* ACTIVITY List of all activities in Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()
Archetype_node_id_valid error INSTRUCTION Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error INSTRUCTION Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Is_archetype_root error INSTRUCTION Is archetype root is_archetype_root()
Links_valid error INSTRUCTION Links valid must be present links.exists() implies links.empty().not()
Other_participations_valid error INSTRUCTION Other participations valid must be present other_participations.exists() implies other_participations.empty().not()
Subject_validity error INSTRUCTION Subject validity must satisfy conditional constraints subject_is_self() implies subject.generating_type = “PARTY_SELF”

Differential View

This structure is derived from CARE_ENTRY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Activities_valid
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. INSTRUCTION C 0..* CARE_ENTRY Used to specify actions in the future.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Subject_validity, Other_participations_valid, Is_archetype_root, Activities_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... language 1..1 CODE_PHRASE Mandatory indicator of the localised language in which this Entry is written.
... encoding 1..1 CODE_PHRASE Name of character set in which text values in this Entry are encoded.
... other_participations 0..* PARTICIPATION Other participations at `ENTRY` level.
... workflow_id 0..1 OBJECT_REF Identifier of externally held workflow engine data for this workflow execution, for this subject of care.
... subject 1..1 PARTY_PROXY Id of human subject of this `ENTRY`, e.
... provider 0..1 PARTY_PROXY Optional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
... protocol 0..1 ITEM_STRUCTURE Description of the method (i.
... guideline_id 0..1 OBJECT_REF Optional external identifier of guideline creating this Entry if relevant.
... narrative 1..1 DV_TEXT Mandatory human-readable version of what the Instruction is about.
... expiry_time 0..1 DV_DATE_TIME Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
... wf_definition 0..1 DV_PARSABLE Optional workflow engine executable expression of the Instruction.
... activities 0..* ACTIVITY List of all activities in Instruction.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Activities_valid error INSTRUCTION Activities valid must be present activities.exists() implies activities.empty().not()
Archetype_node_id_valid error INSTRUCTION Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error INSTRUCTION Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Is_archetype_root error INSTRUCTION Is archetype root is_archetype_root()
Links_valid error INSTRUCTION Links valid must be present links.exists() implies links.empty().not()
Other_participations_valid error INSTRUCTION Other participations valid must be present other_participations.exists() implies other_participations.empty().not()
Subject_validity error INSTRUCTION Subject validity must satisfy conditional constraints subject_is_self() implies subject.generating_type = “PARTY_SELF”

This structure is derived from CARE_ENTRY

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

 

Other representations of profile: CSV, Excel