Data Model Libraries
    Preparing search index...

    Class PaymentReconciliationDetailComponent

    PaymentReconciliationDetailComponent Class

    FHIR Specification

    • Short: Settlement particulars
    • Definition: Distribution of the payment amount for a previously acknowledged payable.
    • Requirements: Needed to show how the payment amount is distributed across the payables.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier

    PaymentReconciliation.detail.identifier Element

    FHIR Specification

    • Short: Business identifier of the payment detail
    • Definition: Unique identifier for the current payment item for the referenced payable.
    • Requirements: Needed for reconciliation of payments.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    predecessor?: Identifier

    PaymentReconciliation.detail.predecessor Element

    FHIR Specification

    • Short: Business identifier of the prior payment detail
    • Definition: Unique identifier for the prior payment item for the referenced payable.
    • Requirements: Needed for reconciliation of payments.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    type_: null | CodeableConcept

    PaymentReconciliation.detail.type Element

    FHIR Specification

    • Short: Category of payment
    • Definition: Code to indicate the nature of the payment.
    • Comment: For example: payment, adjustment, funds advance, etc.
    • Requirements: Needed to provide context for the amount.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    request?: Reference

    PaymentReconciliation.detail.request Element

    FHIR Specification

    • Short: Request giving rise to the payment
    • Definition: A resource, such as a Claim, the evaluation of which could lead to payment.
    • Requirements: Needed to provide a linkage to the original request.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    submitter?: Reference

    PaymentReconciliation.detail.submitter Element

    FHIR Specification

    response?: Reference

    PaymentReconciliation.detail.response Element

    FHIR Specification

    • Short: Response committing to a payment
    • Definition: A resource, such as a ClaimResponse, which contains a commitment to payment.
    • Requirements: Needed to provide a linkage to the payment commitment.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    date?: DateType

    PaymentReconciliation.detail.date Element

    FHIR Specification

    • Short: Date of commitment to pay
    • Definition: The date from the response resource containing a commitment to pay.
    • Requirements: Needed for audit and validation.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    responsible?: Reference

    PaymentReconciliation.detail.responsible Element

    FHIR Specification

    • Short: Contact for the response
    • Definition: A reference to the individual who is responsible for inquiries regarding the response and its payment.
    • Requirements: To provide contact information.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    payee?: Reference

    PaymentReconciliation.detail.payee Element

    FHIR Specification

    amount?: Money

    PaymentReconciliation.detail.amount Element

    FHIR Specification

    • Short: Amount allocated to this payable
    • Definition: The monetary amount allocated from the total payment to the payable.
    • Requirements: Needed to explain the distribution of the payment to the payables.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PaymentReconciliationDetailComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PaymentReconciliationDetailComponent

      PaymentReconciliationDetailComponent data model or undefined for PaymentReconciliationDetailComponent

      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