API ReferenceCharge CaptureV1

Get all Charge Captures

Beta

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional
Maximum number of entities per page, defaults to 100.
sortenumOptional

Defaults to created_at

Allowed values:
sort_directionenumOptional
Sort direction. Defaults to descending order if not provided.
Allowed values:
page_tokenstringOptional
patient_external_idstringOptional
The patient ID from the external EMR platform for the patient
statusenumOptional
the status of the charge captures
Allowed values:
charge_external_idstringOptional

A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

date_of_service_mindateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

date_of_service_maxdateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

claim_idsUUIDOptional
A list of claim IDs to filter by. This will return all charge captures that have a resulting claim with one of the IDs in this list.
claim_creation_idsUUIDOptional
A list of Claim Creation IDs to filter by.
billing_provider_npisstringOptional
A list of billing provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list.
service_facility_namestringOptional
A string to filter by. This will return all charge captures with this service facility name.
primary_payer_idsstringOptional
A list of primary payer IDs to filter by. This will return all charge captures with one of the primary payer IDs in this list.
rendering_provider_npisstringOptional
A list of rendering provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list.
rendering_provider_namesstringOptional
A list of rendering provider names to filter by. This will return all charge captures with one of the names in this list.
supervising_provider_npisstringOptional
A list of supervising provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list.
supervising_provider_namesstringOptional
A list of supervising provider names to filter by. This will return all charge captures with one of the names in this list.
exclude_charges_linked_to_claimsbooleanOptional
Whether to exclude charge captures which are part of a claim creation.
patient_external_id_ranked_sortstringOptional
The patient ID from the external EMR platform for the patient
status_ranked_sortenumOptional
The charge capture status to show first
Allowed values:
charge_external_id_ranked_sortstringOptional

A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

date_of_service_min_ranked_sortdateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

date_of_service_max_ranked_sortdateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

search_termstringOptional

Filter by any of the following fields: charge_id, claim_id, patient external_id, patient date of birth, patient first name, patient last name, or charge external id.

billable_statusenumOptional

Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.

Allowed values:
responsible_partyenumOptional

Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay.

Allowed values:
claim_ids_ranked_sortUUIDOptional
A list of claim IDs to show first. This will return all charge captures that have a resulting claim with one of the IDs in this list.
claim_creation_ids_ranked_sortUUIDOptional
A list of Claim Creation IDs to show first.
billing_provider_npis_ranked_sortstringOptional
A list of billing provider NPIs to show first. This will return all charge captures with one of the NPIs in this list.
service_facility_name_ranked_sortstringOptional
A string to show first. This will return all charge captures with this service facility name.
primary_payer_ids_ranked_sortstringOptional
A list of primary payer IDs to show first. This will return all charge captures with one of the primary payer IDs in this list.
rendering_provider_npis_ranked_sortstringOptional
A list of rendering provider NPIs to show first. This will return all charge captures with one of the NPIs in this list.
rendering_provider_names_ranked_sortstringOptional
A list of rendering provider names to show first. This will return all charge captures with one of the names in this list.
supervising_provider_npis_ranked_sortstringOptional
A list of supervising provider NPIs to show first. This will return all charge captures with one of the NPIs in this list.
supervising_provider_names_ranked_sortstringOptional
A list of supervising provider names to show first. This will return all charge captures with one of the names in this list.

Response

This endpoint returns an object.
item_countinteger
itemslist of objects
next_page_tokenstring or null
prev_page_tokenstring or null