Data Model Libraries
    Preparing search index...

    AccountBalanceComponent Class

    FHIR Specification

    • Short: Calculated account balance(s)
    • Definition: The calculated account balances - these are calculated and processed by the finance system. The balances with a term that is not current are usually generated/updated by an invoicing or similar process.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    aggregate?: CodeableConcept

    Account.balance.aggregate Element

    FHIR Specification

    • Short: Who is expected to pay this part of the balance
    • Definition: Who is expected to pay this part of the balance.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Account.balance.term Element

    FHIR Specification

    • Short: current | 30 | 60 | 90 | 120
    • Definition: The term of the account balances - The balance value is the amount that was outstanding for this age.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    estimate?: BooleanType

    Account.balance.estimate Element

    FHIR Specification

    • Short: Estimated balance
    • Definition: The amount is only an estimated value - this is likely common for current term balances, but not with known terms (that were generated by a backend process).
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount: null | Money

    Account.balance.amount Element

    FHIR Specification

    • Short: Calculated amount
    • Definition: The actual balance value calculated for the age defined in the term property.
    • FHIR Type: Money
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AccountBalanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AccountBalanceComponent

      AccountBalanceComponent data model or undefined for AccountBalanceComponent

      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