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

/// A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
///
/// FHIR path: `Composition`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct Composition {
    /// `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..1): Version-independent identifier for the Composition
    pub identifier: Option<Identifier>,
    /// `status` (1..1): preliminary | final | amended | entered-in-error
    pub status: Option<Primitive<String>>,
    /// `type` (1..1): Kind of composition (LOINC if possible)
    pub type_: Option<CodeableConcept>,
    /// `category` (0..*): Categorization of Composition
    pub category: Vec<CodeableConcept>,
    /// `subject` (0..1): Who and/or what the composition is about
    pub subject: Option<Reference>,
    /// `encounter` (0..1): Context of the Composition
    pub encounter: Option<Reference>,
    /// `date` (1..1): Composition editing time
    pub date: Option<Primitive<String>>,
    /// `author` (1..*): Who and/or what authored the composition
    pub author: Vec<Reference>,
    /// `title` (1..1): Human Readable name/title
    pub title: Option<Primitive<String>>,
    /// `confidentiality` (0..1): As defined by affinity domain
    pub confidentiality: Option<Primitive<String>>,
    /// `attester` (0..*): Attests to accuracy of composition
    pub attester: Vec<CompositionAttester>,
    /// `custodian` (0..1): Organization which maintains the composition
    pub custodian: Option<Reference>,
    /// `relatesTo` (0..*): Relationships to other compositions/documents
    pub relates_to: Vec<CompositionRelatesTo>,
    /// `event` (0..*): The clinical service(s) being documented
    pub event: Vec<CompositionEvent>,
    /// `section` (0..*): Composition is broken into sections
    pub section: Vec<CompositionSection>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "Composition");
        let r = Composition {
            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.one(d, "identifier"),
            status: o.prim(d, "status", Kind::Code),
            type_: o.one(d, "type"),
            category: o.list(d, "category"),
            subject: o.one(d, "subject"),
            encounter: o.one(d, "encounter"),
            date: o.prim(d, "date", Kind::DateTime),
            author: o.list(d, "author"),
            title: o.prim(d, "title", Kind::String),
            confidentiality: o.prim(d, "confidentiality", Kind::Code),
            attester: o.list(d, "attester"),
            custodian: o.one(d, "custodian"),
            relates_to: o.list(d, "relatesTo"),
            event: o.list(d, "event"),
            section: o.list(d, "section"),
        };
        required(d, "status", &r.status);
        required(d, "type", &r.type_);
        required(d, "date", &r.date);
        required_list(d, "author", &r.author, 1);
        required(d, "title", &r.title);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("Composition".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.one("identifier", &self.identifier);
        w.prim("status", &self.status);
        w.one("type", &self.type_);
        w.list("category", &self.category);
        w.one("subject", &self.subject);
        w.one("encounter", &self.encounter);
        w.prim("date", &self.date);
        w.list("author", &self.author);
        w.prim("title", &self.title);
        w.prim("confidentiality", &self.confidentiality);
        w.list("attester", &self.attester);
        w.one("custodian", &self.custodian);
        w.list("relatesTo", &self.relates_to);
        w.list("event", &self.event);
        w.list("section", &self.section);
        w.finish()
    }
}

/// Attests to accuracy of composition
///
/// FHIR path: `Composition.attester`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CompositionAttester {
    /// `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>,
    /// `mode` (1..1): personal | professional | legal | official
    pub mode: Option<Primitive<String>>,
    /// `time` (0..1): When the composition was attested
    pub time: Option<Primitive<String>>,
    /// `party` (0..1): Who attested the composition
    pub party: Option<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CompositionAttester {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            mode: o.prim(d, "mode", Kind::Code),
            time: o.prim(d, "time", Kind::DateTime),
            party: o.one(d, "party"),
        };
        required(d, "mode", &r.mode);
        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("mode", &self.mode);
        w.prim("time", &self.time);
        w.one("party", &self.party);
        w.finish()
    }
}

/// Relationships to other compositions/documents
///
/// FHIR path: `Composition.relatesTo`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CompositionRelatesTo {
    /// `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>,
    /// `code` (1..1): replaces | transforms | signs | appends
    pub code: Option<Primitive<String>>,
    /// `target[x]` (1..1): Target of the relationship
    pub target: Option<CompositionRelatesToTarget>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CompositionRelatesTo {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            code: o.prim(d, "code", Kind::Code),
            target: o.choice(d, "target"),
        };
        required(d, "code", &r.code);
        required(d, "target[x]", &r.target);
        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("code", &self.code);
        w.choice("target", &self.target);
        w.finish()
    }
}

/// The clinical service(s) being documented
///
/// FHIR path: `Composition.event`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CompositionEvent {
    /// `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>,
    /// `code` (0..*): Code(s) that apply to the event being documented
    pub code: Vec<CodeableConcept>,
    /// `period` (0..1): The period covered by the documentation
    pub period: Option<Period>,
    /// `detail` (0..*): The event(s) being documented
    pub detail: Vec<Reference>,
}

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

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

/// Composition is broken into sections
///
/// FHIR path: `Composition.section`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CompositionSection {
    /// `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>,
    /// `title` (0..1): Label for section (e.g. for ToC)
    pub title: Option<Primitive<String>>,
    /// `code` (0..1): Classification of section (recommended)
    pub code: Option<CodeableConcept>,
    /// `author` (0..*): Who and/or what authored the section
    pub author: Vec<Reference>,
    /// `focus` (0..1): Who/what the section is about, when it is not about the subject of composition
    pub focus: Option<Reference>,
    /// `text` (0..1): Text summary of the section, for human interpretation
    pub text: Option<Narrative>,
    /// `mode` (0..1): working | snapshot | changes
    pub mode: Option<Primitive<String>>,
    /// `orderedBy` (0..1): Order of section entries
    pub ordered_by: Option<CodeableConcept>,
    /// `entry` (0..*): A reference to data that supports this section
    pub entry: Vec<Reference>,
    /// `emptyReason` (0..1): Why the section is empty
    pub empty_reason: Option<CodeableConcept>,
    /// `section` (0..*): Nested Section
    pub section: Vec<CompositionSection>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = CompositionSection {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            title: o.prim(d, "title", Kind::String),
            code: o.one(d, "code"),
            author: o.list(d, "author"),
            focus: o.one(d, "focus"),
            text: o.one(d, "text"),
            mode: o.prim(d, "mode", Kind::Code),
            ordered_by: o.one(d, "orderedBy"),
            entry: o.list(d, "entry"),
            empty_reason: o.one(d, "emptyReason"),
            section: o.list(d, "section"),
        };
        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("title", &self.title);
        w.one("code", &self.code);
        w.list("author", &self.author);
        w.one("focus", &self.focus);
        w.one("text", &self.text);
        w.prim("mode", &self.mode);
        w.one("orderedBy", &self.ordered_by);
        w.list("entry", &self.entry);
        w.one("emptyReason", &self.empty_reason);
        w.list("section", &self.section);
        w.finish()
    }
}

/// The types `Composition.relatesTo.target[x]` allows.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq)]
pub enum CompositionRelatesToTarget {
    /// `Identifier`
    Identifier(Identifier),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "foundation")]
impl Choice for CompositionRelatesToTarget {
    const TYPES: &'static [&'static str] = &["Identifier", "Reference"];

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

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