v1

Get all Charge Captures

get/api/charge_captures/v1

Query parameters

limitinteger

Maximum number of entities per page, defaults to 100.

sortV1ChargeCaptureSortField — unresolved $ref

Defaults to created_at

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order if not provided.

page_tokenstring
patient_external_idstring

The patient ID from the external EMR platform for the patient

statusV1ChargeCaptureStatus — unresolved $ref

the status of the charge captures

charge_external_idstring

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_minstring date

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_maxstring date

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_idsstring uuid

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_idsstring uuid

A list of Claim Creation IDs to filter by.

billing_provider_npisstring

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_namestring

A string to filter by. This will return all charge captures with this service facility name.

primary_payer_idsstring

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_npisstring

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_namesstring

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_npisstring

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_namesstring

A list of supervising provider names to filter by. This will return all charge captures with one of the names in this list.

claim_creation_categorystring

A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

tagsstring

A list of tags to filter by. This will return all charge captures with one of the tags.

primary_payer_namesstring

A list of primary payer names to filter by. This will return all charge captures with one of the names.

patient_namesstring

A list of patient names to filter by. This will return all charge captures with one of the names.

exclude_charges_linked_to_claimsboolean

Whether to exclude charge captures which are part of a claim creation.

patient_external_id_ranked_sortstring

The patient ID from the external EMR platform for the patient

status_ranked_sortV1ChargeCaptureStatus — unresolved $ref

The charge capture status to show first

charge_external_id_ranked_sortstring

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_sortstring date

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_sortstring date

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_termstring

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_statusV4BillableStatusType — unresolved $ref

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.

responsible_partyV4ResponsiblePartyType — unresolved $ref

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.

claim_ids_ranked_sortstring uuid

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_sortstring uuid

A list of Claim Creation IDs to show first.

billing_provider_npis_ranked_sortstring

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_sortstring

A string to show first. This will return all charge captures with this service facility name.

primary_payer_ids_ranked_sortstring

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_sortstring

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_sortstring

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_sortstring

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_sortstring

A list of supervising provider names to show first. This will return all charge captures with one of the names in this list.

claim_status'biller_received' | 'coded' | 'submitted_to_payer' | 'missing_information' | 'not_billable' | 'waiting_for_provider' | 'era_received' | 'rejected' | 'denied' | 'paid' | 'paid_incorrectly' | 'finalized_paid' | 'finalized_denied' | 'held_by_customer' | 'era_requires_review'

the status of the claim to filter by created from charge capture bundle.

claim_creation_category_ranked_sortstring

A list of claim creation categories to sort by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

tags_ranked_sortstring

A list of tags. This will return all charge captures with one of the tags.

primary_payer_names_ranked_sortstring

A list of primary payer names to sort by. This will return all charge captures with one of the names.

patient_names_ranked_sortstring

A list of patient names to sort by. This will return all charge captures with one of the names.

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V1ChargeCapturePage required— unresolved $ref