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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

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

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

use crate::common::archetyped::archetyped::Archetyped;
use crate::common::archetyped::feeder_audit::FeederAudit;
use crate::common::archetyped::link::Link;
use crate::data_structures::representation::cluster::Cluster;
use crate::data_types::text::dv_text::DvText;
use openehr_base::prelude::UidBasedId;

/// Logical relational database style table data structure, in which columns are named and ordered with respect to each other.
///
/// Implemented using Cluster-per-row encoding. Each row Cluster must have an identical number of Elements, each of which in turn must have identical names and value types in the corresponding positions in each row.
///
/// Some columns may be designated  key' columns, containing key data for each row, in the manner of relational tables. This allows row-naming, where each row represents a body site, a blood antigen etc. All values in a column have the same data type.
///
/// Used for representing any data which is logically a table of values, such as blood pressure, most protocols, many blood tests etc.
///
/// Misuse: Not to be used for time-based data, which should be represented with the temporal class `HISTORY`. The table may be empty.
#[doc(alias = "ITEM_TABLE")]
#[derive(Debug, Clone, PartialEq)]
pub struct ItemTable {
    // inherited: LOCATABLE
    /// 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.
    pub name: DvText,
    /// 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.
    ///
    /// 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.
    pub archetype_node_id: String,
    /// Optional globally unique object identifier for root points of archetyped structures.
    pub uid: Option<UidBasedId>,
    /// 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.
    pub links: Option<openehr_base::containers::NonEmptyVec<Link>>,
    /// Details of archetyping used on this node.
    pub archetype_details: Option<Archetyped>,
    /// 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.
    pub feeder_audit: Option<Box<FeederAudit>>,
    /// Physical representation of the table as a list of `CLUSTERs`, each containing the data of one row of the table.
    pub rows: Option<Vec<Cluster>>,
}