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_idstringOptional
Filter to an exact match on encounter external_id, if one exists.
diagnoses_updated_sincedatetimeOptional
ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z.
tag_idsstringOptional
Filter by name of tags on encounters.
work_queue_idstringOptional
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: BILLABLENOT_BILLABLE
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: INSURANCE_PAYSELF_PAYUNKNOWN
owner_of_next_actionenumOptional
The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
Allowed values: CANDIDCUSTOMERCODERNONE
patient_external_idstringOptional
The patient ID from the external EMR platform for the patient