Get Charge Capture

GET

/api/charge_captures/v1/:charge_capture_id

GET

/api/charge_captures/v1/:charge_capture_id

import requests
url = "https://api.taigabilling.com/api/charge_captures/v1/charge_capture_id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

200Retrieved

{
  "id": "string",
  "status": "planned",
  "charge_capture_data": {
    "accident_date": "2023-01-15",
    "additional_information": "string",
    "admission_date": "2023-01-15",
    "appointment_type": "string",
    "benefits_assigned_to_provider": true,
    "billable_status": "BILLABLE",
    "billing_notes": [
      {
        "text": "string"
      }
    ],
    "billing_provider": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "organization_name": "string",
      "provider_commercial_license_type": "0",
      "secondary_identification": {
        "reference_identification": "string",
        "reference_identification_qualifier": "G2"
      },
      "tax_id": "string",
      "taxonomy_code": "string"
    },
    "claim_supplemental_information": [
      {
        "attachment_report_type_code": "03",
        "attachment_transmission_code": "AA",
        "attachment_control_number": "string"
      }
    ],
    "clinical_notes": [
      {
        "category": "clinical",
        "notes": [
          {
            "text": "string",
            "author_name": "string",
            "author_npi": "string",
            "timestamp": "2024-01-15T09:30:00Z"
          }
        ]
      }
    ],
    "date_of_service": "2023-01-15",
    "delay_reason_code": "1",
    "diagnoses": [
      {
        "name": "string",
        "code_type": "ABF",
        "code": "string",
        "present_on_admission_indicator": "YES"
      }
    ],
    "discharge_date": "2023-01-15",
    "end_date_of_service": "2023-01-15",
    "epsdt_referral": {
      "condition_indicator1": "AV",
      "condition_indicator2": "AV",
      "condition_indicator3": "AV"
    },
    "existing_medications": [
      {
        "name": "string",
        "rx_cui": "string",
        "dosage": "string",
        "dosage_form": "string",
        "frequency": "string",
        "as_needed": true
      }
    ],
    "external_id": "string",
    "guarantor": {
      "first_name": "string",
      "last_name": "string",
      "external_id": "string",
      "date_of_birth": "2023-01-15",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "phone_numbers": [
        {
          "number": "string",
          "type": "Home"
        }
      ],
      "phone_consent": true,
      "email": "string",
      "email_consent": true,
      "auto_charge_consent": true
    },
    "initial_referring_provider": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "organization_name": "string",
      "qualifier": "DQ",
      "secondary_identification": {
        "reference_identification": "string",
        "reference_identification_qualifier": "0B"
      },
      "taxonomy_code": "string"
    },
    "initial_treatment_date": "2023-01-15",
    "interventions": [
      {
        "name": "string",
        "category": "allopathic",
        "description": "string",
        "medication": {
          "name": "string",
          "rx_cui": "string",
          "dosage": "string",
          "dosage_form": "string",
          "frequency": "string",
          "as_needed": true
        },
        "labs": [
          {
            "name": "string",
            "code": "string",
            "code_type": "quest"
          }
        ]
      }
    ],
    "last_menstrual_period_date": "2023-01-15",
    "onset_of_current_illness_or_symptom_date": "2023-01-15",
    "outside_lab": true,
    "outside_lab_charges_amount_cents": 1,
    "patient": {
      "first_name": "string",
      "last_name": "string",
      "gender": "male",
      "external_id": "string",
      "date_of_birth": "2023-01-15",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "phone_numbers": [
        {
          "number": "string",
          "type": "Home"
        }
      ],
      "phone_consent": true,
      "email": "string",
      "email_consent": true,
      "auto_charge_consent": true,
      "non_insurance_payers_info": [
        {
          "non_insurance_payer_id": "string",
          "member_id": "string",
          "clinical_trial_info": [
            {
              "clinical_trial_arm": "string",
              "clinical_trial_id": "string"
            }
          ]
        }
      ],
      "non_insurance_payers": [
        "string"
      ]
    },
    "patient_histories": [
      {
        "category": "present_illness",
        "questions": [
          {
            "id": "string",
            "text": "string",
            "responses": [
              {
                "response": "string",
                "follow_ups": [
                  {
                    "id": "string",
                    "text": "string",
                    "response": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "pay_to_address": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "AA",
      "zip_code": "string",
      "zip_plus_four_code": "string"
    },
    "place_of_service_code": "01",
    "prior_authorization_number": "string",
    "property_casualty_claim_number": "string",
    "property_casualty_patient_identifier": {
      "property_casualty_patient_identifier_qualifier": "1W",
      "property_casualty_patient_identifier": "string"
    },
    "provider_accepts_assignment": true,
    "purchased_service_provider_npi": "string",
    "referral_number": "string",
    "referring_provider": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "organization_name": "string",
      "secondary_identification": {
        "reference_identification": "string",
        "reference_identification_qualifier": "0B"
      },
      "taxonomy_code": "string",
      "qualifier": "DQ"
    },
    "related_causes_information": {
      "related_causes_code_1": "AA",
      "related_causes_code_2": "AA",
      "state_or_province_code": "string"
    },
    "rendering_provider": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "organization_name": "string",
      "secondary_identification": {
        "reference_identification": "string",
        "reference_identification_qualifier": "0B"
      },
      "taxonomy_code": "string"
    },
    "responsible_party": "INSURANCE_PAY",
    "schema_instances": [
      {
        "schema_id": "string",
        "content": {}
      }
    ],
    "secondary_payer_carrier_code": "string",
    "service_authorization_exception_code": "1",
    "service_facility": {
      "organization_name": "string",
      "npi": "string",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "secondary_identification": "string",
      "mammography_certification_number": "string"
    },
    "service_facility_id": "string",
    "service_lines": [
      {
        "modifiers": [
          "AV"
        ],
        "has_epsdt_indicator": true,
        "has_family_planning_indicator": true,
        "procedure_code": "string",
        "quantity": "string",
        "units": "MJ",
        "charge_amount_cents": 1,
        "diagnosis_pointers": [
          1
        ],
        "drug_identification": {
          "service_id_qualifier": "EN",
          "national_drug_code": "string",
          "national_drug_unit_count": "string",
          "measurement_unit_code": "ML",
          "link_sequence_number": "string",
          "pharmacy_prescription_number": "string",
          "conversion_formula": "string",
          "drug_description": "string"
        },
        "place_of_service_code": "01",
        "description": "string",
        "date_of_service": "2023-01-15",
        "end_date_of_service": "2023-01-15",
        "ordering_provider": {
          "address": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "AA",
            "zip_code": "string",
            "zip_plus_four_code": "string"
          },
          "first_name": "string",
          "last_name": "string",
          "npi": "string",
          "organization_name": "string",
          "taxonomy_code": "string"
        },
        "test_results": [
          {
            "value": 1.1,
            "result_type": "HEMATOCRIT"
          }
        ],
        "note": "string",
        "revenue_code": "string",
        "prior_authorization_number": "string",
        "external_id": "string"
      }
    ],
    "subscriber_primary": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "date_of_birth": "2023-01-15",
      "first_name": "string",
      "gender": "male",
      "insurance_card": {
        "group_number": "string",
        "plan_name": "string",
        "plan_type": "09",
        "insurance_type": "01",
        "payer_plan_group_id": "string",
        "payer_address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "AA",
          "zip_code": "string",
          "zip_plus_four_code": "string"
        },
        "member_id": "string",
        "payer_name": "string",
        "payer_id": "string",
        "rx_bin": "string",
        "rx_pcn": "string",
        "image_url_front": "string",
        "image_url_back": "string",
        "emr_payer_crosswalk": "HEALTHIE",
        "payer_plan_group_name": "string"
      },
      "last_name": "string",
      "patient_relationship_to_subscriber_code": "01"
    },
    "subscriber_secondary": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "date_of_birth": "2023-01-15",
      "first_name": "string",
      "gender": "male",
      "insurance_card": {
        "group_number": "string",
        "plan_name": "string",
        "plan_type": "09",
        "insurance_type": "01",
        "payer_plan_group_id": "string",
        "payer_address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "AA",
          "zip_code": "string",
          "zip_plus_four_code": "string"
        },
        "member_id": "string",
        "payer_name": "string",
        "payer_id": "string",
        "rx_bin": "string",
        "rx_pcn": "string",
        "image_url_front": "string",
        "image_url_back": "string",
        "emr_payer_crosswalk": "HEALTHIE",
        "payer_plan_group_name": "string"
      },
      "last_name": "string",
      "patient_relationship_to_subscriber_code": "01"
    },
    "subscriber_tertiary": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "date_of_birth": "2023-01-15",
      "first_name": "string",
      "gender": "male",
      "insurance_card": {
        "group_number": "string",
        "plan_name": "string",
        "plan_type": "09",
        "insurance_type": "01",
        "payer_plan_group_id": "string",
        "payer_address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "AA",
          "zip_code": "string",
          "zip_plus_four_code": "string"
        },
        "member_id": "string",
        "payer_name": "string",
        "payer_id": "string",
        "rx_bin": "string",
        "rx_pcn": "string",
        "image_url_front": "string",
        "image_url_back": "string",
        "emr_payer_crosswalk": "HEALTHIE",
        "payer_plan_group_name": "string"
      },
      "last_name": "string",
      "patient_relationship_to_subscriber_code": "01"
    },
    "supervising_provider": {
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "organization_name": "string",
      "secondary_identification": {
        "reference_identification": "string",
        "reference_identification_qualifier": "0B"
      },
      "taxonomy_code": "string"
    },
    "synchronicity": "Synchronous",
    "tag_ids": [
      "string"
    ],
    "vitals": {
      "height_in": 1,
      "weight_lbs": 1,
      "blood_pressure_systolic_mmhg": 1,
      "blood_pressure_diastolic_mmhg": 1,
      "body_temperature_f": 1.1,
      "hemoglobin_gdl": 1.1,
      "hematocrit_pct": 1.1
    },
    "external_claim_submission": {
      "claim_created_at": "2024-01-15T09:30:00Z",
      "patient_control_number": "string",
      "submission_records": [
        {
          "submitted_at": "2024-01-15T09:30:00Z",
          "claim_frequency_code": "0",
          "payer_responsibility": "primary",
          "intended_submission_medium": "paper"
        }
      ]
    },
    "patient_authorized_release": true,
    "treating_provider": {
      "first_name": "string",
      "last_name": "string",
      "npi": "string",
      "taxonomy_code": "string",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "AA",
        "zip_code": "string",
        "zip_plus_four_code": "string"
      },
      "license_type": "MD"
    }
  },
  "patient_external_id": "string",
  "charge_external_id": "string",
  "updates": [
    {
      "id": "string",
      "message": "string",
      "resolved": true
    }
  ],
  "date_of_service": "2023-01-15",
  "ehr_source_url": "string",
  "originating_system": "string",
  "claim_creation_category": "string",
  "metadata": [
    {
      "schema_id": "string",
      "content": {}
    }
  ],
  "error": {
    "id": "string",
    "message": "string",
    "claim_creation_id": "string",
    "charge_capture_id": "string",
    "resolved": true,
    "resolved_by": "string",
    "resolution_reason": "string",
    "field_in_error": "string"
  },
  "claim_creation_id": "string"
}

Authentication

AuthorizationBearer

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

Path parameters

charge_capture_idstringRequiredformat: "uuid"

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"