Create a ChargeCapture

Beta
POST
/api/charge_captures/v1

Request

This endpoint expects an object.
dataobjectRequired

Charge Capture data contains all the fields needed to create an encounter, but listed as optional. Candid will use this data when attempting to bundle multiple Charge Captures into a single encounter.

encounter_external_idstringRequired

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.

patient_external_idstringRequired

The patient ID from the external EMR platform for the patient

statusenumRequired

the status of the charge capture

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

Response

This endpoint returns an object.
idUUID
statusenum
charge_capture_dataobject
patient_external_idstring
encounter_external_idstring
ehr_source_urlstringOptional

Errors

Built with