ChargeCaptureV1

Create a Charge Capture

post/api/charge_captures/v1

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/api/charge_captures/v1
  • Auth: HTTP bearer

Request body

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 nullable

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

claim_creation_categorystring nullable

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

ehr_source_urlstring nullable

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

status'planned' | 'not-billable' | 'billable' | 'aborted' | 'entered-in-error' required
attachment_external_document_idsstring[] nullable

Provide external attachment IDs which have been uploaded to Taiga. 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

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

Changes

No recorded changes to this operation across all 1 revision of this API.