Overview
Candid Health is an open data platform and makes it easy to retrieve datasets out of Candid Health in a first-class way. The intention of this Data Share is to provide access to datasets that can be easily synchronized into other data platforms for customer and partner needs outside of the Candid Health platform.
Cloud-native access to these shared BigQuery datasets is provided through service account credentials. In addition to using one of BigQuery’s client libraries, external tools such as Fivetran or Airbyte can be configured with those credentials to provide direct access to and automatically synchronize the datasets. Available datasets and their schemas are listed below.
Refresh Cadence
Tables are refreshed on a nightly cadence.
Please email support@joincandidhealth.com for more information and access to the feature.
Table Information
Encounter & Service Line Metadata
Schemas
export_encounter
Field | Type | Key |
---|---|---|
encounter_id | STRING | PK |
created_at | DATETIME | |
updated_at | DATETIME | |
organization_id | STRING | |
organization_name | STRING | |
date_of_service | DATE | |
external_id | STRING | |
prior_authorization_number | STRING | |
patient_authorized_release | BOOL | |
benefits_assigned_to_provider | BOOL | |
provider_accepts_assignment | BOOL | |
appointment_type | STRING | |
place_of_service_code | STRING | |
place_of_service_code_as_submitted | STRING | |
delay_reason_code | STRING | |
coding_attribution | STRING | |
synchronicity | STRING | |
billing_provider_id | STRING | |
billing_provider_first_name | STRING | |
billing_provider_last_name | STRING | |
billing_provider_organization_name | STRING | |
billing_provider_tax_id | STRING | |
billing_provider_npi | STRING | |
billing_provider_taxonomy_code | STRING | |
billing_provider_qualifier | STRING | |
billing_provider_address_address_1 | STRING | |
billing_provider_address_address_2 | STRING | |
billing_provider_address_city | STRING | |
billing_provider_address_state | STRING | |
billing_provider_address_zip_code | STRING | |
billing_provider_address_zip_plus_four_code | STRING | |
rendering_provider_first_name | STRING | |
rendering_provider_last_name | STRING | |
rendering_provider_organization_name | STRING | |
rendering_provider_tax_id | STRING | |
rendering_provider_npi | STRING | |
rendering_provider_taxonomy_code | STRING | |
rendering_provider_qualifier | STRING | |
rendering_provider_address_address_1 | STRING | |
rendering_provider_address_address_2 | STRING | |
rendering_provider_address_city | STRING | |
rendering_provider_address_state | STRING | |
rendering_provider_address_zip_code | STRING | |
rendering_provider_address_zip_plus_four_code | STRING | |
referring_provider_first_name | STRING | |
referring_provider_last_name | STRING | |
referring_provider_organization_name | STRING | |
referring_provider_tax_id | STRING | |
referring_provider_npi | STRING | |
referring_provider_taxonomy_code | STRING | |
referring_provider_qualifier | STRING | |
referring_provider_address_address_1 | STRING | |
referring_provider_address_address_2 | STRING | |
referring_provider_address_city | STRING | |
referring_provider_address_state | STRING | |
referring_provider_address_zip_code | STRING | |
referring_provider_address_zip_plus_four_code | STRING | |
initial_referring_provider_first_name | STRING | |
initial_referring_provider_last_name | STRING | |
initial_referring_provider_organization_name | STRING | |
initial_referring_provider_tax_id | STRING | |
initial_referring_provider_npi | STRING | |
initial_referring_provider_taxonomy_code | STRING | |
initial_referring_provider_qualifier | STRING | |
initial_referring_provider_address_address_1 | STRING | |
initial_referring_provider_address_address_2 | STRING | |
initial_referring_provider_address_city | STRING | |
initial_referring_provider_address_state | STRING | |
initial_referring_provider_address_zip_code | STRING | |
initial_referring_provider_address_zip_plus_four_code | STRING | |
supervising_provider_first_name | STRING | |
supervising_provider_last_name | STRING | |
supervising_provider_organization_name | STRING | |
supervising_provider_tax_id | STRING | |
supervising_provider_npi | STRING | |
supervising_provider_taxonomy_code | STRING | |
supervising_provider_qualifier | STRING | |
supervising_provider_address_address_1 | STRING | |
supervising_provider_address_address_2 | STRING | |
supervising_provider_address_city | STRING | |
supervising_provider_address_state | STRING | |
supervising_provider_address_zip_code | STRING | |
supervising_provider_address_zip_plus_four_code | STRING | |
ordering_provider_first_name | STRING | |
ordering_provider_last_name | STRING | |
ordering_provider_organization_name | STRING | |
ordering_provider_tax_id | STRING | |
ordering_provider_npi | STRING | |
ordering_provider_taxonomy_code | STRING | |
ordering_provider_qualifier | STRING | |
ordering_provider_address_address_1 | STRING | |
ordering_provider_address_address_2 | STRING | |
ordering_provider_address_city | STRING | |
ordering_provider_address_state | STRING | |
ordering_provider_address_zip_code | STRING | |
ordering_provider_address_zip_plus_four_code | STRING | |
service_facility_id | STRING | |
service_facility_organization_name | STRING | |
service_facility_npi | STRING | |
service_facility_address_address_1 | STRING | |
service_facility_address_address_2 | STRING | |
service_facility_address_city | STRING | |
service_facility_address_state | STRING | |
service_facility_address_zip_code | STRING | |
service_facility_address_zip_plus_four_code | STRING | |
pay_to_address_address_1 | STRING | |
pay_to_address_address_2 | STRING | |
pay_to_address_city | STRING | |
pay_to_address_state | STRING | |
pay_to_address_zip_code | STRING | |
pay_to_address_zip_plus_four_code | STRING | |
patient_external_id | STRING | |
patient_first_name | STRING | |
patient_last_name | STRING | |
patient_gender | STRING | |
patient_date_of_birth | DATE | |
patient_address_address_1 | STRING | |
patient_address_address_2 | STRING | |
patient_address_city | STRING | |
patient_address_state | STRING | |
patient_address_zip_code | STRING | |
patient_address_zip_plus_four_code | STRING | |
patient_phone_numbers | ARRAY<STRING> | |
patient_phone_consent | BOOL | |
patient_email | STRING | |
patient_email_consent | BOOL | |
guarantor_external_id | STRING | |
guarantor_first_name | STRING | |
guarantor_last_name | STRING | |
guarantor_date_of_birth | DATE | |
guarantor_address_address_1 | STRING | |
guarantor_address_address_2 | STRING | |
guarantor_address_city | STRING | |
guarantor_address_state | STRING | |
guarantor_address_zip_code | STRING | |
guarantor_address_zip_plus_four_code | STRING | |
guarantor_phone_numbers | ARRAY<STRING> | |
guarantor_phone_consent | BOOL | |
guarantor_email | STRING | |
guarantor_email_consent | BOOL | |
subscriber_primary_first_name | STRING | |
subscriber_primary_last_name | STRING | |
subscriber_primary_gender | STRING | |
subscriber_primary_date_of_birth | DATE | |
subscriber_primary_patient_relationship_to_subscriber_code | STRING | |
subscriber_primary_address_address_1 | STRING | |
subscriber_primary_address_address_2 | STRING | |
subscriber_primary_address_city | STRING | |
subscriber_primary_address_state | STRING | |
subscriber_primary_address_zip_code | STRING | |
subscriber_primary_address_zip_plus_four_code | STRING | |
subscriber_primary_insurance_card_member_id | STRING | |
subscriber_primary_insurance_card_group_number | STRING | |
subscriber_primary_payer_plan_group_id | STRING | |
subscriber_primary_payer_plan_group_name | STRING | |
subscriber_primary_insurance_card_plan_name | STRING | |
subscriber_primary_insurance_card_plan_type | STRING | |
subscriber_primary_insurance_card_insurance_type | STRING | |
subscriber_primary_insurance_card_payer_name | STRING | |
subscriber_primary_insurance_card_payer_id | STRING | |
subscriber_primary_insurance_card_rx_bin | STRING | |
subscriber_primary_insurance_card_rx_pcn | STRING | |
subscriber_primary_insurance_card_payer_address_address_1 | STRING | |
subscriber_primary_insurance_card_payer_address_address_2 | STRING | |
subscriber_primary_insurance_card_payer_address_city | STRING | |
subscriber_primary_insurance_card_payer_address_state | STRING | |
subscriber_primary_insurance_card_payer_address_zip_code | STRING | |
subscriber_primary_insurance_card_payer_address_zip_plus_four_code | STRING | |
subscriber_secondary_first_name | STRING | |
subscriber_secondary_last_name | STRING | |
subscriber_secondary_gender | STRING | |
subscriber_secondary_date_of_birth | DATE | |
subscriber_secondary_patient_relationship_to_subscriber_code | STRING | |
subscriber_secondary_address_address_1 | STRING | |
subscriber_secondary_address_address_2 | STRING | |
subscriber_secondary_address_city | STRING | |
subscriber_secondary_address_state | STRING | |
subscriber_secondary_address_zip_code | STRING | |
subscriber_secondary_address_zip_plus_four_code | STRING | |
subscriber_secondary_insurance_card_member_id | STRING | |
subscriber_secondary_insurance_card_group_number | STRING | |
subscriber_secondary_payer_plan_group_id | STRING | |
subscriber_secondary_payer_plan_group_name | STRING | |
subscriber_secondary_insurance_card_plan_name | STRING | |
subscriber_secondary_insurance_card_plan_type | STRING | |
subscriber_secondary_insurance_card_insurance_type | STRING | |
subscriber_secondary_insurance_card_payer_name | STRING | |
subscriber_secondary_insurance_card_payer_id | STRING | |
subscriber_secondary_insurance_card_rx_bin | STRING | |
subscriber_secondary_insurance_card_rx_pcn | STRING | |
subscriber_secondary_insurance_card_payer_address_address_1 | STRING | |
subscriber_secondary_insurance_card_payer_address_address_2 | STRING | |
subscriber_secondary_insurance_card_payer_address_city | STRING | |
subscriber_secondary_insurance_card_payer_address_state | STRING | |
subscriber_secondary_insurance_card_payer_address_zip_code | STRING | |
subscriber_secondary_insurance_card_payer_address_zip_plus_four_code | STRING | |
subscriber_tertiary_first_name | STRING | |
subscriber_tertiary_last_name | STRING | |
subscriber_tertiary_gender | STRING | |
subscriber_tertiary_date_of_birth | DATE | |
subscriber_tertiary_patient_relationship_to_subscriber_code | STRING | |
subscriber_tertiary_address_address_1 | STRING | |
subscriber_tertiary_address_address_2 | STRING | |
subscriber_tertiary_address_city | STRING | |
subscriber_tertiary_address_state | STRING | |
subscriber_tertiary_address_zip_code | STRING | |
subscriber_tertiary_address_zip_plus_four_code | STRING | |
subscriber_tertiary_insurance_card_member_id | STRING | |
subscriber_tertiary_insurance_card_group_number | STRING | |
subscriber_tertiary_payer_plan_group_id | STRING | |
subscriber_tertiary_payer_plan_group_name | STRING | |
subscriber_tertiary_insurance_card_plan_name | STRING | |
subscriber_tertiary_insurance_card_plan_type | STRING | |
subscriber_tertiary_insurance_card_insurance_type | STRING | |
subscriber_tertiary_insurance_card_payer_name | STRING | |
subscriber_tertiary_insurance_card_payer_id | STRING | |
subscriber_tertiary_insurance_card_rx_bin | STRING | |
subscriber_tertiary_insurance_card_rx_pcn | STRING | |
subscriber_tertiary_insurance_card_payer_address_address_1 | STRING | |
subscriber_tertiary_insurance_card_payer_address_address_2 | STRING | |
subscriber_tertiary_insurance_card_payer_address_city | STRING | |
subscriber_tertiary_insurance_card_payer_address_state | STRING | |
subscriber_tertiary_insurance_card_payer_address_zip_code | STRING | |
subscriber_tertiary_insurance_card_payer_address_zip_plus_four_code | STRING | |
vitals_height_in | INT64 | |
vitals_weight_lbs | INT64 | |
vitals_blood_pressure_systolic_mmhg | INT64 | |
vitals_blood_pressure_diastolic_mmhg | INT64 | |
vitals_body_temperature_f | FLOAT64 | |
vitals_hemoglobin_gdl | FLOAT64 | |
vitals_hematocrit_pct | FLOAT64 | |
responsible_party | STRING | |
billable_status | STRING | |
claim_id | STRING | PK |
claim_patient_control_number | STRING | |
claim_externally_generated_patient_control_number | STRING | |
claim_status | STRING | |
claim_adjudicated_network_status | STRING | |
claim_clia_number | STRING | |
diagnosis_codes | STRING |
export_service_line
Field | Type | Key |
---|---|---|
service_line_id | STRING | PK |
created_at | DATETIME | |
updated_at | DATETIME | |
encounter_id | STRING | |
organization_id | STRING | |
organization_name | STRING | |
procedure_code | STRING | |
date_of_service | DATE | |
end_date_of_service | DATE | |
quantity | STRING | |
units | STRING | |
modifiers | ARRAY<STRING> | |
position | INT64 | |
diagnosis_zero_name | STRING | |
diagnosis_zero_code | STRING | |
diagnosis_zero_code_type | STRING | |
diagnosis_zero_position | INT64 | |
diagnosis_one_name | STRING | |
diagnosis_one_code | STRING | |
diagnosis_one_code_type | STRING | |
diagnosis_one_position | INT64 | |
diagnosis_two_name | STRING | |
diagnosis_two_code | STRING | |
diagnosis_two_code_type | STRING | |
diagnosis_two_position | INT64 | |
diagnosis_three_name | STRING | |
diagnosis_three_code | STRING | |
diagnosis_three_code_type | STRING | |
diagnosis_three_position | INT64 | |
drug_identification_service_id_qualifier | STRING | |
drug_identification_national_drug_code | STRING | |
drug_identification_national_drug_unit_count | STRING | |
drug_identification_measurement_unit_code | STRING | |
drug_identification_link_sequence_number | STRING | |
drug_identification_pharmacy_prescription_number | STRING | |
conversion_formula | STRING | |
drug_description | STRING | |
place_of_service_code | STRING | |
place_of_service_code_as_submitted | STRING | |
description | STRING | |
referring_provider_first_name | STRING | |
referring_provider_last_name | STRING | |
referring_provider_organization_name | STRING | |
referring_provider_tax_id | STRING | |
referring_provider_npi | STRING | |
referring_provider_taxonomy_code | STRING | |
referring_provider_qualifier | STRING | |
referring_provider_address_address_1 | STRING | |
referring_provider_address_address_2 | STRING | |
referring_provider_address_city | STRING | |
referring_provider_address_state | STRING | |
referring_provider_address_zip_code | STRING | |
referring_provider_address_zip_plus_four_code | STRING | |
initial_referring_provider_first_name | STRING | |
initial_referring_provider_last_name | STRING | |
initial_referring_provider_organization_name | STRING | |
initial_referring_provider_tax_id | STRING | |
initial_referring_provider_npi | STRING | |
initial_referring_provider_taxonomy_code | STRING | |
initial_referring_provider_qualifier | STRING | |
initial_referring_provider_address_address_1 | STRING | |
initial_referring_provider_address_address_2 | STRING | |
initial_referring_provider_address_city | STRING | |
initial_referring_provider_address_state | STRING | |
initial_referring_provider_address_zip_code | STRING | |
initial_referring_provider_address_zip_plus_four_code | STRING | |
supervising_provider_first_name | STRING | |
supervising_provider_last_name | STRING | |
supervising_provider_organization_name | STRING | |
supervising_provider_tax_id | STRING | |
supervising_provider_npi | STRING | |
supervising_provider_taxonomy_code | STRING | |
supervising_provider_qualifier | STRING | |
supervising_provider_address_address_1 | STRING | |
supervising_provider_address_address_2 | STRING | |
supervising_provider_address_city | STRING | |
supervising_provider_address_state | STRING | |
supervising_provider_address_zip_code | STRING | |
supervising_provider_address_zip_plus_four_code | STRING | |
ordering_provider_first_name | STRING | |
ordering_provider_last_name | STRING | |
ordering_provider_organization_name | STRING | |
ordering_provider_tax_id | STRING | |
ordering_provider_npi | STRING | |
ordering_provider_taxonomy_code | STRING | |
ordering_provider_qualifier | STRING | |
ordering_provider_address_address_1 | STRING | |
ordering_provider_address_address_2 | STRING | |
ordering_provider_address_city | STRING | |
ordering_provider_address_state | STRING | |
ordering_provider_address_zip_code | STRING | |
ordering_provider_address_zip_plus_four_code | STRING |
Financial Transactions Data
The core of the financial transactions data model is the export_transaction
table. This table will have most of the information
you need to analyze your financial transactions. If you need to access more detailed data about one type of transaction, you can
join the export_transaction
table to one of the associated detail tables using an inner join:
1 SELECT 2 * 3 FROM export_transaction 4 JOIN export_adjustment_details 5 ON export_transaction.transaction_type = 'ADJUSTMENT' 6 AND export_transaction.transaction_id = export_adjustment_details.transaction_id
Full diagram of relationships and JOIN predicates:
Informational Adjustments are not associated with financial transactions and can be directly associated with Service Lines or Encounters
Service Line Charges can be joined to Transactions through the charge_id
and also to Service Lines through the service_line_id
:
1 SELECT 2 * 3 FROM export_transaction 4 JOIN export_service_line_charge 5 ON export_transaction.charge_id = export_service_line_charge.id 6 JOIN export_service_line 7 ON export_service_line_charge.service_line_id = export_service_lineservice_line_id
In diagram form:
Schemas
export_transaction
Field | Type | Key |
---|---|---|
transaction_id | STRING | PK |
transaction_type | STRING | |
voids_transaction_id | STRING | |
voided_by_transaction_id | STRING | |
transaction_timestamp | TIMESTAMP | |
organization_id | STRING | |
organization_name | STRING | |
amount_cents | INT64 | |
target_id | STRING | |
target_type | STRING | |
counter_party_id | STRING | |
counter_party_type | STRING | |
payer_plan_group_id | STRING | |
batch_date | TIMESTAMP | |
encounter_id | STRING | |
service_line_id | STRING | |
charge_id | STRING |
export_payment_details
Field | Type | Key |
---|---|---|
transaction_id | STRING | PK |
payment_posted_date | TIMESTAMP | |
check_date | DATE | |
claim_status_code | INT64 | |
payment_type | STRING | |
external_payment_id | STRING | |
payer_plan_group_id | STRING | |
charge_id | STRING | |
organization_id | STRING | |
organization_name | STRING |
export_adjustment_details
Field | Type | Key |
---|---|---|
transaction_id | STRING | PK |
source | STRING | |
carc | STRING | |
external_payment_id | STRING | |
check_date | DATE | |
adjustment_reason | STRING | |
payer_plan_group_id | STRING | |
charge_id | STRING | |
posted_status | STRING | |
organization_id | STRING | |
organization_name | STRING |
export_informational_adjustments
Field | Type | Key |
---|---|---|
id | STRING | PK |
organization_id | STRING | |
organization_name | STRING | |
adjustment_timestamp | TIMESTAMP | |
adjustment_type | STRING | |
posted_status | STRING | |
amount_cents | INT64 | |
carc | STRING | |
patient_id | STRING | |
encounter_id | STRING | |
service_line_id | STRING | |
latest_charge_id | STRING |
export_service_line_charge
Field | Type | Key |
---|---|---|
created_at | TIMESTAMP | |
updated_at | TIMESTAMP | |
id | STRING | PK |
organization_id | STRING | |
service_line_id | STRING | |
billing_provider_npi | STRING | |
procedure_code | STRING | |
quantity | NUMERIC | |
date_of_service | TIMESTAMP | |
rendering_provider_npi | STRING | |
place_of_service_code | STRING | |
charge_status | STRING | |
billing_provider_tax_id | STRING | |
service_facility_name | STRING | |
service_facility_address1 | STRING | |
service_facility_city | STRING | |
service_facility_state | STRING | |
service_facility_zip_code | STRING |