Skip to main content

​
clinik.paymentReconciliations

Payment Reconciliations (FHIR PaymentReconciliation) provide detailed payment settlement information from payers to providers, including line-item breakdowns and processing notes.

​
create

const { data, meta } = await clinik.paymentReconciliations.create(request): Promise<ApiResponse<PaymentReconciliation>>
FieldTypeRequiredDescription
statusstringYesactive, cancelled, draft
createdstringNoWhen created (defaults to now)
paymentIssuerIdstringNoIssuing Organization ID
requestIdstringNoTask ID
requestorIdstringNoPractitioner/Organization reference
outcomestringNoqueued, complete, error, partial
dispositionstringNoDisposition message
paymentDatestringYesDate of payment
paymentAmount{ value, currency? }YesTotal payment amount
period{ start?, end? }NoPeriod covered
detailArrayNoPayment detail lines
processNoteArrayNoProcessing notes

​
Detail Object

FieldTypeRequiredDescription
typestringYesDetail type
requestIdstringNoRequest reference
submitterIdstringNoSubmitter reference
payeeIdstringNoPayee reference
datestringNoDetail date
amount{ value, currency? }NoDetail amount

​
Example

const { data } = await clinik.paymentReconciliations.create({
  status: 'active',
  paymentDate: '2024-03-15',
  paymentAmount: { value: 1250.00, currency: 'USD' },
  paymentIssuerId: 'org_ins456',
  outcome: 'complete',
  disposition: 'Payment processed successfully',
  period: { start: '2024-03-01', end: '2024-03-31' },
  detail: [
    {
      type: 'payment',
      date: '2024-03-15',
      amount: { value: 800.00, currency: 'USD' },
      payeeId: 'Practitioner/prac_dr789',
    },
    {
      type: 'adjustment',
      date: '2024-03-15',
      amount: { value: 450.00, currency: 'USD' },
    },
  ],
  processNote: [
    { type: 'display', text: 'Claim #CLM-2024-001 settled in full' },
  ],
});
Same pattern as other resources. Update supports status, disposition, outcome. Search supports status, dateFrom, dateTo, outcome filters.