Sign in
v1

Create a Charge Capture

post/api/charge_captures/v1

Headers

Authorizationstring required

OAuth authentication

Request body

dataV1ChargeCaptureData required— unresolved $ref
charge_external_idstring required

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.

originating_systemstring

An optional string field denoting the originating system of the charge.

claim_creation_categorystring

An optional string field denoting the user defined category of the claim creation.

ehr_source_urlstring

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

patient_external_idstring required

The patient ID from the external EMR platform for the patient

statusV1ChargeCaptureStatus required— unresolved $ref
attachment_external_document_idsstring[]

Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time.

metadataV1SchemaInstance[] — unresolved $ref

Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture.

hl7_message_typeV1Hl7MessageType — unresolved $ref

Response

Response with status 200

V1ChargeCapture required— unresolved $ref