API ReferenceCharge CaptureV1

Update Charge Capture

Beta

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

charge_capture_idUUIDRequired

Request

This endpoint expects an object.
dataobjectOptional
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.

ehr_source_urlstringOptional

External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).

originating_systemstringOptional
An optional string field denoting the originating system of the charge.
claim_creation_categorystringOptional
An optional string field denoting the user defined category of the claim creation.
patient_external_idstringOptional
The patient ID from the external EMR platform for the patient
statusenumOptional
the status of the charge capture
Allowed values:
attachment_external_document_idslist of stringsOptional
Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time.

Response

This endpoint returns an object.
idUUID
statusenum
Allowed values:
charge_capture_dataobject
patient_external_idstring
charge_external_idstring
updateslist of objects
This list of updates will always return at most 1 update that is not resolved. The singular update will contain the difference between the updated charge and the created encounter.
date_of_servicedate or null
ehr_source_urlstring or null
originating_systemstring or null
claim_creation_categorystring or null
errorobject or null
claim_creation_idUUID or null

Errors