EncountersV4

Update encounter

PATCH

Path parameters

encounter_idUUIDRequired

Request

This endpoint expects an object.
prior_authorization_number
stringOptional
Box 23 on the CMS-1500 claim form.
external_id
stringOptional
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
dateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. Box 24a on the CMS-1500 claim form. If service occurred over a range of dates, this should be the start date. If service lines have distinct date_of_service values, updating the encounter’s date_of_service will fail. If all service line date_of_service values are the same, updating the encounter’s date_of_service will update all service line date_of_service values.

diagnosis_ids
list of UUIDsOptional
Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor.
tag_ids
list of stringsOptional
Names of tags that should be on the encounter. Note all tags on encounter will be overriden with this list.
clinical_notes
list of objectsOptional
Holds a collection of clinical observations made by healthcare providers during patient encounters.
pay_to_address
objectOptional
Specifies the address to which payments for the claim should be sent.
billable_status
enumOptional

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_party
enumOptional

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
provider_accepts_assignment
booleanOptional
Whether you have accepted the patient's authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form.
benefits_assigned_to_provider
booleanOptional
Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form.
synchronicity
enumOptional
Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call.
Allowed values: SynchronousAsynchronous
place_of_service_code
enumOptional

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here.

place_of_service_code_as_submitted
enumOptional

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here.

appointment_type
stringOptional
Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
end_date_of_service
dateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-25. This date must be the local date in the timezone where the service occurred. If omitted, the Encounter is assumed to be for a single day. Must not be temporally before the date_of_service field. If service lines have distinct end_date_of_service values, updating the encounter’s end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter’s end_date_of_service will update all service line date_of_service values.

subscriber_primary
objectOptional
Contains details of the primary insurance subscriber.
subscriber_secondary
objectOptional
Contains details of the secondary insurance subscriber.
additional_information
stringOptional
Defines additional information on the claim needed by the payer. Box 19 on the CMS-1500 claim form.
service_authorization_exception_code
enumOptional

837p Loop2300 REF*4N Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without obtaining the authorization.

admission_date
dateOptional

837p Loop2300 DTP*435, CMS-1500 Box 18 Required on all ambulance claims when the patient was known to be admitted to the hospital. OR Required on all claims involving inpatient medical visits.

discharge_date
dateOptional

837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.

onset_of_current_illness_or_symptom_date
dateOptional

837p Loop2300 DTP*431, CMS-1500 Box 14 Required for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service. OR This date is the onset of acute symptoms for the current illness or condition.

last_menstrual_period_date
dateOptional

837p Loop2300 DTP*484, CMS-1500 Box 14 Required when, in the judgment of the provider, the services on this claim are related to the patient’s pregnancy.

delay_reason_code
enumOptional
837i Loop2300, CLM-1300 Box 20 Code indicating the reason why a request was delayed
patient_authorized_release
booleanOptional
Whether this patient has authorized the release of medical information for billing purpose. Box 12 on the CMS-1500 claim form.

Response

This endpoint returns an object
benefits_assigned_to_provider
boolean
Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form.
billable_status
enum

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
billing_provider
object
The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
claims
list of objects
clinical_notes
list of objects
Holds a collection of clinical observations made by healthcare providers during patient encounters.
date_of_service
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. Box 24a on the CMS-1500 claim form. If service occurred over a range of dates, this should be the start date. date_of_service must be defined on either the encounter or the service lines but not both.

diagnoses
list of objects
Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor.
encounter_id
UUID
external_id
string
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.
owner_of_next_action
enum
The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
Allowed values: CANDIDCUSTOMERCODERNONE
patient
object
Contains the identification information of the individual receiving medical services.
patient_authorized_release
boolean
Whether this patient has authorized the release of medical information for billing purpose. Box 12 on the CMS-1500 claim form.
patient_histories
list of objects
patient_payments
list of objects
provider_accepts_assignment
boolean
Whether you have accepted the patient's authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form.
rendering_provider
object
The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service. For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
responsible_party
enum
Defines the party to be billed with the initial balance owed on the claim.
Allowed values: INSURANCE_PAYSELF_PAYUNKNOWN
service_facility
object
Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process.
submission_origin
enum

The party who originally submitted the Claim. For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID. For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL.

Allowed values: CANDIDEXTERNAL
tags
list of objects
url
string
URL that links directly to the claim created in Candid.
additional_information
stringOptional
Defines additional information on the claim needed by the payer. Box 19 on the CMS-1500 claim form.
admission_date
dateOptional

837p Loop2300 DTP*435, CMS-1500 Box 18 Required on all ambulance claims when the patient was known to be admitted to the hospital. OR Required on all claims involving inpatient medical visits.

appointment_type
stringOptional
Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
billing_notes
list of objectsOptional
Spot to store misc, human-readable, notes about this encounter to be used in the billing process.
coding_attribution
enumOptional
The entity that performed the coding of medical services for the claim.
Allowed values: CANDIDCUSTOMERTCNPJF
delay_reason_code
enumOptional
837i Loop2300, CLM-1300 Box 20 Code indicating the reason why a request was delayed
discharge_date
dateOptional

837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.

end_date_of_service
dateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-25. This date must be the local date in the timezone where the service occurred. If omitted, the Encounter is assumed to be for a single day. Must not be temporally before the date_of_service field.

existing_medications
list of objectsOptional
guarantor
objectOptional
Personal and contact info for the guarantor of the patient responsibility.
initial_referring_provider
objectOptional
interventions
list of objectsOptional
last_menstrual_period_date
dateOptional

837p Loop2300 DTP*484, CMS-1500 Box 14 Required when, in the judgment of the provider, the services on this claim are related to the patient’s pregnancy.

onset_of_current_illness_or_symptom_date
dateOptional

837p Loop2300 DTP*431, CMS-1500 Box 14 Required for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service. OR This date is the onset of acute symptoms for the current illness or condition.

ordering_provider
objectOptional
patient_control_number
stringOptional
A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility. It's used to track and manage a patient's medical records, treatments, and other healthcare-related information.
pay_to_address
objectOptional
Specifies the address to which payments for the claim should be sent.
place_of_service_code
enumOptional

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here.

place_of_service_code_as_submitted
enumOptional

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here.

prior_authorization_number
stringOptional
Box 23 on the CMS-1500 claim form.
referring_provider
objectOptional
service_authorization_exception_code
enumOptional

837p Loop2300 REF*4N Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without obtaining the authorization.

subscriber_primary
objectOptional

Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance). These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient). However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid. Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.

subscriber_secondary
objectOptional
Contains details of the secondary insurance subscriber.
supervising_provider
objectOptional
synchronicity
enumOptional
Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call.
Allowed values: SynchronousAsynchronous
vitals
objectOptional
work_queue_id
stringOptional
work_queue_membership_activated_at
datetimeOptional

Errors