API ReferenceCharge CaptureV1

Create a Charge Capture

Beta

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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.
charge_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
Allowed values:
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.
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).

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
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
ehr_source_urlstring
originating_systemstring
claim_creation_categorystring
metadatalist of objects

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

errorobject
claim_creation_idUUID

Errors

403
Unauthorized Error
404
Entity Not Found Error
409
Charge External ID Conflict Error
422
HTTP Request Validations Error
422
Schema Instance Validation HTTP Failure
422
Unprocessable Entity Error