fhirkit 0.1.0

// @generated by fhirkit-gen from hl7.fhir.r4.core 4.0.1. Do not edit.
//! The FHIR R4 `ResearchElementDefinition` 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::*;

/// The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
///
/// FHIR path: `ResearchElementDefinition`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ResearchElementDefinition {
    /// `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>,
    /// `url` (0..1): Canonical identifier for this research element definition, represented as a URI (globally unique)
    pub url: Option<Primitive<String>>,
    /// `identifier` (0..*): Additional identifier for the research element definition
    pub identifier: Vec<Identifier>,
    /// `version` (0..1): Business version of the research element definition
    pub version: Option<Primitive<String>>,
    /// `name` (0..1): Name for this research element definition (computer friendly)
    pub name: Option<Primitive<String>>,
    /// `title` (0..1): Name for this research element definition (human friendly)
    pub title: Option<Primitive<String>>,
    /// `shortTitle` (0..1): Title for use in informal contexts
    pub short_title: Option<Primitive<String>>,
    /// `subtitle` (0..1): Subordinate title of the ResearchElementDefinition
    pub subtitle: Option<Primitive<String>>,
    /// `status` (1..1): draft | active | retired | unknown
    pub status: Option<Primitive<String>>,
    /// `experimental` (0..1): For testing purposes, not real usage
    pub experimental: Option<Primitive<bool>>,
    /// `subject[x]` (0..1): E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    pub subject: Option<ResearchElementDefinitionSubject>,
    /// `date` (0..1): Date last changed
    pub date: Option<Primitive<String>>,
    /// `publisher` (0..1): Name of the publisher (organization or individual)
    pub publisher: Option<Primitive<String>>,
    /// `contact` (0..*): Contact details for the publisher
    pub contact: Vec<ContactDetail>,
    /// `description` (0..1): Natural language description of the research element definition
    pub description: Option<Primitive<String>>,
    /// `comment` (0..*): Used for footnotes or explanatory notes
    pub comment: Vec<Primitive<String>>,
    /// `useContext` (0..*): The context that the content is intended to support
    pub use_context: Vec<UsageContext>,
    /// `jurisdiction` (0..*): Intended jurisdiction for research element definition (if applicable)
    pub jurisdiction: Vec<CodeableConcept>,
    /// `purpose` (0..1): Why this research element definition is defined
    pub purpose: Option<Primitive<String>>,
    /// `usage` (0..1): Describes the clinical usage of the ResearchElementDefinition
    pub usage: Option<Primitive<String>>,
    /// `copyright` (0..1): Use and/or publishing restrictions
    pub copyright: Option<Primitive<String>>,
    /// `approvalDate` (0..1): When the research element definition was approved by publisher
    pub approval_date: Option<Primitive<String>>,
    /// `lastReviewDate` (0..1): When the research element definition was last reviewed
    pub last_review_date: Option<Primitive<String>>,
    /// `effectivePeriod` (0..1): When the research element definition is expected to be used
    pub effective_period: Option<Period>,
    /// `topic` (0..*): The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
    pub topic: Vec<CodeableConcept>,
    /// `author` (0..*): Who authored the content
    pub author: Vec<ContactDetail>,
    /// `editor` (0..*): Who edited the content
    pub editor: Vec<ContactDetail>,
    /// `reviewer` (0..*): Who reviewed the content
    pub reviewer: Vec<ContactDetail>,
    /// `endorser` (0..*): Who endorsed the content
    pub endorser: Vec<ContactDetail>,
    /// `relatedArtifact` (0..*): Additional documentation, citations, etc.
    pub related_artifact: Vec<RelatedArtifact>,
    /// `library` (0..*): Logic used by the ResearchElementDefinition
    pub library: Vec<Primitive<String>>,
    /// `type` (1..1): population | exposure | outcome
    pub type_: Option<Primitive<String>>,
    /// `variableType` (0..1): dichotomous | continuous | descriptive
    pub variable_type: Option<Primitive<String>>,
    /// `characteristic` (1..*): What defines the members of the research element
    pub characteristic: Vec<ResearchElementDefinitionCharacteristic>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "ResearchElementDefinition");
        let r = ResearchElementDefinition {
            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"),
            url: o.prim(d, "url", Kind::Uri),
            identifier: o.list(d, "identifier"),
            version: o.prim(d, "version", Kind::String),
            name: o.prim(d, "name", Kind::String),
            title: o.prim(d, "title", Kind::String),
            short_title: o.prim(d, "shortTitle", Kind::String),
            subtitle: o.prim(d, "subtitle", Kind::String),
            status: o.prim(d, "status", Kind::Code),
            experimental: o.prim(d, "experimental", Kind::Boolean),
            subject: o.choice(d, "subject"),
            date: o.prim(d, "date", Kind::DateTime),
            publisher: o.prim(d, "publisher", Kind::String),
            contact: o.list(d, "contact"),
            description: o.prim(d, "description", Kind::Markdown),
            comment: o.prim_list(d, "comment", Kind::String),
            use_context: o.list(d, "useContext"),
            jurisdiction: o.list(d, "jurisdiction"),
            purpose: o.prim(d, "purpose", Kind::Markdown),
            usage: o.prim(d, "usage", Kind::String),
            copyright: o.prim(d, "copyright", Kind::Markdown),
            approval_date: o.prim(d, "approvalDate", Kind::Date),
            last_review_date: o.prim(d, "lastReviewDate", Kind::Date),
            effective_period: o.one(d, "effectivePeriod"),
            topic: o.list(d, "topic"),
            author: o.list(d, "author"),
            editor: o.list(d, "editor"),
            reviewer: o.list(d, "reviewer"),
            endorser: o.list(d, "endorser"),
            related_artifact: o.list(d, "relatedArtifact"),
            library: o.prim_list(d, "library", Kind::Canonical),
            type_: o.prim(d, "type", Kind::Code),
            variable_type: o.prim(d, "variableType", Kind::Code),
            characteristic: o.list(d, "characteristic"),
        };
        required(d, "status", &r.status);
        required(d, "type", &r.type_);
        required_list(d, "characteristic", &r.characteristic, 1);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw(
            "resourceType",
            Json::String("ResearchElementDefinition".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.prim("url", &self.url);
        w.list("identifier", &self.identifier);
        w.prim("version", &self.version);
        w.prim("name", &self.name);
        w.prim("title", &self.title);
        w.prim("shortTitle", &self.short_title);
        w.prim("subtitle", &self.subtitle);
        w.prim("status", &self.status);
        w.prim("experimental", &self.experimental);
        w.choice("subject", &self.subject);
        w.prim("date", &self.date);
        w.prim("publisher", &self.publisher);
        w.list("contact", &self.contact);
        w.prim("description", &self.description);
        w.prim_list("comment", &self.comment);
        w.list("useContext", &self.use_context);
        w.list("jurisdiction", &self.jurisdiction);
        w.prim("purpose", &self.purpose);
        w.prim("usage", &self.usage);
        w.prim("copyright", &self.copyright);
        w.prim("approvalDate", &self.approval_date);
        w.prim("lastReviewDate", &self.last_review_date);
        w.one("effectivePeriod", &self.effective_period);
        w.list("topic", &self.topic);
        w.list("author", &self.author);
        w.list("editor", &self.editor);
        w.list("reviewer", &self.reviewer);
        w.list("endorser", &self.endorser);
        w.list("relatedArtifact", &self.related_artifact);
        w.prim_list("library", &self.library);
        w.prim("type", &self.type_);
        w.prim("variableType", &self.variable_type);
        w.list("characteristic", &self.characteristic);
        w.finish()
    }
}

/// What defines the members of the research element
///
/// FHIR path: `ResearchElementDefinition.characteristic`.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ResearchElementDefinitionCharacteristic {
    /// `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>,
    /// `definition[x]` (1..1): What code or expression defines members?
    pub definition: Option<ResearchElementDefinitionCharacteristicDefinition>,
    /// `usageContext` (0..*): What code/value pairs define members?
    pub usage_context: Vec<UsageContext>,
    /// `exclude` (0..1): Whether the characteristic includes or excludes members
    pub exclude: Option<Primitive<bool>>,
    /// `unitOfMeasure` (0..1): What unit is the outcome described in?
    pub unit_of_measure: Option<CodeableConcept>,
    /// `studyEffectiveDescription` (0..1): What time period does the study cover
    pub study_effective_description: Option<Primitive<String>>,
    /// `studyEffective[x]` (0..1): What time period does the study cover
    pub study_effective: Option<ResearchElementDefinitionCharacteristicStudyEffective>,
    /// `studyEffectiveTimeFromStart` (0..1): Observation time from study start
    pub study_effective_time_from_start: Option<Duration>,
    /// `studyEffectiveGroupMeasure` (0..1): mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    pub study_effective_group_measure: Option<Primitive<String>>,
    /// `participantEffectiveDescription` (0..1): What time period do participants cover
    pub participant_effective_description: Option<Primitive<String>>,
    /// `participantEffective[x]` (0..1): What time period do participants cover
    pub participant_effective: Option<ResearchElementDefinitionCharacteristicParticipantEffective>,
    /// `participantEffectiveTimeFromStart` (0..1): Observation time from study start
    pub participant_effective_time_from_start: Option<Duration>,
    /// `participantEffectiveGroupMeasure` (0..1): mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    pub participant_effective_group_measure: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = ResearchElementDefinitionCharacteristic {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            definition: o.choice(d, "definition"),
            usage_context: o.list(d, "usageContext"),
            exclude: o.prim(d, "exclude", Kind::Boolean),
            unit_of_measure: o.one(d, "unitOfMeasure"),
            study_effective_description: o.prim(d, "studyEffectiveDescription", Kind::String),
            study_effective: o.choice(d, "studyEffective"),
            study_effective_time_from_start: o.one(d, "studyEffectiveTimeFromStart"),
            study_effective_group_measure: o.prim(d, "studyEffectiveGroupMeasure", Kind::Code),
            participant_effective_description: o.prim(
                d,
                "participantEffectiveDescription",
                Kind::String,
            ),
            participant_effective: o.choice(d, "participantEffective"),
            participant_effective_time_from_start: o.one(d, "participantEffectiveTimeFromStart"),
            participant_effective_group_measure: o.prim(
                d,
                "participantEffectiveGroupMeasure",
                Kind::Code,
            ),
        };
        required(d, "definition[x]", &r.definition);
        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.choice("definition", &self.definition);
        w.list("usageContext", &self.usage_context);
        w.prim("exclude", &self.exclude);
        w.one("unitOfMeasure", &self.unit_of_measure);
        w.prim(
            "studyEffectiveDescription",
            &self.study_effective_description,
        );
        w.choice("studyEffective", &self.study_effective);
        w.one(
            "studyEffectiveTimeFromStart",
            &self.study_effective_time_from_start,
        );
        w.prim(
            "studyEffectiveGroupMeasure",
            &self.study_effective_group_measure,
        );
        w.prim(
            "participantEffectiveDescription",
            &self.participant_effective_description,
        );
        w.choice("participantEffective", &self.participant_effective);
        w.one(
            "participantEffectiveTimeFromStart",
            &self.participant_effective_time_from_start,
        );
        w.prim(
            "participantEffectiveGroupMeasure",
            &self.participant_effective_group_measure,
        );
        w.finish()
    }
}

/// The types `ResearchElementDefinition.subject[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ResearchElementDefinitionSubject {
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
    /// `Reference`
    Reference(Reference),
}

#[cfg(feature = "specialized")]
impl Choice for ResearchElementDefinitionSubject {
    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),
        }
    }
}

/// The types `ResearchElementDefinition.characteristic.definition[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ResearchElementDefinitionCharacteristicDefinition {
    /// `CodeableConcept`
    CodeableConcept(CodeableConcept),
    /// `canonical`
    Canonical(Primitive<String>),
    /// `Expression`
    Expression(Expression),
    /// `DataRequirement`
    DataRequirement(DataRequirement),
}

#[cfg(feature = "specialized")]
impl Choice for ResearchElementDefinitionCharacteristicDefinition {
    const TYPES: &'static [&'static str] = &[
        "CodeableConcept",
        "canonical",
        "Expression",
        "DataRequirement",
    ];

    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),
            "canonical" => o.prim(d, key, Kind::Canonical).map(Self::Canonical),
            "Expression" => o.one(d, key).map(Self::Expression),
            "DataRequirement" => o.one(d, key).map(Self::DataRequirement),
            _ => None,
        }
    }

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

/// The types `ResearchElementDefinition.characteristic.studyEffective[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ResearchElementDefinitionCharacteristicStudyEffective {
    /// `dateTime`
    DateTime(Primitive<String>),
    /// `Period`
    Period(Period),
    /// `Duration`
    Duration(Duration),
    /// `Timing`
    Timing(Timing),
}

#[cfg(feature = "specialized")]
impl Choice for ResearchElementDefinitionCharacteristicStudyEffective {
    const TYPES: &'static [&'static str] = &["dateTime", "Period", "Duration", "Timing"];

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

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

/// The types `ResearchElementDefinition.characteristic.participantEffective[x]` allows.
#[cfg(feature = "specialized")]
#[derive(Debug, Clone, PartialEq)]
pub enum ResearchElementDefinitionCharacteristicParticipantEffective {
    /// `dateTime`
    DateTime(Primitive<String>),
    /// `Period`
    Period(Period),
    /// `Duration`
    Duration(Duration),
    /// `Timing`
    Timing(Timing),
}

#[cfg(feature = "specialized")]
impl Choice for ResearchElementDefinitionCharacteristicParticipantEffective {
    const TYPES: &'static [&'static str] = &["dateTime", "Period", "Duration", "Timing"];

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

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