Data Model Libraries
    Preparing search index...

    AccountCoverageComponent Class

    FHIR Specification

    • Short: The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
    • Definition: The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
    • Comment: Typically. this may be some form of insurance, internal charges, or self-pay. Local or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order. Where the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    coverage: null | Reference

    Account.coverage.coverage Element

    FHIR Specification

    • Short: The party(s), such as insurances, that may contribute to the payment of this account
    • Definition: The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    priority?: PositiveIntType

    Account.coverage.priority Element

    FHIR Specification

    • Short: The priority of the coverage in the context of this account
    • Definition: The priority of the coverage in the context of this account.
    • Comment: It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AccountCoverageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AccountCoverageComponent

      AccountCoverageComponent data model or undefined for AccountCoverageComponent

      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