openehr-rm 0.0.128

// @generated by openehr-codegen from BMM (`OBSERVATION`) — DO NOT EDIT.
// SPDX-FileCopyrightText: Cadasto B.V.
// SPDX-FileCopyrightText: openEHR Foundation
// SPDX-License-Identifier: Apache-2.0

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

use crate::v1_1::common::archetyped::archetyped::Archetyped;
use crate::v1_1::common::archetyped::feeder_audit::FeederAudit;
use crate::v1_1::common::archetyped::link::Link;
use crate::v1_1::common::generic::participation::Participation;
use crate::v1_1::common::generic::party_proxy::PartyProxy;
use crate::v1_1::data_structures::history::history::History;
use crate::v1_1::data_structures::item_structure::item_structure::ItemStructure;
use crate::v1_1::data_types::text::code_phrase::CodePhrase;
use crate::v1_1::data_types::text::dv_text::DvText;
use openehr_base::v1_2::base_types::identification::object_ref::ObjectRef;
use openehr_base::v1_2::base_types::identification::uid_based_id::UidBasedId;

/// Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred.
///
/// `OBSERVATION` data is expressed using the class `HISTORY<T>`, which guarantees that it is situated in time. `OBSERVATION` is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported phenomena, e.g. pain.
///
/// Not to be used for recording opinion or future statements of any kind, including instructions, intentions, plans etc.
#[doc(alias = "OBSERVATION")]
#[derive(Debug, Clone, PartialEq)]
pub struct Observation {
    // 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<FeederAudit>,

    // inherited: ENTRY
    /// Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set  languages .
    pub language: CodePhrase,
    /// Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set  character sets.
    pub encoding: CodePhrase,
    /// Other participations at `ENTRY` level.
    pub other_participations: Option<openehr_base::containers::NonEmptyVec<Participation>>,
    /// Identifier of externally held workflow engine data for this workflow execution, for this subject of care.
    pub workflow_id: Option<ObjectRef>,
    /// Id of human subject of this `ENTRY`, e.g.:
    ///
    /// * organ donor
    /// * foetus
    /// * a family member
    /// * another clinically relevant person.
    pub subject: PartyProxy,
    /// Optional identification of provider of the information in this `ENTRY`, which might be:
    ///
    /// * the patient
    /// * a patient agent, e.g. parent, guardian
    /// * the clinician
    /// * a device or software
    ///
    /// Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.
    pub provider: Option<PartyProxy>,

    // inherited: CARE_ENTRY
    /// Description of the method (i.e. how) the information in this entry was arrived at.
    ///
    /// For `OBSERVATIONs`, this is a description of the method or instrument used. For `EVALUATIONs`, how the evaluation was arrived at. For `INSTRUCTIONs`, how to execute the Instruction. This may take the form of references to guidelines, including manually followed and executable; knowledge references such as a paper in Medline; clinical reasons within a larger care process.
    pub protocol: Option<ItemStructure>,
    /// Optional external identifier of guideline creating this Entry if relevant.
    pub guideline_id: Option<ObjectRef>,
    /// The data of this observation, in the form of a history of values which may be of any complexity.
    pub data: History<ItemStructure>,
    /// Optional recording of the state of subject of this observation during the observation process, in the form of a separate history of values which may be of any complexity.
    ///
    /// State may also be recorded within the History of the data attribute.
    pub state: Option<History<ItemStructure>>,
}