fhir 1.2.0

Fast Healthcare Interoperability Resources (FHIR) data model for Rust: the complete FHIR R5, R4, and R3 resources, datatypes, and code systems as serde-serializable types, plus a spec-driven code generator.
//! Timing
//!
//! URL: http://hl7.org/fhir/StructureDefinition/Timing
//!
//! Version: 5.0.0
//!
//! Timing Type: Specifies an event that may occur multiple times.
//!
//! FHIR: <https://build.fhir.org/>
//!
//! UML: <https://build.fhir.org/uml.html>

// Allow unused crate::r5::types as types;
#![allow(unused_imports)]

use crate::r5::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::{Builder, Validate};

/// Specifies an event that may occur multiple times.
///
/// Timing schedules are used to record when things are planned, expected or
/// requested to occur. The most common usage is in dosage instructions for
/// medications. They are also used when planning care of various kinds, and
/// may be used for reporting the schedule to which past regular activities
/// were carried out.
///
/// # Examples
///
/// ```
/// use fhir::r5::types::timing::Timing;
///
/// let value = Timing::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: Timing = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate, Builder)]
#[serde(rename_all = "camelCase")]
pub struct Timing {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored even if unrecognized
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// When the event occurs
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub event: Vec<types::DateTime>,
    /// Primitive extension sibling for [`event`](Self::event) (FHIR `_event`).
    #[serde(rename = "_event")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub event_ext: Vec<Option<types::Element>>,

    /// When the event is to occur
    pub repeat: Option<TimingRepeat>,

    /// C | BID | TID | QID | AM | PM | QD | QOD | +
    pub code: Option<types::CodeableConcept>,
}

/// When the event is to occur.
///
/// A set of rules that describe when the event is scheduled, nested within a
/// [`Timing`] value.
///
/// # Examples
///
/// ```
/// use fhir::r5::types::timing::TimingRepeat;
///
/// let value = TimingRepeat::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: TimingRepeat = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct TimingRepeat {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// The `Timing.repeat.bounds[x]` choice element (0..1); see [`TimingRepeatBounds`].
    #[serde(flatten)]
    pub bounds: Option<TimingRepeatBounds>,

    /// Number of times to repeat
    pub count: Option<types::PositiveInt>,
    /// Primitive extension sibling for [`count`](Self::count) (FHIR `_count`).
    #[serde(rename = "_count")]
    pub count_ext: Option<types::Element>,

    /// Maximum number of times to repeat
    pub count_max: Option<types::PositiveInt>,
    /// Primitive extension sibling for [`count_max`](Self::count_max) (FHIR `_countMax`).
    #[serde(rename = "_countMax")]
    pub count_max_ext: Option<types::Element>,

    /// How long when it happens
    pub duration: Option<types::Decimal>,
    /// Primitive extension sibling for [`duration`](Self::duration) (FHIR `_duration`).
    #[serde(rename = "_duration")]
    pub duration_ext: Option<types::Element>,

    /// How long when it happens (Max)
    pub duration_max: Option<types::Decimal>,
    /// Primitive extension sibling for [`duration_max`](Self::duration_max) (FHIR `_durationMax`).
    #[serde(rename = "_durationMax")]
    pub duration_max_ext: Option<types::Element>,

    /// s | min | h | d | wk | mo | a - unit of time (UCUM)
    pub duration_unit: Option<types::Code>,
    /// Primitive extension sibling for [`duration_unit`](Self::duration_unit) (FHIR `_durationUnit`).
    #[serde(rename = "_durationUnit")]
    pub duration_unit_ext: Option<types::Element>,

    /// Indicates the number of repetitions that should occur within a period
    pub frequency: Option<types::PositiveInt>,
    /// Primitive extension sibling for [`frequency`](Self::frequency) (FHIR `_frequency`).
    #[serde(rename = "_frequency")]
    pub frequency_ext: Option<types::Element>,

    /// Event occurs up to frequencyMax times per period
    pub frequency_max: Option<types::PositiveInt>,
    /// Primitive extension sibling for [`frequency_max`](Self::frequency_max) (FHIR `_frequencyMax`).
    #[serde(rename = "_frequencyMax")]
    pub frequency_max_ext: Option<types::Element>,

    /// The duration to which the frequency applies
    pub period: Option<types::Decimal>,
    /// Primitive extension sibling for [`period`](Self::period) (FHIR `_period`).
    #[serde(rename = "_period")]
    pub period_ext: Option<types::Element>,

    /// Upper limit of period (3-4 hours)
    pub period_max: Option<types::Decimal>,
    /// Primitive extension sibling for [`period_max`](Self::period_max) (FHIR `_periodMax`).
    #[serde(rename = "_periodMax")]
    pub period_max_ext: Option<types::Element>,

    /// s | min | h | d | wk | mo | a - unit of time (UCUM)
    pub period_unit: Option<types::Code>,
    /// Primitive extension sibling for [`period_unit`](Self::period_unit) (FHIR `_periodUnit`).
    #[serde(rename = "_periodUnit")]
    pub period_unit_ext: Option<types::Element>,

    /// mon | tue | wed | thu | fri | sat | sun
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub day_of_week: Vec<crate::r5::coded::Coded<crate::r5::codes::DaysOfWeek>>,
    /// Primitive extension sibling for [`day_of_week`](Self::day_of_week) (FHIR `_dayOfWeek`).
    #[serde(rename = "_dayOfWeek")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub day_of_week_ext: Vec<Option<types::Element>>,

    /// Time of day for action
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub time_of_day: Vec<types::Time>,
    /// Primitive extension sibling for [`time_of_day`](Self::time_of_day) (FHIR `_timeOfDay`).
    #[serde(rename = "_timeOfDay")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub time_of_day_ext: Vec<Option<types::Element>>,

    /// Code for time period of occurrence
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub when: Vec<crate::r5::coded::Coded<crate::r5::codes::EventTiming>>,
    /// Primitive extension sibling for [`when`](Self::when) (FHIR `_when`).
    #[serde(rename = "_when")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub when_ext: Vec<Option<types::Element>>,

    /// Minutes from event (before or after)
    pub offset: Option<types::UnsignedInt>,
    /// Primitive extension sibling for [`offset`](Self::offset) (FHIR `_offset`).
    #[serde(rename = "_offset")]
    pub offset_ext: Option<types::Element>,
}

#[cfg(test)]
mod tests {
    use super::*;
    type T = Timing;

    #[test]
    fn test_default() {
        let _ = T::default();
    }

    #[test]
    fn test_serde_round_trip() {
        let value = T::default();
        let json = ::serde_json::to_value(&value).expect("to_value");
        let back: T = ::serde_json::from_value(json).expect("from_value");
        assert_eq!(value, back);
    }
}
/// The `Timing.repeat.bounds[x]` choice element (see spec/11-choice-types.md).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[allow(clippy::large_enum_variant)]
pub enum TimingRepeatBounds {
    /// `boundsDuration` variant.
    #[fhir("boundsDuration")]
    Duration(Box<types::Duration>),
    /// `boundsRange` variant.
    #[fhir("boundsRange")]
    Range(Box<types::Range>),
    /// `boundsPeriod` variant.
    #[fhir("boundsPeriod")]
    Period(Box<types::Period>),
}