v4

Get all encounters

get/api/encounters/v4

Query parameters

limitinteger

Maximum number of entities per page, defaults to 100.

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'

Indicates the current status of an insurance claim within the billing process.

sortV4EncounterSortOptions — unresolved $ref

Defaults to created_at:desc.

page_tokenstring
date_of_service_minstring date

Date formatted as YYYY-MM-DD; eg: 2019-08-25.

date_of_service_maxstring date

Date formatted as YYYY-MM-DD; eg: 2019-08-25.

primary_payer_namesstring

Comma delimited string.

search_termstring

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

external_idstring

Filter to an exact match on encounter external_id, if one exists.

diagnoses_updated_sincestring date-time

ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z.

tag_idsstring

Filter by name of tags on encounters.

work_queue_idstring
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.

owner_of_next_actionV4EncounterOwnerOfNextActionType — unresolved $ref

The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.

patient_external_idstring

The patient ID from the external EMR platform for the patient

include_merged_patient_databoolean

If true and patient_external_id is set, then also include the encounters of all alternative patients.

billing_provider_npisstring

Filter to encounters whose billing provider matches any of these NPIs.

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V4EncounterPage required— unresolved $ref