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/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions

Logical Model: ISM_TRANSITION - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the ISM-TRANSITION logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. ISM_TRANSITION
Definition

Model of a transition in the Instruction State Machine, caused by a careflow step. The attributes document the careflow step as well as the ISM transition.


Base definition for all types defined in FHIR type system.

ShortModel of a transition in the Instruction State Machine, caused by a careflow stepBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ISM_TRANSITION.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.

ShortRuntime name of this fragment, used to build runtime paths
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. ISM_TRANSITION.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.

ShortDesign-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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ISM_TRANSITION.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. ISM_TRANSITION.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.

ShortLinks to other archetyped structures
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. ISM_TRANSITION.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. ISM_TRANSITION.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.

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. ISM_TRANSITION.current-state
Definition

The ISM current state. Coded by openEHR terminology group Instruction states.

ShortThe ISM current state. Coded by openEHR terminology group Instruction states
Control1..1
BindingThe codes SHALL be taken from Instruction States
(required to https://specifications.openehr.org/fhir/valueset-instruction_states)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. ISM_TRANSITION.transition
Definition

The ISM transition which occurred to arrive in the current_state. Coded by openEHR terminology group Instruction transitions.

ShortThe ISM transition which occurred to arrive in the current_state
Control0..1
BindingThe codes SHALL be taken from Instruction Transitions
(required to https://specifications.openehr.org/fhir/valueset-instruction_transitions)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
18. ISM_TRANSITION.careflow-step
Definition

The step in the careflow process which occurred as part of generating this action, e.g. dispense , start_administration. This attribute represents the clinical label for the activity, as opposed to current_state which represents the state machine (ISM) computable form. Defined in archetype.

ShortThe step in the careflow process which occurred as part of generating this action
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
20. ISM_TRANSITION.reason
Definition

Optional possibility of adding one or more reasons for this careflow step having been taken. Multiple reasons may occur in medication management for example.

ShortOptional possibility of adding one or more reasons for this careflow step having been taken
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. ISM_TRANSITION
Definition

Model of a transition in the Instruction State Machine, caused by a careflow step. The attributes document the careflow step as well as the ISM transition.

ShortModel of a transition in the Instruction State Machine, caused by a careflow step
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ISM_TRANSITION.current-state
Definition

The ISM current state. Coded by openEHR terminology group Instruction states.

ShortThe ISM current state. Coded by openEHR terminology group Instruction states
Control1..1
BindingThe codes SHALL be taken from Instruction States
(required to https://specifications.openehr.org/fhir/valueset-instruction_states)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
4. ISM_TRANSITION.transition
Definition

The ISM transition which occurred to arrive in the current_state. Coded by openEHR terminology group Instruction transitions.

ShortThe ISM transition which occurred to arrive in the current_state
Control0..1
BindingThe codes SHALL be taken from Instruction Transitions
(required to https://specifications.openehr.org/fhir/valueset-instruction_transitions)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
6. ISM_TRANSITION.careflow-step
Definition

The step in the careflow process which occurred as part of generating this action, e.g. dispense , start_administration. This attribute represents the clinical label for the activity, as opposed to current_state which represents the state machine (ISM) computable form. Defined in archetype.

ShortThe step in the careflow process which occurred as part of generating this action
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. ISM_TRANSITION.reason
Definition

Optional possibility of adding one or more reasons for this careflow step having been taken. Multiple reasons may occur in medication management for example.

ShortOptional possibility of adding one or more reasons for this careflow step having been taken
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. ISM_TRANSITION
Definition

Model of a transition in the Instruction State Machine, caused by a careflow step. The attributes document the careflow step as well as the ISM transition.

ShortModel of a transition in the Instruction State Machine, caused by a careflow step
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ISM_TRANSITION.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.

ShortRuntime name of this fragment, used to build runtime paths
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. ISM_TRANSITION.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.

ShortDesign-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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ISM_TRANSITION.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. ISM_TRANSITION.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.

ShortLinks to other archetyped structures
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. ISM_TRANSITION.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. ISM_TRANSITION.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.

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. ISM_TRANSITION.current-state
Definition

The ISM current state. Coded by openEHR terminology group Instruction states.

ShortThe ISM current state. Coded by openEHR terminology group Instruction states
Control1..1
BindingThe codes SHALL be taken from Instruction States
(required to https://specifications.openehr.org/fhir/valueset-instruction_states)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. ISM_TRANSITION.transition
Definition

The ISM transition which occurred to arrive in the current_state. Coded by openEHR terminology group Instruction transitions.

ShortThe ISM transition which occurred to arrive in the current_state
Control0..1
BindingThe codes SHALL be taken from Instruction Transitions
(required to https://specifications.openehr.org/fhir/valueset-instruction_transitions)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
18. ISM_TRANSITION.careflow-step
Definition

The step in the careflow process which occurred as part of generating this action, e.g. dispense , start_administration. This attribute represents the clinical label for the activity, as opposed to current_state which represents the state machine (ISM) computable form. Defined in archetype.

ShortThe step in the careflow process which occurred as part of generating this action
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
20. ISM_TRANSITION.reason
Definition

Optional possibility of adding one or more reasons for this careflow step having been taken. Multiple reasons may occur in medication management for example.

ShortOptional possibility of adding one or more reasons for this careflow step having been taken
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse