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 `StructureDefinition` 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 definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
///
/// FHIR path: `StructureDefinition`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StructureDefinition {
    /// `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` (1..1): Canonical identifier for this structure definition, represented as a URI (globally unique)
    pub url: Option<Primitive<String>>,
    /// `identifier` (0..*): Additional identifier for the structure definition
    pub identifier: Vec<Identifier>,
    /// `version` (0..1): Business version of the structure definition
    pub version: Option<Primitive<String>>,
    /// `name` (1..1): Name for this structure definition (computer friendly)
    pub name: Option<Primitive<String>>,
    /// `title` (0..1): Name for this structure definition (human friendly)
    pub title: 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>>,
    /// `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 structure definition
    pub description: Option<Primitive<String>>,
    /// `useContext` (0..*): The context that the content is intended to support
    pub use_context: Vec<UsageContext>,
    /// `jurisdiction` (0..*): Intended jurisdiction for structure definition (if applicable)
    pub jurisdiction: Vec<CodeableConcept>,
    /// `purpose` (0..1): Why this structure definition is defined
    pub purpose: Option<Primitive<String>>,
    /// `copyright` (0..1): Use and/or publishing restrictions
    pub copyright: Option<Primitive<String>>,
    /// `keyword` (0..*): Assist with indexing and finding
    pub keyword: Vec<Coding>,
    /// `fhirVersion` (0..1): FHIR Version this StructureDefinition targets
    pub fhir_version: Option<Primitive<String>>,
    /// `mapping` (0..*): External specification that the content is mapped to
    pub mapping: Vec<StructureDefinitionMapping>,
    /// `kind` (1..1): primitive-type | complex-type | resource | logical
    pub kind: Option<Primitive<String>>,
    /// `abstract` (1..1): Whether the structure is abstract
    pub abstract_: Option<Primitive<bool>>,
    /// `context` (0..*): If an extension, where it can be used in instances
    pub context: Vec<StructureDefinitionContext>,
    /// `contextInvariant` (0..*): FHIRPath invariants - when the extension can be used
    pub context_invariant: Vec<Primitive<String>>,
    /// `type` (1..1): Type defined or constrained by this structure
    pub type_: Option<Primitive<String>>,
    /// `baseDefinition` (0..1): Definition that this type is constrained/specialized from
    pub base_definition: Option<Primitive<String>>,
    /// `derivation` (0..1): specialization | constraint - How relates to base definition
    pub derivation: Option<Primitive<String>>,
    /// `snapshot` (0..1): Snapshot view of the structure
    pub snapshot: Option<StructureDefinitionSnapshot>,
    /// `differential` (0..1): Differential view of the structure
    pub differential: Option<StructureDefinitionDifferential>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        resource_type(&mut o, d, "StructureDefinition");
        let r = StructureDefinition {
            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),
            status: o.prim(d, "status", Kind::Code),
            experimental: o.prim(d, "experimental", Kind::Boolean),
            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),
            use_context: o.list(d, "useContext"),
            jurisdiction: o.list(d, "jurisdiction"),
            purpose: o.prim(d, "purpose", Kind::Markdown),
            copyright: o.prim(d, "copyright", Kind::Markdown),
            keyword: o.list(d, "keyword"),
            fhir_version: o.prim(d, "fhirVersion", Kind::Code),
            mapping: o.list(d, "mapping"),
            kind: o.prim(d, "kind", Kind::Code),
            abstract_: o.prim(d, "abstract", Kind::Boolean),
            context: o.list(d, "context"),
            context_invariant: o.prim_list(d, "contextInvariant", Kind::String),
            type_: o.prim(d, "type", Kind::Uri),
            base_definition: o.prim(d, "baseDefinition", Kind::Canonical),
            derivation: o.prim(d, "derivation", Kind::Code),
            snapshot: o.one(d, "snapshot"),
            differential: o.one(d, "differential"),
        };
        required(d, "url", &r.url);
        required(d, "name", &r.name);
        required(d, "status", &r.status);
        required(d, "kind", &r.kind);
        required(d, "abstract", &r.abstract_);
        required(d, "type", &r.type_);
        o.finish(d);
        Some(r)
    }

    fn encode(&self) -> Json {
        let mut w = ObjWriter::new();
        w.raw("resourceType", Json::String("StructureDefinition".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("status", &self.status);
        w.prim("experimental", &self.experimental);
        w.prim("date", &self.date);
        w.prim("publisher", &self.publisher);
        w.list("contact", &self.contact);
        w.prim("description", &self.description);
        w.list("useContext", &self.use_context);
        w.list("jurisdiction", &self.jurisdiction);
        w.prim("purpose", &self.purpose);
        w.prim("copyright", &self.copyright);
        w.list("keyword", &self.keyword);
        w.prim("fhirVersion", &self.fhir_version);
        w.list("mapping", &self.mapping);
        w.prim("kind", &self.kind);
        w.prim("abstract", &self.abstract_);
        w.list("context", &self.context);
        w.prim_list("contextInvariant", &self.context_invariant);
        w.prim("type", &self.type_);
        w.prim("baseDefinition", &self.base_definition);
        w.prim("derivation", &self.derivation);
        w.one("snapshot", &self.snapshot);
        w.one("differential", &self.differential);
        w.finish()
    }
}

/// External specification that the content is mapped to
///
/// FHIR path: `StructureDefinition.mapping`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StructureDefinitionMapping {
    /// `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>,
    /// `identity` (1..1): Internal id when this mapping is used
    pub identity: Option<Primitive<String>>,
    /// `uri` (0..1): Identifies what this mapping refers to
    pub uri: Option<Primitive<String>>,
    /// `name` (0..1): Names what this mapping refers to
    pub name: Option<Primitive<String>>,
    /// `comment` (0..1): Versions, Issues, Scope limitations etc.
    pub comment: Option<Primitive<String>>,
}

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

    fn decode(v: &Json, d: &mut Decoder) -> Option<Self> {
        let mut o = Obj::new(v, d)?;
        let r = StructureDefinitionMapping {
            id: o.string(d, "id"),
            extension: o.list(d, "extension"),
            modifier_extension: o.list(d, "modifierExtension"),
            identity: o.prim(d, "identity", Kind::Id),
            uri: o.prim(d, "uri", Kind::Uri),
            name: o.prim(d, "name", Kind::String),
            comment: o.prim(d, "comment", Kind::String),
        };
        required(d, "identity", &r.identity);
        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("identity", &self.identity);
        w.prim("uri", &self.uri);
        w.prim("name", &self.name);
        w.prim("comment", &self.comment);
        w.finish()
    }
}

/// If an extension, where it can be used in instances
///
/// FHIR path: `StructureDefinition.context`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StructureDefinitionContext {
    /// `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>,
    /// `type` (1..1): fhirpath | element | extension
    pub type_: Option<Primitive<String>>,
    /// `expression` (1..1): Where the extension can be used in instances
    pub expression: Option<Primitive<String>>,
}

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

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

/// Snapshot view of the structure
///
/// FHIR path: `StructureDefinition.snapshot`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StructureDefinitionSnapshot {
    /// `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>,
    /// `element` (1..*): Definition of elements in the resource (if no StructureDefinition)
    pub element: Vec<ElementDefinition>,
}

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

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

/// Differential view of the structure
///
/// FHIR path: `StructureDefinition.differential`.
#[cfg(feature = "foundation")]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StructureDefinitionDifferential {
    /// `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>,
    /// `element` (1..*): Definition of elements in the resource (if no StructureDefinition)
    pub element: Vec<ElementDefinition>,
}

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

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