Claims

Fetch a List of Claims

Get list of Claims for Insurer or hospital

get/v1/claims

Request

  • Base URL: https://api.health.curacel.co/api
  • URL: https://api.health.curacel.co/api/v1/claims
  • Auth: HTTP bearer

Query parameters

status'approved' | 'pending' | 'rejected' | 'partially_approved'

The status of the claim.

Note: 'partially_approved' points to claims that have been approved but whose approved amount is less than the total amount.

with_fieldsstring

When present, value should be comma seperated names of field the user would like returned with the response.

is_submittedboolean

This parameter is applicable to Providers/Hospitals only. It filters the claims based on if they have been submitted or drafted claims. Returns all claims when absent.

is_vettedboolean

This parameter is used to filter the claims based on if they have been vetted or not.

is_syncedboolean

This parameter is used to filter the claims based on if they have been synced with external db or not.

insurer_idinteger

Applicable if fetching list as a provider/hospital

The ID of the Insurer that owns the created claims.

provider_idinteger

Applicable if fetching list as an Insurer

The ID of the hospital that created the claims

enrollee_idinteger

The ID of the enrollee the claims were created for.

client_idinteger

The ID of the client linked to enrollees whose claims should be returned.

insurance_nostring

The insurance number of the enrollee the claims were created for. This is only considered when no value is provided for enrollee_id

OR
string date

Filter returned claims by the creation date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

OR
string date

Filter returned claims by the submission date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

OR
string date

Filter returned claims by the vetting date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

OR
string date

Filter returned claims by the encounter date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

OR
string date

Filter returned claims by the synced date if available.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

OR
string date

Filter returned claims by the last updated date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values. Setting it to a single date string also filters the claims with a direct comparison to the value given.

updated_fromstring date-time

Return only claims strictly after this updated_at timestamp. Useful for incremental sync. Note: results are ordered by updated_at and limited internally to protect performance.

pageinteger

The presence of this param would return results in paginated format Better used together with the 'per_page' param

This is used to indicate the offset from which results are fetched in paginated format.

per_pageinteger

Better used together with the 'page' param

This is used to indicate the how many results are to be in an offset for pagination.

for_exportboolean

Used to fetch an exported list of Claims requests in Excel format. Can be used in conjunction with other filters to achieve results.

searchstring

This is used to search for claims by the key word supplied to it.

The search is applied to the enrollee firstname, lastname, and insurance number as well as diagnoses icd codes and names.

Response

Success

pageinteger
per_pageinteger
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.