CAcairhealth

PATCH /api/patient-payments/claims/{claimControlNumber}

Changed on

Absolutely set patient payment by claim control number (claim-id). Caps at ledger paid + remaining PATIENT_AR; excess is unallocated PATIENT_CASH. paymentTraceId is required; retries return the prior result. 404 if the claim is not found.

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}
  • Auth
    none required

Path parameters

claimControlNumberstring required

Claim control number (https://fhir.cairhealth.com/fhir/identifier/claim-id)

Request body

paymentAmountnumber required

Absolute paid amount to set

paymentDatestring date
paymentMethodstring
paymentTraceIdstring required

Required processor transaction id for idempotent retries

notesstring

Required when decreasing paid (refund)

Response

Payment updated (or idempotent replay)

Changes