openehr-rm 0.0.128

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

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

use openehr_base::v1_2::base_types::identification::object_ref::ObjectRef;

/// The manifest for one entity (e.g. EHR subject), identifying the entity and optionally specifying top-level items to be included in the Extract.
///
/// The list actually included may be modified by the `_version_spec_` part of the specification, and also by the link_depth attribute. In repeat (standing order) requests, the final inclusion may be modified by the send_changes_only value for `EXTRACT_UPDATE_SPEC._update_method_`.
///
/// Various identifiers may be provided for the entity; these are to be used by the receiver system to locate the entity. The `_extract_id_key_` attribute is used to record the identifier that will be used throughout the Extract for this entity, including in instances of `EXTRACT_ENTITY_IDENTIFIER`.
#[doc(alias = "EXTRACT_ENTITY_MANIFEST")]
#[derive(Debug, Clone, PartialEq)]
pub struct ExtractEntityManifest {
    /// Identifier by which this entity is known in the Extract. May be one of the other identifiers, e.g. ehr_id or subject_id, or it may be something else, including a simple integer.
    pub extract_id_key: String,
    /// EHR / EMR identifier for the entity at the target system.
    pub ehr_id: Option<String>,
    /// Subject (i.e. patient or similar) identifier for the entity at the target system.
    pub subject_id: Option<String>,
    /// Other identifiers that may be used to find the entity at the target system, keyed by type. May include medicare numbers, drivers license number, tax number etc.
    pub other_ids: Option<Vec<String>>,
    /// List of Uids of items to be included in the Extract, in cases where individual items are being requested by id.
    ///
    /// More typically, this attribute is not used, and the `EXTRACT_SPEC._criteria query_` defines the Extract contents. If set, for openEHR data, these are Uids identifying the version containers.
    pub item_list: Option<Vec<ObjectRef>>,
}