fhir 1.0.0

//! StructureDefinition
//!
//! URL: http://hl7.org/fhir/StructureDefinition/StructureDefinition
//!
//! Version: 5.0.0
//!
//! StructureDefinition Resource: A definition of a FHIR structure.
//!
//! FHIR: <https://build.fhir.org/>
//!
//! UML: <https://build.fhir.org/uml.html>

// Allow unused crate::r5::types as types;
#![allow(unused_imports)]

use crate::r5::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::Validate;

/// 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. StructureDefinition is a core piece of FHIR
/// conformance tooling: profiles, extensions, and logical models are all
/// expressed as StructureDefinition resources, holding both the snapshot and
/// differential views of the elements they define or constrain.
///
/// A StructureDefinition may describe a base resource or data type shipped
/// with the specification, or it may constrain and specialize an existing
/// definition to create a profile (for example, a national or organizational
/// profile on [`Patient`](crate::r5::resources::patient::Patient)) or to
/// define a reusable extension. Tooling such as validators, code generators,
/// and implementation guide publishers consume StructureDefinition resources
/// to understand the cardinality, data types, terminology bindings, and
/// invariants that apply to each element of a resource or type. The
/// `snapshot` element gives the fully expanded set of elements, while the
/// `differential` element records only the elements that differ from the
/// base definition referenced by `base_definition`.
///
/// See also: `ElementDefinition` for individual element constraints, and
/// [`CodeableConcept`](crate::r5::types::CodeableConcept) which is commonly
/// used in `jurisdiction` and similar coded fields.
///
/// # Examples
///
/// ```
/// use fhir::r5::resources::structure_definition::StructureDefinition;
///
/// let value = StructureDefinition::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: StructureDefinition = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct StructureDefinition {
    /// Logical id of this artifact
    pub id: Option<types::String>,

    /// Metadata about the resource
    pub meta: Option<types::Meta>,

    /// A set of rules under which this content was created
    pub implicit_rules: Option<types::Uri>,
    /// Primitive extension sibling for [`implicit_rules`](Self::implicit_rules) (FHIR `_implicitRules`).
    #[serde(rename = "_implicitRules")]
    pub implicit_rules_ext: Option<types::Element>,

    /// Language of the resource content
    pub language: Option<types::Code>,
    /// Primitive extension sibling for [`language`](Self::language) (FHIR `_language`).
    #[serde(rename = "_language")]
    pub language_ext: Option<types::Element>,

    /// Text summary of the resource, for human interpretation
    pub text: Option<types::Narrative>,

    /// Contained, inline Resources
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub contained: Vec<::serde_json::Value>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// Canonical identifier for this structure definition, represented as a URI (globally unique); used to reference this definition from other resources
    pub url: types::Uri,
    /// Primitive extension sibling for [`url`](Self::url) (FHIR `_url`).
    #[serde(rename = "_url")]
    pub url_ext: Option<types::Element>,

    /// Additional identifier for the structure definition
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub identifier: Vec<types::Identifier>,

    /// Business version of the structure definition
    pub version: Option<types::String>,
    /// Primitive extension sibling for [`version`](Self::version) (FHIR `_version`).
    #[serde(rename = "_version")]
    pub version_ext: Option<types::Element>,

    /// The `StructureDefinition.versionAlgorithm[x]` choice element (0..1); see [`StructureDefinitionVersionAlgorithm`].
    #[serde(flatten)]
    pub version_algorithm: Option<StructureDefinitionVersionAlgorithm>,

    /// Name for this structure definition (computer friendly)
    pub name: types::String,
    /// Primitive extension sibling for [`name`](Self::name) (FHIR `_name`).
    #[serde(rename = "_name")]
    pub name_ext: Option<types::Element>,

    /// Name for this structure definition (human friendly)
    pub title: Option<types::String>,
    /// Primitive extension sibling for [`title`](Self::title) (FHIR `_title`).
    #[serde(rename = "_title")]
    pub title_ext: Option<types::Element>,

    /// draft | active | retired | unknown; governs whether the definition is usable in production
    pub status: crate::r5::coded::Coded<crate::r5::codes::PublicationStatus>,
    /// Primitive extension sibling for [`status`](Self::status) (FHIR `_status`).
    #[serde(rename = "_status")]
    pub status_ext: Option<types::Element>,

    /// For testing purposes, not real usage
    pub experimental: Option<types::Boolean>,
    /// Primitive extension sibling for [`experimental`](Self::experimental) (FHIR `_experimental`).
    #[serde(rename = "_experimental")]
    pub experimental_ext: Option<types::Element>,

    /// Date last changed
    pub date: Option<types::DateTime>,
    /// Primitive extension sibling for [`date`](Self::date) (FHIR `_date`).
    #[serde(rename = "_date")]
    pub date_ext: Option<types::Element>,

    /// Name of the publisher/steward (organization or individual)
    pub publisher: Option<types::String>,
    /// Primitive extension sibling for [`publisher`](Self::publisher) (FHIR `_publisher`).
    #[serde(rename = "_publisher")]
    pub publisher_ext: Option<types::Element>,

    /// Contact details for the publisher
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub contact: Vec<types::ContactDetail>,

    /// Natural language description of the structure definition
    pub description: Option<types::Markdown>,
    /// Primitive extension sibling for [`description`](Self::description) (FHIR `_description`).
    #[serde(rename = "_description")]
    pub description_ext: Option<types::Element>,

    /// The context that the content is intended to support
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub use_context: Vec<types::UsageContext>,

    /// Intended jurisdiction for structure definition (if applicable)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub jurisdiction: Vec<types::CodeableConcept>,

    /// Why this structure definition is defined
    pub purpose: Option<types::Markdown>,
    /// Primitive extension sibling for [`purpose`](Self::purpose) (FHIR `_purpose`).
    #[serde(rename = "_purpose")]
    pub purpose_ext: Option<types::Element>,

    /// Use and/or publishing restrictions
    pub copyright: Option<types::Markdown>,
    /// Primitive extension sibling for [`copyright`](Self::copyright) (FHIR `_copyright`).
    #[serde(rename = "_copyright")]
    pub copyright_ext: Option<types::Element>,

    /// Copyright holder and year(s)
    pub copyright_label: Option<types::String>,
    /// Primitive extension sibling for [`copyright_label`](Self::copyright_label) (FHIR `_copyrightLabel`).
    #[serde(rename = "_copyrightLabel")]
    pub copyright_label_ext: Option<types::Element>,

    /// Assist with indexing and finding
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub keyword: Vec<types::Coding>,

    /// FHIR Version this StructureDefinition targets
    pub fhir_version: Option<types::Code>,
    /// Primitive extension sibling for [`fhir_version`](Self::fhir_version) (FHIR `_fhirVersion`).
    #[serde(rename = "_fhirVersion")]
    pub fhir_version_ext: Option<types::Element>,

    /// External specification that the content is mapped to
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub mapping: Vec<StructureDefinitionMapping>,

    /// primitive-type | complex-type | resource | logical; the category of definition this represents
    pub kind: crate::r5::coded::Coded<crate::r5::codes::StructureDefinitionKind>,
    /// Primitive extension sibling for [`kind`](Self::kind) (FHIR `_kind`).
    #[serde(rename = "_kind")]
    pub kind_ext: Option<types::Element>,

    /// Whether this definition is abstract and cannot be instantiated directly
    pub r#abstract: types::Boolean,
    /// Primitive extension sibling for [`abstract`](Self::r#abstract) (FHIR `_abstract`).
    #[serde(rename = "_abstract")]
    pub abstract_ext: Option<types::Element>,

    /// If an extension, where it can be used in instances
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub context: Vec<StructureDefinitionContext>,

    /// FHIRPath invariants - when the extension can be used
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub context_invariant: Vec<types::String>,
    /// Primitive extension sibling for [`context_invariant`](Self::context_invariant) (FHIR `_contextInvariant`).
    #[serde(rename = "_contextInvariant")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub context_invariant_ext: Vec<Option<types::Element>>,

    /// Type defined or constrained by this structure
    pub r#type: types::Uri,
    /// Primitive extension sibling for [`type`](Self::r#type) (FHIR `_type`).
    #[serde(rename = "_type")]
    pub type_ext: Option<types::Element>,

    /// Canonical URL of the base definition that this type is constrained or specialized from
    pub base_definition: Option<types::Canonical>,
    /// Primitive extension sibling for [`base_definition`](Self::base_definition) (FHIR `_baseDefinition`).
    #[serde(rename = "_baseDefinition")]
    pub base_definition_ext: Option<types::Element>,

    /// specialization | constraint - How relates to base definition
    pub derivation: Option<crate::r5::coded::Coded<crate::r5::codes::TypeDerivationRule>>,
    /// Primitive extension sibling for [`derivation`](Self::derivation) (FHIR `_derivation`).
    #[serde(rename = "_derivation")]
    pub derivation_ext: Option<types::Element>,

    /// Snapshot view listing the full, expanded set of elements for the structure
    pub snapshot: Option<StructureDefinitionSnapshot>,

    /// Differential view listing only the elements that differ from the base definition
    pub differential: Option<StructureDefinitionDifferential>,
}

/// External specification that the content is mapped to.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct StructureDefinitionMapping {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored even if unrecognized
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// Internal id when this mapping is used
    pub identity: types::Id,
    /// Primitive extension sibling for [`identity`](Self::identity) (FHIR `_identity`).
    #[serde(rename = "_identity")]
    pub identity_ext: Option<types::Element>,

    /// Identifies what this mapping refers to
    pub uri: Option<types::Uri>,
    /// Primitive extension sibling for [`uri`](Self::uri) (FHIR `_uri`).
    #[serde(rename = "_uri")]
    pub uri_ext: Option<types::Element>,

    /// Names what this mapping refers to
    pub name: Option<types::String>,
    /// Primitive extension sibling for [`name`](Self::name) (FHIR `_name`).
    #[serde(rename = "_name")]
    pub name_ext: Option<types::Element>,

    /// Versions, Issues, Scope limitations etc
    pub comment: Option<types::String>,
    /// Primitive extension sibling for [`comment`](Self::comment) (FHIR `_comment`).
    #[serde(rename = "_comment")]
    pub comment_ext: Option<types::Element>,
}

/// If an extension, where it can be used in instances.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct StructureDefinitionContext {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored even if unrecognized
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// fhirpath | element | extension
    pub r#type: crate::r5::coded::Coded<crate::r5::codes::ExtensionContextType>,
    /// Primitive extension sibling for [`type`](Self::r#type) (FHIR `_type`).
    #[serde(rename = "_type")]
    pub type_ext: Option<types::Element>,

    /// Where the extension can be used in instances
    pub expression: types::String,
    /// Primitive extension sibling for [`expression`](Self::expression) (FHIR `_expression`).
    #[serde(rename = "_expression")]
    pub expression_ext: Option<types::Element>,
}

/// Snapshot view of the structure.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct StructureDefinitionSnapshot {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored even if unrecognized
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// Definition of elements in the resource (if no StructureDefinition)
    pub element: vec1::Vec1<types::ElementDefinition>,
}

/// Differential view of the structure.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct StructureDefinitionDifferential {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub extension: Vec<types::Extension>,

    /// Extensions that cannot be ignored even if unrecognized
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub modifier_extension: Vec<types::Extension>,

    /// Definition of elements in the resource (if no StructureDefinition)
    pub element: vec1::Vec1<types::ElementDefinition>,
}

#[cfg(test)]
mod tests {
    use super::*;
    type T = StructureDefinition;

    #[test]
    fn test_default() {
        let _ = T::default();
    }

    #[test]
    fn test_serde_round_trip() {
        let value = T::default();
        let json = ::serde_json::to_value(&value).expect("to_value");
        let back: T = ::serde_json::from_value(json).expect("from_value");
        assert_eq!(value, back);
    }
}
/// The `StructureDefinition.versionAlgorithm[x]` choice element (see spec/11-choice-types.md).
#[derive(Debug, Clone, PartialEq, Eq, fhir_derive_macros::FhirChoice, Validate)]
#[allow(clippy::large_enum_variant)]
pub enum StructureDefinitionVersionAlgorithm {
    /// `versionAlgorithmString` variant.
    #[fhir("versionAlgorithmString")]
    String(crate::r5::choice::Primitive<types::String>),
    /// `versionAlgorithmCoding` variant.
    #[fhir("versionAlgorithmCoding")]
    Coding(Box<types::Coding>),
}