For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
metadatalist of objectsOptional
Key-value pairs that adhere to metadata schemas.
Multiple metadata instances can be associated with a charge capture.
hl7_message_typeenumOptional
The HL7 message type that produced this write. Used to differentiate post-submission update behavior. Sent by HL7 producers (conduit); null for manual / script writes.
Allowed values:
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_servicedateOptional
ehr_source_urlstringOptional
originating_systemstringOptional
claim_creation_categorystringOptional
metadatalist of objectsOptional
Key-value pairs that adhere to metadata schemas.
Multiple metadata instances can be associated with a charge capture.
