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 `CarePlan` 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::*;

/// Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
///
/// FHIR path: `CarePlan`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CarePlan {
    /// `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>,
    /// `identifier` (0..*): External Ids for this plan
    pub identifier: Vec<Identifier>,
    /// `instantiatesCanonical` (0..*): Instantiates FHIR protocol or definition
    pub instantiates_canonical: Vec<Primitive<String>>,
    /// `instantiatesUri` (0..*): Instantiates external protocol or definition
    pub instantiates_uri: Vec<Primitive<String>>,
    /// `basedOn` (0..*): Fulfills CarePlan
    pub based_on: Vec<Reference>,
    /// `replaces` (0..*): CarePlan replaced by this CarePlan
    pub replaces: Vec<Reference>,
    /// `partOf` (0..*): Part of referenced CarePlan
    pub part_of: Vec<Reference>,
    /// `status` (1..1): draft | active | on-hold | revoked | completed | entered-in-error | unknown
    pub status: Option<Primitive<String>>,
    /// `intent` (1..1): proposal | plan | order | option
    pub intent: Option<Primitive<String>>,
    /// `category` (0..*): Type of plan
    pub category: Vec<CodeableConcept>,
    /// `title` (0..1): Human-friendly name for the care plan
    pub title: Option<Primitive<String>>,
    /// `description` (0..1): Summary of nature of plan
    pub description: Option<Primitive<String>>,
    /// `subject` (1..1): Who the care plan is for
    pub subject: Option<Reference>,
    /// `encounter` (0..1): Encounter created as part of
    pub encounter: Option<Reference>,
    /// `period` (0..1): Time period plan covers
    pub period: Option<Period>,
    /// `created` (0..1): Date record was first recorded
    pub created: Option<Primitive<String>>,
    /// `author` (0..1): Who is the designated responsible party
    pub author: Option<Reference>,
    /// `contributor` (0..*): Who provided the content of the care plan
    pub contributor: Vec<Reference>,
    /// `careTeam` (0..*): Who's involved in plan?
    pub care_team: Vec<Reference>,
    /// `addresses` (0..*): Health issues this plan addresses
    pub addresses: Vec<Reference>,
    /// `supportingInfo` (0..*): Information considered as part of plan
    pub supporting_info: Vec<Reference>,
    /// `goal` (0..*): Desired outcome of plan
    pub goal: Vec<Reference>,
    /// `activity` (0..*): Action to occur as part of plan
    pub activity: Vec<CarePlanActivity>,
    /// `note` (0..*): Comments about the plan
    pub note: Vec<Annotation>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "CarePlan");
        let r = CarePlan {
            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"),
            identifier: o.list(d, "identifier"),
            instantiates_canonical: o.prim_list(d, "instantiatesCanonical", Kind::Canonical),
            instantiates_uri: o.prim_list(d, "instantiatesUri", Kind::Uri),
            based_on: o.list(d, "basedOn"),
            replaces: o.list(d, "replaces"),
            part_of: o.list(d, "partOf"),
            status: o.prim(d, "status", Kind::Code),
            intent: o.prim(d, "intent", Kind::Code),
            category: o.list(d, "category"),
            title: o.prim(d, "title", Kind::String),
            description: o.prim(d, "description", Kind::String),
            subject: o.one(d, "subject"),
            encounter: o.one(d, "encounter"),
            period: o.one(d, "period"),
            created: o.prim(d, "created", Kind::DateTime),
            author: o.one(d, "author"),
            contributor: o.list(d, "contributor"),
            care_team: o.list(d, "careTeam"),
            addresses: o.list(d, "addresses"),
            supporting_info: o.list(d, "supportingInfo"),
            goal: o.list(d, "goal"),
            activity: o.list(d, "activity"),
            note: o.list(d, "note"),
        };
        required(d, "status", &r.status);
        required(d, "intent", &r.intent);
        required(d, "subject", &r.subject);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("CarePlan".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("identifier", &self.identifier);
        w.prim_list("instantiatesCanonical", &self.instantiates_canonical);
        w.prim_list("instantiatesUri", &self.instantiates_uri);
        w.list("basedOn", &self.based_on);
        w.list("replaces", &self.replaces);
        w.list("partOf", &self.part_of);
        w.prim("status", &self.status);
        w.prim("intent", &self.intent);
        w.list("category", &self.category);
        w.prim("title", &self.title);
        w.prim("description", &self.description);
        w.one("subject", &self.subject);
        w.one("encounter", &self.encounter);
        w.one("period", &self.period);
        w.prim("created", &self.created);
        w.one("author", &self.author);
        w.list("contributor", &self.contributor);
        w.list("careTeam", &self.care_team);
        w.list("addresses", &self.addresses);
        w.list("supportingInfo", &self.supporting_info);
        w.list("goal", &self.goal);
        w.list("activity", &self.activity);
        w.list("note", &self.note);
        w.finish()
    }
}

/// Action to occur as part of plan
///
/// FHIR path: `CarePlan.activity`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CarePlanActivity {
    /// `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>,
    /// `outcomeCodeableConcept` (0..*): Results of the activity
    pub outcome_codeable_concept: Vec<CodeableConcept>,
    /// `outcomeReference` (0..*): Appointment, Encounter, Procedure, etc.
    pub outcome_reference: Vec<Reference>,
    /// `progress` (0..*): Comments about the activity status/progress
    pub progress: Vec<Annotation>,
    /// `reference` (0..1): Activity details defined in specific resource
    pub reference: Option<Reference>,
    /// `detail` (0..1): In-line definition of activity
    pub detail: Option<CarePlanActivityDetail>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CarePlanActivity {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            outcome_codeable_concept: o.list(d, "outcomeCodeableConcept"),
            outcome_reference: o.list(d, "outcomeReference"),
            progress: o.list(d, "progress"),
            reference: o.one(d, "reference"),
            detail: o.one(d, "detail"),
        };
        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.list("outcomeCodeableConcept", &self.outcome_codeable_concept);
        w.list("outcomeReference", &self.outcome_reference);
        w.list("progress", &self.progress);
        w.one("reference", &self.reference);
        w.one("detail", &self.detail);
        w.finish()
    }
}

/// In-line definition of activity
///
/// FHIR path: `CarePlan.activity.detail`.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CarePlanActivityDetail {
    /// `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>,
    /// `kind` (0..1): Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
    pub kind: Option<Primitive<String>>,
    /// `instantiatesCanonical` (0..*): Instantiates FHIR protocol or definition
    pub instantiates_canonical: Vec<Primitive<String>>,
    /// `instantiatesUri` (0..*): Instantiates external protocol or definition
    pub instantiates_uri: Vec<Primitive<String>>,
    /// `code` (0..1): Detail type of activity
    pub code: Option<CodeableConcept>,
    /// `reasonCode` (0..*): Why activity should be done or why activity was prohibited
    pub reason_code: Vec<CodeableConcept>,
    /// `reasonReference` (0..*): Why activity is needed
    pub reason_reference: Vec<Reference>,
    /// `goal` (0..*): Goals this activity relates to
    pub goal: Vec<Reference>,
    /// `status` (1..1): not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
    pub status: Option<Primitive<String>>,
    /// `statusReason` (0..1): Reason for current status
    pub status_reason: Option<CodeableConcept>,
    /// `doNotPerform` (0..1): If true, activity is prohibiting action
    pub do_not_perform: Option<Primitive<bool>>,
    /// `scheduled[x]` (0..1): When activity is to occur
    pub scheduled: Option<CarePlanActivityDetailScheduled>,
    /// `location` (0..1): Where it should happen
    pub location: Option<Reference>,
    /// `performer` (0..*): Who will be responsible?
    pub performer: Vec<Reference>,
    /// `product[x]` (0..1): What is to be administered/supplied
    pub product: Option<CarePlanActivityDetailProduct>,
    /// `dailyAmount` (0..1): How to consume/day?
    pub daily_amount: Option<Quantity>,
    /// `quantity` (0..1): How much to administer/supply/consume
    pub quantity: Option<Quantity>,
    /// `description` (0..1): Extra info describing activity to perform
    pub description: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CarePlanActivityDetail {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            kind: o.prim(d, "kind", Kind::Code),
            instantiates_canonical: o.prim_list(d, "instantiatesCanonical", Kind::Canonical),
            instantiates_uri: o.prim_list(d, "instantiatesUri", Kind::Uri),
            code: o.one(d, "code"),
            reason_code: o.list(d, "reasonCode"),
            reason_reference: o.list(d, "reasonReference"),
            goal: o.list(d, "goal"),
            status: o.prim(d, "status", Kind::Code),
            status_reason: o.one(d, "statusReason"),
            do_not_perform: o.prim(d, "doNotPerform", Kind::Boolean),
            scheduled: o.choice(d, "scheduled"),
            location: o.one(d, "location"),
            performer: o.list(d, "performer"),
            product: o.choice(d, "product"),
            daily_amount: o.one(d, "dailyAmount"),
            quantity: o.one(d, "quantity"),
            description: o.prim(d, "description", Kind::String),
        };
        required(d, "status", &r.status);
        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("kind", &self.kind);
        w.prim_list("instantiatesCanonical", &self.instantiates_canonical);
        w.prim_list("instantiatesUri", &self.instantiates_uri);
        w.one("code", &self.code);
        w.list("reasonCode", &self.reason_code);
        w.list("reasonReference", &self.reason_reference);
        w.list("goal", &self.goal);
        w.prim("status", &self.status);
        w.one("statusReason", &self.status_reason);
        w.prim("doNotPerform", &self.do_not_perform);
        w.choice("scheduled", &self.scheduled);
        w.one("location", &self.location);
        w.list("performer", &self.performer);
        w.choice("product", &self.product);
        w.one("dailyAmount", &self.daily_amount);
        w.one("quantity", &self.quantity);
        w.prim("description", &self.description);
        w.finish()
    }
}

/// The types `CarePlan.activity.detail.scheduled[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum CarePlanActivityDetailScheduled {
    /// `Timing`
    Timing(Timing),
    /// `Period`
    Period(Period),
    /// `string`
    String(Primitive<String>),
}

#[cfg(feature = "clinical")]
impl Choice for CarePlanActivityDetailScheduled {
    const TYPES: &'static [&'static str] = &["Timing", "Period", "string"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "Timing" => o.one(d, key).map(Self::Timing),
            "Period" => o.one(d, key).map(Self::Period),
            "string" => o.prim(d, key, Kind::String).map(Self::String),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::Timing(v) => w.value(&choice_key(base, "Timing"), v),
            Self::Period(v) => w.value(&choice_key(base, "Period"), v),
            Self::String(v) => w.prim_value(&choice_key(base, "string"), v),
        }
    }
}

/// The types `CarePlan.activity.detail.product[x]` allows.
#[cfg(feature = "clinical")]
#[derive(Debug, Clone, PartialEq)]
pub enum CarePlanActivityDetailProduct {
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "clinical")]
impl Choice for CarePlanActivityDetailProduct {
    const TYPES: &'static [&'static str] = &["CodeableConcept", "Reference"];

    fn decode_as(code: &str, key: &str, o: &mut Obj<'_>, d: &mut Decoder) -> Option<Self> {
        match code {
            "CodeableConcept" => o.one(d, key).map(Self::CodeableConcept),
            "Reference" => o.one(d, key).map(Self::Reference),
            _ => None,
        }
    }

    fn encode_into(&self, base: &str, w: &mut ObjWriter) {
        match self {
            Self::CodeableConcept(v) => w.value(&choice_key(base, "CodeableConcept"), v),
            Self::Reference(v) => w.value(&choice_key(base, "Reference"), v),
        }
    }
}