openehr-rm 0.0.2

openEHR RM 1.2.0 Reference Model, generated from BMM
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

// @generated by openehr-codegen from BMM (`INSTRUCTION_DETAILS`) — DO NOT EDIT.
// Hand-written spec functions/invariants live in the sibling `*_impl.rs`.

//! The openEHR `INSTRUCTION_DETAILS` spec class, generated from the vendored BMM
//! meta-model.

use crate::data_structures::item_structure::item_structure::ItemStructure;
use openehr_base::prelude::LocatableRef;

/// Used to record details of the Instruction causing an Action.
#[doc(alias = "INSTRUCTION_DETAILS")]
#[derive(Debug, Clone, PartialEq)]
pub struct InstructionDetails {
    /// Reference to causing Instruction.
    pub instruction_id: LocatableRef,
    /// Identifier of Activity within Instruction, in the form of its archetype path.
    pub activity_id: String,
    /// Various workflow engine state details, potentially including such things as:
    ///
    /// * condition that fired to cause this Action to be done (with actual variables substituted);
    /// * list of notifications which actually occurred (with all variables substituted);
    /// * other workflow engine state.
    ///
    /// This specification does not currently define the actual structure or semantics of this field.
    pub wf_details: Option<ItemStructure>,
}