fhir 0.1.0

//! ChargeItemDefinition
//!
//! URL: http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition
//!
//! Version: 5.0.0
//!
//! ChargeItemDefinition Resource: The properties that apply to the (billing) codes necessary to calculate costs and prices.
//!
//! 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;

/// The ChargeItemDefinition resource provides the properties that apply to the
/// (billing) codes necessary to calculate costs and prices. The properties may
/// differ largely depending on type and realm, therefore this resource gives
/// only a rough structure and requires profiling for each type of billing code
/// system. It is used to define the applicability rules and the price
/// components (base price, surcharges, discounts, taxes) associated with a
/// billing code or product type.
///
/// ChargeItemDefinition acts as a catalog or master-data entry: it is defined
/// once by a payer, provider, or billing authority and then referenced by
/// individual `ChargeItem` instances at the point of care or invoicing to
/// determine which price components and applicability conditions apply. A
/// definition can be scoped to a specific billing code (via `code`), to
/// particular instances (via `instance`), and can be conditioned on runtime
/// facts through the `applicability` expressions, allowing definitions to
/// vary by context such as payer contract, patient status, or effective
/// period. Definitions may also derive from, or supersede, other definitions
/// via `derived_from_uri`, `part_of`, and `replaces`, supporting versioned
/// and modular billing rule sets.
///
/// # Related resources
///
/// - [`CodeableConcept`](crate::r5::types::CodeableConcept) is used for the
///   `code` and `jurisdiction` elements.
/// - [`Reference`](crate::r5::types::Reference) values in `instance` typically
///   point to `ChargeItem`, `ActivityDefinition`, `PlanDefinition`, or `DeviceDefinition` resources.
/// - The related `ChargeItem` resource records an actual billable event and
///   references a `ChargeItemDefinition` to apply its pricing rules.
///
/// # Examples
///
/// ```
/// use fhir::r5::resources::charge_item_definition::ChargeItemDefinition;
///
/// let value = ChargeItemDefinition::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: ChargeItemDefinition = ::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 ChargeItemDefinition {
    /// 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>,

    /// Language of the resource content
    pub language: Option<types::Code>,

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

    /// Contained, inline Resources
    pub contained: Option<Vec<::serde_json::Value>>,

    /// Additional content defined by implementations
    pub extension: Option<Vec<types::Extension>>,

    /// Extensions that cannot be ignored
    pub modifier_extension: Option<Vec<types::Extension>>,

    /// Canonical identifier for this charge item definition, represented as a URI (globally unique); used to reference this definition from a `ChargeItem`
    pub url: Option<types::Uri>,

    /// Additional identifier for the charge item definition
    pub identifier: Option<Vec<types::Identifier>>,

    /// Business version of the charge item definition
    pub version: Option<types::String>,

    /// How to compare versions
    pub version_algorithm_string: Option<types::String>,

    /// How to compare versions
    pub version_algorithm_coding: Option<types::Coding>,

    /// Name for this charge item definition (computer friendly)
    pub name: Option<types::String>,

    /// Name for this charge item definition (human friendly)
    pub title: Option<types::String>,

    /// Underlying externally-defined charge item definition
    pub derived_from_uri: Option<Vec<types::Uri>>,

    /// A larger definition of which this particular definition is a component or step
    pub part_of: Option<Vec<types::Canonical>>,

    /// Completed or terminated request(s) whose function is taken by this new request
    pub replaces: Option<Vec<types::Canonical>>,

    /// draft | active | retired | unknown
    pub status: types::Code,

    /// For testing purposes, not real usage
    pub experimental: Option<types::Boolean>,

    /// Date last changed
    pub date: Option<types::DateTime>,

    /// Name of the publisher/steward (organization or individual)
    pub publisher: Option<types::String>,

    /// Contact details for the publisher
    pub contact: Option<Vec<types::ContactDetail>>,

    /// Natural language description of the charge item definition
    pub description: Option<types::Markdown>,

    /// The context that the content is intended to support
    pub use_context: Option<Vec<types::UsageContext>>,

    /// Intended jurisdiction for charge item definition (if applicable)
    pub jurisdiction: Option<Vec<types::CodeableConcept>>,

    /// Why this charge item definition is defined
    pub purpose: Option<types::Markdown>,

    /// Use and/or publishing restrictions
    pub copyright: Option<types::Markdown>,

    /// Copyright holder and year(s)
    pub copyright_label: Option<types::String>,

    /// When the charge item definition was approved by publisher
    pub approval_date: Option<types::Date>,

    /// When the charge item definition was last reviewed by the publisher
    pub last_review_date: Option<types::Date>,

    /// Billing code or product type this definition applies to
    pub code: Option<types::CodeableConcept>,

    /// Instances this definition applies to
    pub instance: Option<Vec<types::Reference>>,

    /// Whether or not the billing code is applicable
    pub applicability: Option<Vec<ChargeItemDefinitionApplicability>>,

    /// Group of properties which are applicable under the same conditions
    pub property_group: Option<Vec<ChargeItemDefinitionPropertyGroup>>,
}

/// Expressions that describe applicability criteria for the billing code.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct ChargeItemDefinitionApplicability {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    pub extension: Option<Vec<types::Extension>>,

    /// Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Option<Vec<types::Extension>>,

    /// Boolean-valued expression
    pub condition: Option<types::Expression>,

    /// When the charge item definition is expected to be used
    pub effective_period: Option<types::Period>,

    /// Reference to / quotation of the external source of the group of properties
    pub related_artifact: Option<types::RelatedArtifact>,
}

/// Group of properties which are applicable under the same conditions. If no
/// applicability rules are established for the group, then all properties
/// always apply.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct ChargeItemDefinitionPropertyGroup {
    /// Unique id for inter-element referencing
    pub id: Option<types::String>,

    /// Additional content defined by implementations
    pub extension: Option<Vec<types::Extension>>,

    /// Extensions that cannot be ignored even if unrecognized
    pub modifier_extension: Option<Vec<types::Extension>>,

    /// Conditions under which the priceComponent is applicable
    pub applicability: Option<Vec<ChargeItemDefinitionApplicability>>,

    /// Components of total line item price
    pub price_component: Option<Vec<types::MonetaryComponent>>,
}

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

    #[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);
    }
}