Data Model Libraries
    Preparing search index...

    Class PaymentReconciliation

    PaymentReconciliation Class

    This resource provides the details including amount of a payment and allocates the payment items being paid.

    FHIR Specification

    • Short: PaymentReconciliation resource
    • Definition: This resource provides the details including amount of a payment and allocates the payment items being paid.
    • FHIR Version: 4.0.1

    FHIR PaymentReconciliation

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? fmStatusEnum status period? created paymentIssuer? request? requestor? remittanceOutcomeEnum outcome? disposition? paymentDate paymentAmount paymentIdentifier? detail? formCode? processNote?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getPeriod setPeriod hasPeriod getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getPaymentIssuer setPaymentIssuer hasPaymentIssuer getRequest setRequest hasRequest getRequestor setRequestor hasRequestor getOutcomeEnumType setOutcomeEnumType hasOutcomeEnumType getOutcomeElement setOutcomeElement hasOutcomeElement getOutcome setOutcome hasOutcome getDispositionElement setDispositionElement hasDispositionElement getDisposition setDisposition hasDisposition getPaymentDateElement setPaymentDateElement hasPaymentDateElement getPaymentDate setPaymentDate hasPaymentDate getPaymentAmount setPaymentAmount hasPaymentAmount getPaymentIdentifier setPaymentIdentifier hasPaymentIdentifier getDetail setDetail addDetail hasDetail getFormCode setFormCode hasFormCode getProcessNote setProcessNote addProcessNote hasProcessNote fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initDetail initProcessNote

    Constructors

    Properties

    identifier?: Identifier[]

    PaymentReconciliation.identifier Element

    FHIR Specification

    • Short: Business Identifier for a payment reconciliation
    • Definition: A unique identifier assigned to this payment reconciliation.
    • Requirements: Allows payment reconciliations to be distinguished and referenced.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fmStatusEnum: FmStatusEnum

    FHIR CodeSystem: FmStatus

    FmStatusEnum

    status: null | EnumCodeType

    PaymentReconciliation.status Element

    FHIR Specification

    • Short: active | cancelled | draft | entered-in-error
    • Definition: The status of the resource instance.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • Requirements: Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: FmStatusEnum

    period?: Period

    PaymentReconciliation.period Element

    FHIR Specification

    • Short: Period covered
    • Definition: The period of time for which payments have been gathered into this bulk payment for settlement.
    • Requirements: Needed to allow receivers to monitor and reconcile payment issuer schedules.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    created: null | DateTimeType

    PaymentReconciliation.created Element

    FHIR Specification

    • Short: Creation date
    • Definition: The date when the resource was created.
    • Requirements: Need to record a timestamp for use by both the recipient and the issuer.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    paymentIssuer?: Reference

    PaymentReconciliation.paymentIssuer Element

    FHIR Specification

    • Short: Party generating payment
    • Definition: The party who generated the payment.
    • Comment: This party is also responsible for the reconciliation.
    • Requirements: Need to identify the party resonsible for the payment and this resource.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    request?: Reference

    PaymentReconciliation.request Element

    FHIR Specification

    • Short: Reference to requesting resource
    • Definition: Original request resource reference.
    • Requirements: Needed to allow the response to be linked to the request.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requestor?: Reference

    PaymentReconciliation.requestor Element

    FHIR Specification

    remittanceOutcomeEnum: RemittanceOutcomeEnum

    FHIR CodeSystem: RemittanceOutcome

    RemittanceOutcomeEnum

    outcome?: EnumCodeType

    PaymentReconciliation.outcome Element

    FHIR Specification

    • Short: queued | complete | error | partial
    • Definition: The outcome of a request for a reconciliation.
    • Comment: The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).
    • Requirements: To advise the requestor of an overall processing outcome.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RemittanceOutcomeEnum

    disposition?: StringType

    PaymentReconciliation.disposition Element

    FHIR Specification

    • Short: Disposition message
    • Definition: A human readable description of the status of the request for the reconciliation.
    • Requirements: Provided for user display.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    paymentDate: null | DateType

    PaymentReconciliation.paymentDate Element

    FHIR Specification

    • Short: When payment issued
    • Definition: The date of payment as indicated on the financial instrument.
    • Requirements: To advise the payee when payment can be expected.
    • FHIR Type: date
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    paymentAmount: null | Money

    PaymentReconciliation.paymentAmount Element

    FHIR Specification

    • Short: Total amount of Payment
    • Definition: Total payment amount as indicated on the financial instrument.
    • Requirements: Needed to provide the actual payment amount.
    • FHIR Type: Money
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    paymentIdentifier?: Identifier

    PaymentReconciliation.paymentIdentifier 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 is received.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    detail?: PaymentReconciliationDetailComponent[]

    PaymentReconciliation.detail Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    formCode?: CodeableConcept

    PaymentReconciliation.formCode Element

    FHIR Specification

    • Short: Printed form identifier
    • Definition: A code for the form to be used for printing the content.
    • Comment: May be needed to identify specific jurisdictional forms.
    • Requirements: Needed to specify the specific form used for producing output for this response.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    processNote?: PaymentReconciliationProcessNoteComponent[]

    PaymentReconciliation.processNote Element

    FHIR Specification

    • Short: Note concerning processing
    • Definition: A note that describes or explains the processing in a human readable form.
    • Requirements: Provides the specific textual explanations associated with the processing.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PaymentReconciliation

      • OptionaloptSourceField: string

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

      Returns undefined | PaymentReconciliation

      PaymentReconciliation data model or undefined for PaymentReconciliation

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetPeriodsetPeriodhasPeriodgetCreatedElementsetCreatedElementhasCreatedElementgetCreatedsetCreatedhasCreatedgetPaymentIssuersetPaymentIssuerhasPaymentIssuergetRequestsetRequesthasRequestgetRequestorsetRequestorhasRequestorgetOutcomeEnumTypesetOutcomeEnumTypehasOutcomeEnumTypegetOutcomeElementsetOutcomeElementhasOutcomeElementgetOutcomesetOutcomehasOutcomegetDispositionElementsetDispositionElementhasDispositionElementgetDispositionsetDispositionhasDispositiongetPaymentDateElementsetPaymentDateElementhasPaymentDateElementgetPaymentDatesetPaymentDatehasPaymentDategetPaymentAmountsetPaymentAmounthasPaymentAmountgetPaymentIdentifiersetPaymentIdentifierhasPaymentIdentifiergetDetailsetDetailaddDetailhasDetailgetFormCodesetFormCodehasFormCodegetProcessNotesetProcessNoteaddProcessNotehasProcessNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitDetailinitProcessNote