JOjoincandidhealth
v1

Update Charge Capture

Changed on
patch/api/charge_captures/v1/{charge_capture_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/charge_captures/v1/{charge_capture_id}
  • Auth
    HTTP bearer

Path parameters

charge_capture_idstring uuid required

Request body

charge_external_idstring

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

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.

patient_external_idstring

The patient ID from the external EMR platform for the patient

status'planned' | 'not-billable' | 'billable' | 'aborted' | 'entered-in-error'
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.

hl7_message_type'BAR' | 'DFT' | 'ADT'

HL7 message type that produced a charge-capture write. Values match the bare MSH-9-1 code emitted by HL7 producers (conduit). Constrains the hl7_message_type field on charge-capture create/update payloads so that whitespace, case drift, or non-canonical values are rejected at the API boundary instead of silently bypassing the BAR/DFT discriminator.

Response

Response with status 200

idstring uuid required
status'planned' | 'not-billable' | 'billable' | 'aborted' | 'entered-in-error' required
date_of_servicestring date
patient_external_idstring required
charge_external_idstring required
ehr_source_urlstring
originating_systemstring
claim_creation_categorystring
claim_creation_idstring uuid

Changes

  • d8b0a61873e2Revision changes
    • info

      added the new optional request property ///

    • info

      added the optional property /// to the response with the status

  • 97de8fddb088Revision changes
    • warning

      added the new RT enum value to the // response property for the response status

    • info

      added the new RT enum value to the request property //