Skip to navigation
API ReferenceCharge Capture V1

Create a Charge Capture from pre-encounter patient and appointment

Beta

Create a Charge Capture from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage of the pre-encounter service should use the standard create endpoint.

At encounter creation time, information from the provided patient and appointment objects will be populated where applicable. In particular, the following fields are populated from the patient and appointment objects:

  • Patient
  • Referring Provider
  • Subscriber Primary
  • Subscriber Secondary
  • Referral Number
  • Responsible Party
  • Guarantor

Note that these fields should not be populated in the ChargeCaptureData property of this endpoint, as they will be overwritten at encounter creation time.

Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the encounter has not already been submitted or adjudicated.

Authentication

AuthorizationBearer
Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Request

This endpoint expects an object.
dataobjectRequired
Charge Capture data contains all the fields needed to create an encounter, but listed as optional. Taiga 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.

pre_encounter_patient_idstringRequiredformat: "uuid"
pre_encounter_appointment_idslist of stringsRequired
statusenumRequired
the status of the charge capture
Allowed values:
originating_systemstring or nullOptional
An optional string field denoting the originating system of the charge.
claim_creation_categorystring or nullOptional
An optional string field denoting the user defined category of the claim creation.
ehr_source_urlstring or nullOptional

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 strings or nullOptional
Provide external attachment IDs which have been uploaded to Taiga. They will be associated with the Encounter at Encounter creation time.
hl7_message_typeenum or nullOptional

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

idstringformat: "uuid"
statusenum
Allowed values:
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 or nullOptional
ehr_source_urlstring or nullOptional
originating_systemstring or nullOptional
claim_creation_categorystring or nullOptional
metadatalist of objects or nullOptional

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

errorobject or nullOptional
claim_creation_idstring or nullOptionalformat: "uuid"

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error