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.
//! GuidanceResponse
//!
//! URL: http://hl7.org/fhir/StructureDefinition/GuidanceResponse
//!
//! Version: 
//!
//! The formal response to a guidance request
//!
//! FHIR R3: <https://hl7.org/fhir/STU3/>

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

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

/// Base StructureDefinition for GuidanceResponse Resource
///
/// # Examples
///
/// ```
/// use fhir::r3::resources::guidance_response::GuidanceResponse;
///
/// let value = GuidanceResponse::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: GuidanceResponse = ::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("r3")]
pub struct GuidanceResponse {
    /// Logical id of this artifact
    pub id: Option<types::Id>,

    /// Metadata about the resource
    pub meta: Option<types::Meta>,

    /// A set of rules under which this content was created
    pub implicit_rules: Option<types::Uri>,
    /// Primitive extension sibling for [`implicit_rules`](Self::implicit_rules) (FHIR `_implicitRules`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_implicitRules")]
    pub implicit_rules_ext: Option<types::Element>,

    /// Language of the resource content
    pub language: Option<types::Code>,
    /// Primitive extension sibling for [`language`](Self::language) (FHIR `_language`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_language")]
    pub language_ext: Option<types::Element>,

    /// Text summary of the resource, for human interpretation
    pub text: Option<types::Narrative>,

    /// Contained, inline Resources
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub contained: Vec<::serde_json::Value>,

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

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

    /// The id of the request associated with this response, if any
    pub request_id: Option<types::Id>,
    /// Primitive extension sibling for [`request_id`](Self::request_id) (FHIR `_requestId`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_requestId")]
    pub request_id_ext: Option<types::Element>,

    /// Business identifier
    pub identifier: Option<types::Identifier>,

    /// A reference to a knowledge module
    pub module: types::Reference,

    /// success | data-requested | data-required | in-progress | failure |
    /// entered-in-error
    pub status: crate::coded::Coded<crate::r3::codes::GuidanceResponseStatus>,
    /// Primitive extension sibling for [`status`](Self::status) (FHIR `_status`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_status")]
    pub status_ext: Option<types::Element>,

    /// Patient the request was performed for
    pub subject: Option<types::Reference>,

    /// Encounter or Episode during which the response was returned
    pub context: Option<types::Reference>,

    /// When the guidance response was processed
    pub occurrence_date_time: Option<types::DateTime>,
    /// Primitive extension sibling for [`occurrence_date_time`](Self::occurrence_date_time) (FHIR `_occurrenceDateTime`):
    /// carries `id` and/or `extension` for the primitive value.
    #[serde(rename = "_occurrenceDateTime")]
    pub occurrence_date_time_ext: Option<types::Element>,

    /// Device returning the guidance
    pub performer: Option<types::Reference>,

    /// Reason for the response
    /// The `GuidanceResponse.reason[x]` choice element (0..1); see [`GuidanceResponseReason`].
    #[serde(flatten)]
    pub reason: Option<GuidanceResponseReason>,

    /// Additional notes about the response
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub note: Vec<types::Annotation>,

    /// Messages resulting from the evaluation of the artifact or artifacts
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evaluation_message: Vec<types::Reference>,

    /// The output parameters of the evaluation, if any
    pub output_parameters: Option<types::Reference>,

    /// Proposed actions, if any
    pub result: Option<types::Reference>,

    /// Additional required data
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data_requirement: Vec<types::DataRequirement>,
}

/// The `GuidanceResponse.reason[x]` choice element (see `spec/11-choice-types.md`).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[fhir_version("r3")]
#[allow(clippy::large_enum_variant)]
pub enum GuidanceResponseReason {
    /// `reasonCodeableConcept` variant.
    #[fhir("reasonCodeableConcept")]
    CodeableConcept(Box<types::CodeableConcept>),
    /// `reasonReference` variant.
    #[fhir("reasonReference")]
    Reference(Box<types::Reference>),
}

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

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