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: 4.0.1
//!
//! A timing schedule that specifies an event that may occur multiple times
//!
//! FHIR R4: <https://hl7.org/fhir/R4/>

// The `types` import is unused by a handful of types that have only primitive fields.
#![allow(unused_imports)]

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

/// Base StructureDefinition for Timing Type: 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::r4::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")]
#[fhir_version("r4")]
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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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>,

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

/// A set of rules that describe when the event is scheduled.
///
/// # Examples
///
/// ```
/// use fhir::r4::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")]
#[fhir_version("r4")]
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>,

    /// Length/Range of lengths, or (Start and/or end) limits
    /// 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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_durationUnit")]
    pub duration_unit_ext: Option<types::Element>,

    /// Event occurs frequency times per period
    pub frequency: Option<types::PositiveInt>,
    /// Primitive extension sibling for [`frequency`](Self::frequency) (FHIR `_frequency`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_frequencyMax")]
    pub frequency_max_ext: Option<types::Element>,

    /// Event occurs frequency times per period
    pub period: Option<types::Decimal>,
    /// Primitive extension sibling for [`period`](Self::period) (FHIR `_period`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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::coded::Coded<crate::r4::codes::DaysOfWeek>>,
    /// Primitive extension sibling for [`day_of_week`](Self::day_of_week) (FHIR `_dayOfWeek`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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::coded::Coded<crate::r4::codes::EventTiming>>,
    /// Primitive extension sibling for [`when`](Self::when) (FHIR `_when`):
    /// carries `id` and/or `extension` for the primitive value.
    #[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`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_offset")]
    pub offset_ext: Option<types::Element>,
}

/// The `Timing.repeat.bounds[x]` choice element (see `spec/11-choice-types.md`).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[fhir_version("r4")]
#[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>),
}

#[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);
    }
}