Actions

45 actions

Action

Description

Create Appointment

Create a pre-encounter appointment for a patient with scheduling and eligibility metadata.

List Visits

List appointment visits within a date range with pagination and sorting.

Get Appointment

Retrieve a single appointment by its Candid appointment ID.

Update Appointment

Update an appointment using optimistic concurrency via the next version number.

Create Charge Capture

Create a charge capture holding pre-billing charge data before encounter submission.

List Charge Captures

List charge captures filtered by patient, bundle, status, service dates, or provider.

Update Charge Capture

Update charge capture data or bundle assignment before aggregation.

Get Charge Capture

Retrieve a single charge capture by its Candid charge capture ID.

Create Coverage

Create an insurance coverage record for a patient with payer, plan, subscriber, and benefits data.

Update Coverage

Update a coverage record using optimistic concurrency via the next version number.

List Coverages

List coverages filtered by patient, payer, and status with cursor pagination.

Get Coverage

Retrieve a single coverage record by its Candid coverage ID.

Create Diagnosis

Attach an ICD diagnosis code to an existing encounter.

Update Diagnosis

Update an existing diagnosis code, code type, name, or POA indicator.

Run Eligibility Check

Submit a real-time 270/271 eligibility check to a payer via Stedi.

Submit Eligibility Batch

Submit a batch of eligibility checks to payers for asynchronous processing.

List Encounters

List professional encounters filtered by status, dates, patient, provider, payer, and more.

Create Encounter

Create a professional encounter (claim) with patient, providers, diagnoses, and service lines.

Get Encounter

Retrieve a single encounter (claim) with its providers, diagnoses, and service lines.

Update Encounter

Update fields on an existing encounter (claim), including status, providers, and billing metadata.

Get Claim Exports

Fetch CSV export files of claim version changes within a date window.

Get Insurance Adjudication

Retrieve a single insurance adjudication (ERA/EOB posting) by its Candid ID.

List Insurance Refunds

List insurance refunds filtered by payer, service line, claim, or billing provider.

Create Insurance Refund

Post an insurance refund with allocations to service lines, claims, or billing provider unattributed cash.

Get Insurance Refund

Retrieve a single insurance refund and its allocations by refund ID.

Update Insurance Refund

Update an insurance refund's amount, timestamp, notes, or allocations.

Create Patient

Create a pre-encounter patient with demographics, contacts, guarantors, and other administrative data.

Search Patients

Search patients by MRN or other identifier fields.

List Patients

List patients with cursor pagination, sort, filters, and free-text search.

Get Patient

Retrieve a single patient by their Candid patient ID.

Update Patient

Update a patient record using optimistic concurrency via the next version number.

Deactivate Patient

Deactivate (soft-delete) a patient using optimistic concurrency via the next version number.

Get Payer

Retrieve a single payer from Candid's canonical payer list by its UUID.

List Payers

List all payers on Candid's canonical payer list with optional name search.

Create Service Line

Add a service line (CPT/HCPCS code) with charges and diagnosis pointers to an encounter.

Update Service Line

Update an existing service line's code, modifiers, units, charge, or diagnosis pointers.

Delete Service Line

Remove a service line from its encounter by service line ID.

List Tasks

List billing operations tasks filtered by status, category, assignee, or encounter.

Create Task

Create a billing operations task tied to an encounter with type, category, and assignee.

Get Task

Retrieve a single task with its notes, status history, and encounter reference.

Update Task

Update a task's status, assignee, notes, or blocking reasons.

List Write-Offs

List write-offs filtered by payer, claim, service line, billing provider, or account type.

Create Write-Offs

Post one or more write-offs applied to a service line, claim, or billing provider.

Get Write-Off

Retrieve a single write-off record by its Candid write-off ID.

Revert Write-Off

Reverse a previously posted write-off, restoring the balance on its target.