Claims

Insurance claims billed to Medicaid, Medicare and other payers, with their adjudication status. Read-only.

Endpoints

The Claim object

object
stringread-only

String representing the object's type. Always claim.

id
stringread-only

Unique identifier of the claim.

patientId
string | nullread-onlymax length 64

The patient the claim is for.

caregiverId
string | nullread-onlymax length 64

The caregiver who provided the service.

visitId
string | nullread-onlymax length 64

The visit billed, for single-visit claims.

invoiceId
string | nullread-onlymax length 64

The related invoice, if any.

claimNumber
string | nullread-onlymax length 2000

Your claim number.

claimType
string | nullread-only

Claim format: professional (837P) or institutional (837I).

One ofProfessional837PInstitutional837Inull
payerName
string | nullread-onlymax length 2000

The payer billed.

payerId
string | nullread-onlymax length 2000

The payer's electronic payer ID.

serviceDateStart
string | nullread-onlymax length 2000

First date of service, as YYYY-MM-DD.

serviceDateEnd
string | nullread-onlymax length 2000

Last date of service, as YYYY-MM-DD.

totalChargeAmountCents
integer | nullread-only

Total billed. In cents.

status
string | nullread-only

Where the claim is in adjudication.

One ofDraftValidatedValidationFailedSubmittedAcknowledgedAcceptedRejectedInAdjudicationPaidPartiallyPaidDeniedAppealedVoidednull
statusMessage
string | nullread-onlymax length 20000

Latest status detail from the payer or clearinghouse.

statusUpdatedAt
string | nullread-onlymax length 2000

When the status last changed, ISO 8601.

paidAmountCents
integer | nullread-only

Amount the payer paid. In cents.

patientResponsibilityCents
integer | nullread-only

Amount the patient owes after the payer. In cents.

priorAuthNumber
string | nullread-onlymax length 2000

Authorization number sent on the claim.

checkNumber
string | nullread-onlymax length 2000

Payment check or EFT trace number.

submittedAt
string | nullread-onlymax length 2000

When the claim was submitted, ISO 8601.

createdAt
string · date-time | nullread-only

When the claim was created.

updatedAt
string · date-time | nullread-only

When the claim was last changed.