fhirkit 0.1.0

FHIR R4 for Rust: typed models for every resource and datatype generated from the official specification, lossless JSON with path-precise validation, typed search queries, FHIRPath
Documentation
// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `ObservationDefinition` resource.

#![allow(
    unused_imports,
    clippy::large_enum_variant,
    clippy::too_many_lines,
    clippy::doc_markdown
)]

use crate::decode::{
    choice_key, required, required_list, resource_type, Choice, Decoder, FhirJson, Obj, ObjWriter,
};
use crate::json::Json;
use crate::primitive::{Decimal, Kind, Primitive};
use crate::r4::*;

/// Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
///
/// FHIR path: `ObservationDefinition`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ObservationDefinition {
    /// `id` (0..1): Logical id of this artifact
    pub id: Option<String>,
    /// `meta` (0..1): Metadata about the resource
    pub meta: Option<Meta>,
    /// `implicitRules` (0..1): A set of rules under which this content was created
    pub implicit_rules: Option<Primitive<String>>,
    /// `language` (0..1): Language of the resource content
    pub language: Option<Primitive<String>>,
    /// `text` (0..1): Text summary of the resource, for human interpretation
    pub text: Option<Narrative>,
    /// `contained` (0..*): Contained, inline Resources
    pub contained: Vec<Resource>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored
    pub modifier_extension: Vec<Extension>,
    /// `category` (0..*): Category of observation
    pub category: Vec<CodeableConcept>,
    /// `code` (1..1): Type of observation (code / type)
    pub code: Option<CodeableConcept>,
    /// `identifier` (0..*): Business identifier for this ObservationDefinition instance
    pub identifier: Vec<Identifier>,
    /// `permittedDataType` (0..*): Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
    pub permitted_data_type: Vec<Primitive<String>>,
    /// `multipleResultsAllowed` (0..1): Multiple results allowed
    pub multiple_results_allowed: Option<Primitive<bool>>,
    /// `method` (0..1): Method used to produce the observation
    pub method: Option<CodeableConcept>,
    /// `preferredReportName` (0..1): Preferred report name
    pub preferred_report_name: Option<Primitive<String>>,
    /// `quantitativeDetails` (0..1): Characteristics of quantitative results
    pub quantitative_details: Option<ObservationDefinitionQuantitativeDetails>,
    /// `qualifiedInterval` (0..*): Qualified range for continuous and ordinal observation results
    pub qualified_interval: Vec<ObservationDefinitionQualifiedInterval>,
    /// `validCodedValueSet` (0..1): Value set of valid coded values for the observations conforming to this ObservationDefinition
    pub valid_coded_value_set: Option<Reference>,
    /// `normalCodedValueSet` (0..1): Value set of normal coded values for the observations conforming to this ObservationDefinition
    pub normal_coded_value_set: Option<Reference>,
    /// `abnormalCodedValueSet` (0..1): Value set of abnormal coded values for the observations conforming to this ObservationDefinition
    pub abnormal_coded_value_set: Option<Reference>,
    /// `criticalCodedValueSet` (0..1): Value set of critical coded values for the observations conforming to this ObservationDefinition
    pub critical_coded_value_set: Option<Reference>,
}

#[cfg(feature = "specialized")]
impl FhirJson for ObservationDefinition {
    const TYPE_NAME: &'static str = "ObservationDefinition";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "ObservationDefinition");
        let r = ObservationDefinition {
            id: o.string(d, "id"),
            meta: o.one(d, "meta"),
            implicit_rules: o.prim(d, "implicitRules", Kind::Uri),
            language: o.prim(d, "language", Kind::Code),
            text: o.one(d, "text"),
            contained: o.list(d, "contained"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            category: o.list(d, "category"),
            code: o.one(d, "code"),
            identifier: o.list(d, "identifier"),
            permitted_data_type: o.prim_list(d, "permittedDataType", Kind::Code),
            multiple_results_allowed: o.prim(d, "multipleResultsAllowed", Kind::Boolean),
            method: o.one(d, "method"),
            preferred_report_name: o.prim(d, "preferredReportName", Kind::String),
            quantitative_details: o.one(d, "quantitativeDetails"),
            qualified_interval: o.list(d, "qualifiedInterval"),
            valid_coded_value_set: o.one(d, "validCodedValueSet"),
            normal_coded_value_set: o.one(d, "normalCodedValueSet"),
            abnormal_coded_value_set: o.one(d, "abnormalCodedValueSet"),
            critical_coded_value_set: o.one(d, "criticalCodedValueSet"),
        };
        required(d, "code", &r.code);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("ObservationDefinition".into()));
        w.string("id", &self.id);
        w.one("meta", &self.meta);
        w.prim("implicitRules", &self.implicit_rules);
        w.prim("language", &self.language);
        w.one("text", &self.text);
        w.list("contained", &self.contained);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.list("category", &self.category);
        w.one("code", &self.code);
        w.list("identifier", &self.identifier);
        w.prim_list("permittedDataType", &self.permitted_data_type);
        w.prim("multipleResultsAllowed", &self.multiple_results_allowed);
        w.one("method", &self.method);
        w.prim("preferredReportName", &self.preferred_report_name);
        w.one("quantitativeDetails", &self.quantitative_details);
        w.list("qualifiedInterval", &self.qualified_interval);
        w.one("validCodedValueSet", &self.valid_coded_value_set);
        w.one("normalCodedValueSet", &self.normal_coded_value_set);
        w.one("abnormalCodedValueSet", &self.abnormal_coded_value_set);
        w.one("criticalCodedValueSet", &self.critical_coded_value_set);
        w.finish()
    }
}

/// Characteristics of quantitative results
///
/// FHIR path: `ObservationDefinition.quantitativeDetails`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ObservationDefinitionQuantitativeDetails {
    /// `id` (0..1): Unique id for inter-element referencing
    pub id: Option<String>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Vec<Extension>,
    /// `customaryUnit` (0..1): Customary unit for quantitative results
    pub customary_unit: Option<CodeableConcept>,
    /// `unit` (0..1): SI unit for quantitative results
    pub unit: Option<CodeableConcept>,
    /// `conversionFactor` (0..1): SI to Customary unit conversion factor
    pub conversion_factor: Option<Primitive<Decimal>>,
    /// `decimalPrecision` (0..1): Decimal precision of observation quantitative results
    pub decimal_precision: Option<Primitive<i32>>,
}

#[cfg(feature = "specialized")]
impl FhirJson for ObservationDefinitionQuantitativeDetails {
    const TYPE_NAME: &'static str = "ObservationDefinitionQuantitativeDetails";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ObservationDefinitionQuantitativeDetails {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            customary_unit: o.one(d, "customaryUnit"),
            unit: o.one(d, "unit"),
            conversion_factor: o.prim(d, "conversionFactor", Kind::Decimal),
            decimal_precision: o.prim(d, "decimalPrecision", Kind::Integer),
        };
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.string("id", &self.id);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.one("customaryUnit", &self.customary_unit);
        w.one("unit", &self.unit);
        w.prim("conversionFactor", &self.conversion_factor);
        w.prim("decimalPrecision", &self.decimal_precision);
        w.finish()
    }
}

/// Qualified range for continuous and ordinal observation results
///
/// FHIR path: `ObservationDefinition.qualifiedInterval`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ObservationDefinitionQualifiedInterval {
    /// `id` (0..1): Unique id for inter-element referencing
    pub id: Option<String>,
    /// `extension` (0..*): Additional content defined by implementations
    pub extension: Vec<Extension>,
    /// `modifierExtension` (0..*): Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Vec<Extension>,
    /// `category` (0..1): reference | critical | absolute
    pub category: Option<Primitive<String>>,
    /// `range` (0..1): The interval itself, for continuous or ordinal observations
    pub range: Option<Range>,
    /// `context` (0..1): Range context qualifier
    pub context: Option<CodeableConcept>,
    /// `appliesTo` (0..*): Targetted population of the range
    pub applies_to: Vec<CodeableConcept>,
    /// `gender` (0..1): male | female | other | unknown
    pub gender: Option<Primitive<String>>,
    /// `age` (0..1): Applicable age range, if relevant
    pub age: Option<Range>,
    /// `gestationalAge` (0..1): Applicable gestational age range, if relevant
    pub gestational_age: Option<Range>,
    /// `condition` (0..1): Condition associated with the reference range
    pub condition: Option<Primitive<String>>,
}

#[cfg(feature = "specialized")]
impl FhirJson for ObservationDefinitionQualifiedInterval {
    const TYPE_NAME: &'static str = "ObservationDefinitionQualifiedInterval";

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ObservationDefinitionQualifiedInterval {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            category: o.prim(d, "category", Kind::Code),
            range: o.one(d, "range"),
            context: o.one(d, "context"),
            applies_to: o.list(d, "appliesTo"),
            gender: o.prim(d, "gender", Kind::Code),
            age: o.one(d, "age"),
            gestational_age: o.one(d, "gestationalAge"),
            condition: o.prim(d, "condition", Kind::String),
        };
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.string("id", &self.id);
        w.list("extension", &self.extension);
        w.list("modifierExtension", &self.modifier_extension);
        w.prim("category", &self.category);
        w.one("range", &self.range);
        w.one("context", &self.context);
        w.list("appliesTo", &self.applies_to);
        w.prim("gender", &self.gender);
        w.one("age", &self.age);
        w.one("gestationalAge", &self.gestational_age);
        w.prim("condition", &self.condition);
        w.finish()
    }
}