openehr-rm 0.0.2

// @generated by openehr-codegen from BMM (`ITEM_LIST`) — DO NOT EDIT.

//! The openEHR `ITEM_LIST` 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::element::Element;
use crate::data_types::text::dv_text::DvText;
use openehr_base::prelude::UidBasedId;

/// Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty.
///
/// `ITEM_LIST` is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc.
///
/// Not to be used for time-based lists, which should be represented with the proper temporal class, i.e. `HISTORY`.
#[doc(alias = "ITEM_LIST")]
#[derive(Debug, Clone, PartialEq)]
pub struct ItemList {
    // 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 list.
    pub items: Option<Vec<Element>>,
}