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 `DocumentReference` 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 reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
///
/// FHIR path: `DocumentReference`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DocumentReference {
    /// `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>,
    /// `masterIdentifier` (0..1): Master Version Specific Identifier
    pub master_identifier: Option<Identifier>,
    /// `identifier` (0..*): Other identifiers for the document
    pub identifier: Vec<Identifier>,
    /// `status` (1..1): current | superseded | entered-in-error
    pub status: Option<Primitive<String>>,
    /// `docStatus` (0..1): preliminary | final | amended | entered-in-error
    pub doc_status: Option<Primitive<String>>,
    /// `type` (0..1): Kind of document (LOINC if possible)
    pub type_: Option<CodeableConcept>,
    /// `category` (0..*): Categorization of document
    pub category: Vec<CodeableConcept>,
    /// `subject` (0..1): Who/what is the subject of the document
    pub subject: Option<Reference>,
    /// `date` (0..1): When this document reference was created
    pub date: Option<Primitive<String>>,
    /// `author` (0..*): Who and/or what authored the document
    pub author: Vec<Reference>,
    /// `authenticator` (0..1): Who/what authenticated the document
    pub authenticator: Option<Reference>,
    /// `custodian` (0..1): Organization which maintains the document
    pub custodian: Option<Reference>,
    /// `relatesTo` (0..*): Relationships to other documents
    pub relates_to: Vec<DocumentReferenceRelatesTo>,
    /// `description` (0..1): Human-readable description
    pub description: Option<Primitive<String>>,
    /// `securityLabel` (0..*): Document security-tags
    pub security_label: Vec<CodeableConcept>,
    /// `content` (1..*): Document referenced
    pub content: Vec<DocumentReferenceContent>,
    /// `context` (0..1): Clinical context of document
    pub context: Option<DocumentReferenceContext>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "DocumentReference");
        let r = DocumentReference {
            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"),
            master_identifier: o.one(d, "masterIdentifier"),
            identifier: o.list(d, "identifier"),
            status: o.prim(d, "status", Kind::Code),
            doc_status: o.prim(d, "docStatus", Kind::Code),
            type_: o.one(d, "type"),
            category: o.list(d, "category"),
            subject: o.one(d, "subject"),
            date: o.prim(d, "date", Kind::Instant),
            author: o.list(d, "author"),
            authenticator: o.one(d, "authenticator"),
            custodian: o.one(d, "custodian"),
            relates_to: o.list(d, "relatesTo"),
            description: o.prim(d, "description", Kind::String),
            security_label: o.list(d, "securityLabel"),
            content: o.list(d, "content"),
            context: o.one(d, "context"),
        };
        required(d, "status", &r.status);
        required_list(d, "content", &r.content, 1);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("DocumentReference".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("masterIdentifier", &self.master_identifier);
        w.list("identifier", &self.identifier);
        w.prim("status", &self.status);
        w.prim("docStatus", &self.doc_status);
        w.one("type", &self.type_);
        w.list("category", &self.category);
        w.one("subject", &self.subject);
        w.prim("date", &self.date);
        w.list("author", &self.author);
        w.one("authenticator", &self.authenticator);
        w.one("custodian", &self.custodian);
        w.list("relatesTo", &self.relates_to);
        w.prim("description", &self.description);
        w.list("securityLabel", &self.security_label);
        w.list("content", &self.content);
        w.one("context", &self.context);
        w.finish()
    }
}

/// Relationships to other documents
///
/// FHIR path: `DocumentReference.relatesTo`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DocumentReferenceRelatesTo {
    /// `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` (1..1): Target of the relationship
    pub target: Option<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = DocumentReferenceRelatesTo {
            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.one(d, "target"),
        };
        required(d, "code", &r.code);
        required(d, "target", &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.one("target", &self.target);
        w.finish()
    }
}

/// Document referenced
///
/// FHIR path: `DocumentReference.content`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DocumentReferenceContent {
    /// `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>,
    /// `attachment` (1..1): Where to access the document
    pub attachment: Option<Attachment>,
    /// `format` (0..1): Format/content rules for the document
    pub format: Option<Coding>,
}

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

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

/// Clinical context of document
///
/// FHIR path: `DocumentReference.context`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DocumentReferenceContext {
    /// `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>,
    /// `encounter` (0..*): Context of the document content
    pub encounter: Vec<Reference>,
    /// `event` (0..*): Main clinical acts documented
    pub event: Vec<CodeableConcept>,
    /// `period` (0..1): Time of service that is being documented
    pub period: Option<Period>,
    /// `facilityType` (0..1): Kind of facility where patient was seen
    pub facility_type: Option<CodeableConcept>,
    /// `practiceSetting` (0..1): Additional details about where the content was created (e.g. clinical specialty)
    pub practice_setting: Option<CodeableConcept>,
    /// `sourcePatientInfo` (0..1): Patient demographics from source
    pub source_patient_info: Option<Reference>,
    /// `related` (0..*): Related identifiers or resources
    pub related: Vec<Reference>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = DocumentReferenceContext {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            encounter: o.list(d, "encounter"),
            event: o.list(d, "event"),
            period: o.one(d, "period"),
            facility_type: o.one(d, "facilityType"),
            practice_setting: o.one(d, "practiceSetting"),
            source_patient_info: o.one(d, "sourcePatientInfo"),
            related: o.list(d, "related"),
        };
        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("encounter", &self.encounter);
        w.list("event", &self.event);
        w.one("period", &self.period);
        w.one("facilityType", &self.facility_type);
        w.one("practiceSetting", &self.practice_setting);
        w.one("sourcePatientInfo", &self.source_patient_info);
        w.list("related", &self.related);
        w.finish()
    }
}