Claims
Patch Professional Claim
Applies non-destructive partial updates to an existing professional claim using RFC 6902 Add, Remove, and Replace operations. Shared resources (Patient, Facility, and Provider records) are not modified in-place; to modify those resources directly, use the Patient endpoints or edit them in CAIR directly.
PATCH
Patch an existing professional claim using JSON Patch
Applies partial, non-destructive updates to an existing professional claim using standard RFC 6902 JSON Patch operations (
add, remove, replace).
Use this endpoint when you want to update specific fields on an existing claim—such as adding a service line, updating a diagnosis code, changing a place of service code, or appending a secondary insurance policy—without providing or overwriting the entire claim payload.
Key Principles
- Non-Destructive & Modular: Any field or array not mentioned in your patch operations remains unchanged. Only the sections targeted by your patch operations are validated and updated on the claim.
- Standard RFC 6902 Operations: You can perform
add,remove, andreplaceoperations using standard JSON Pointers. - Array Precision: You can append to arrays (e.g.
/cpt_codes_cms1500s/-), update a specific index (e.g./cpt_codes_cms1500s/0/fee), or remove an individual line (e.g./cpt_codes_cms1500s/1). - Target Matching: The target claim is matched by
id(your Patient Control Number). If no matching claim is found, the endpoint returns a 404 Not Found. - Shared Resources Are Not Mutated In-Place: Patching
patient,service_location(facility), or provider (billing_provider,rendering_provider,ordering_provider,referring_provider) fields on a claim resolves and links the claim to the matching resource (or creates a new one if no match exists), rather than overwriting the existing Patient, Facility, or Provider record. To modify an existing Patient, Facility, or Provider resource itself, use the Patient endpoints (PUT /api/patient/{id}) or edit them in CAIR directly.
Query Parameters
Request Body Structure
Body Fields
JSON Path Reference & Examples for Each Data Element
Every field from the professional claim schema can be targeted via JSON Pointers. Below are example paths and operations for each data element:1. Claim Core & Billing Amounts
2. Service Lines (CPT / HCPCS Codes)
3. Diagnosis Codes (ICD-10)
4. Patient Information & Insurance Policies
Important: The Claim PATCH endpoint does not modify an existing Patient resource’s demographics, contact details, or address in-place (patching/patientresolves/links the claim to a matching patient record). If you want to update a patient’s demographics, phone number, email, or address, use the Patient endpoints (PUT /api/patient/{id}) or edit the patient in CAIR directly.
5. Providers & Service Location
Important: The Claim PATCH endpoint does not modify existing Provider or Facility (Location) records in-place. Patching provider NPIs or facility identifiers re-links the claim’s care team or facility reference to the matching resource (or creates a new Practitioner/Location when no match exists), while claim-level fields liketaxonomy_codeandplace_of_serviceare updated on the claim itself. To modify an existing Provider or Facility resource’s name or address, edit the resource in CAIR directly.
6. Condition Codes & Additional Notes
Complete Example
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Optional ID of document references to associate with the claim. Can be specified multiple times.
Body
application/json
RFC 6902 JSON Patch request for professional claim