Skip to main content
POST
Create a claim
This is an async operation. The endpoint returns 202 Accepted immediately after queuing the claim, and a webhook event is sent to your registered endpoint once the claim has been created (or has failed) in the EMR.

Request Parameters

Required Fields

  • appointment_id (string, required): The Cobalt appointment ID to create a claim for. The appointment must belong to the authenticated user and have an associated EMR appointment ID.

Example Request

Example Response

The response includes:
  • claim_id: Unique identifier for the queued claim record. Use this to correlate the eventual webhook event.
  • appointment_id: Echo of the appointment the claim was queued against.
  • job_id: Job execution identifier for tracking the async operation.

Error Responses

Missing Required Field

Invalid Appointment ID Format

Appointment Missing EMR ID

Returned if the appointment exists but has not yet been synced with an emr_appointment_id.

Appointment Not Found

Duplicate Claim

Returned if a claim for this appointment is already in-flight (pending_create) or has already been completed. Failed claims do not block retries.

Webhook Notifications

When the claim creation is complete, we will send a webhook to your registered endpoint. Here are examples of what those webhook payloads will look like:

Success

Failure

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Body

application/json
appointment_id
string
required

Cobalt appointment ID (UUID, with or without dashes) to create the claim for. The appointment must belong to the caller and have an emr_appointment_id.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"

callback_urls
string[]

URLs to receive the completion webhook for this claim, in addition to the account webhook.

Example:

Response

Claim creation queued

success
boolean
required
message
string
required
claim_id
string
required
appointment_id
string
required
job_id
required