Data Model Libraries
    Preparing search index...

    Class ExplanationOfBenefitPaymentComponent

    ExplanationOfBenefitPaymentComponent Class

    FHIR Specification

    • Short: Payment Details
    • Definition: Payment details for the adjudication of the claim.
    • Requirements: Needed to convey references to the financial instrument that has been used if payment has been made.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ExplanationOfBenefit.payment.type Element

    FHIR Specification

    • Short: Partial or complete payment
    • Definition: Whether this represents partial or complete payment of the benefits payable.
    • Requirements: To advise the requestor when the insurer believes all payments to have been completed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    adjustment?: Money

    ExplanationOfBenefit.payment.adjustment Element

    FHIR Specification

    • Short: Payment adjustment for non-claim issues
    • Definition: Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.
    • Comment: Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.
    • Requirements: To advise the requestor of adjustments applied to the payment.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    adjustmentReason?: CodeableConcept

    ExplanationOfBenefit.payment.adjustmentReason Element

    FHIR Specification

    • Short: Explanation for the variance
    • Definition: Reason for the payment adjustment.
    • Requirements: Needed to clarify the monetary adjustment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    date?: DateType

    ExplanationOfBenefit.payment.date Element

    FHIR Specification

    • Short: Expected date of payment
    • Definition: Estimated date the payment will be issued or the actual issue date of payment.
    • Requirements: To advise the payee when payment can be expected.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount?: Money

    ExplanationOfBenefit.payment.amount Element

    FHIR Specification

    • Short: Payable amount after adjustment
    • Definition: Benefits payable less any payment adjustment.
    • Requirements: Needed to provide the actual payment amount.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier

    ExplanationOfBenefit.payment.identifier Element

    FHIR Specification

    • Short: Business identifier for the payment
    • Definition: Issuer's unique identifier for the payment instrument.
    • Comment: For example: EFT number or check number.
    • Requirements: Enable the receiver to reconcile when payment received.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExplanationOfBenefitPaymentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExplanationOfBenefitPaymentComponent

      ExplanationOfBenefitPaymentComponent data model or undefined for ExplanationOfBenefitPaymentComponent

      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