Skip to main content

​
clinik.paymentNotices

Payment Notices (FHIR PaymentNotice) communicate payment status information between payers and providers. Use them to notify recipients about payment events tied to a PaymentReconciliation.

​
create

const { data, meta } = await clinik.paymentNotices.create(request): Promise<ApiResponse<PaymentNotice>>
FieldTypeRequiredDescription
statusstringYesactive, cancelled, draft
createdstringNoWhen created (defaults to now)
providerIdstringNoPractitioner/Organization reference
paymentIdstringYesPaymentReconciliation ID
paymentDatestringNoDate of payment
payeeIdstringNoPractitioner/Organization reference
recipientIdstringYesRecipient Organization ID
amount{ value, currency? }YesPayment amount
paymentStatusstringNoe.g. paid, cleared
requestIdstringNoReference to any request
responseIdstringNoReference to any response

​
Example

const { data } = await clinik.paymentNotices.create({
  status: 'active',
  paymentId: 'pmtrec_abc123',
  recipientId: 'org_ins456',
  amount: { value: 1250.00, currency: 'USD' },
  paymentDate: '2024-03-15',
  paymentStatus: 'paid',
  providerId: 'Practitioner/prac_dr789',
});
Same pattern as other resources. Update supports status, paymentStatus. Search supports status, dateFrom, dateTo, providerId filters.