Data Model Libraries
    Preparing search index...

    Class ChargeItemDefinitionPropertyGroupPriceComponentComponent

    ChargeItemDefinitionPropertyGroupPriceComponentComponent Class

    FHIR Specification

    • Short: Components of total line item price
    • Definition: The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    invoicePriceComponentTypeEnum: InvoicePriceComponentTypeEnum

    FHIR CodeSystem: InvoicePriceComponentType

    type_: null | EnumCodeType

    ChargeItemDefinition.propertyGroup.priceComponent.type Element

    FHIR Specification

    • Short: base | surcharge | deduction | discount | tax | informational
    • Definition: This code identifies the type of the component.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: InvoicePriceComponentTypeEnum

    ChargeItemDefinition.propertyGroup.priceComponent.code Element

    FHIR Specification

    • Short: Code identifying the specific component
    • Definition: A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    factor?: DecimalType

    ChargeItemDefinition.propertyGroup.priceComponent.factor Element

    FHIR Specification

    • Short: Factor used for calculating this component
    • Definition: The factor that has been applied on the base price for calculating this component.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount?: Money

    ChargeItemDefinition.propertyGroup.priceComponent.amount Element

    FHIR Specification

    • Short: Monetary amount associated with this component
    • Definition: The amount calculated for this component.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ChargeItemDefinitionPropertyGroupPriceComponentComponent JSON to instantiate the ChargeItemDefinitionPropertyGroupPriceComponentComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ChargeItemDefinitionPropertyGroupPriceComponentComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ChargeItemDefinitionPropertyGroupPriceComponentComponent

      Returns undefined | ChargeItemDefinitionPropertyGroupPriceComponentComponent

      ChargeItemDefinitionPropertyGroupPriceComponentComponent data model or undefined for ChargeItemDefinitionPropertyGroupPriceComponentComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise