Data Model Libraries
    Preparing search index...

    Class ChargeItemDefinitionPropertyGroupComponent

    ChargeItemDefinitionPropertyGroupComponent Class

    FHIR Specification

    • Short: Group of properties which are applicable under the same conditions
    • Definition: Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ChargeItemDefinition.propertyGroup.applicability Element

    FHIR Specification

    • Short: Conditions under which the priceComponent is applicable
    • Definition: Expressions that describe applicability criteria for the priceComponent.
    • Comment: The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    priceComponent?: MonetaryComponent[]

    ChargeItemDefinition.propertyGroup.priceComponent Element

    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.
    • FHIR Type: MonetaryComponent
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ChargeItemDefinitionPropertyGroupComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ChargeItemDefinitionPropertyGroupComponent

      ChargeItemDefinitionPropertyGroupComponent data model or undefined for ChargeItemDefinitionPropertyGroupComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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