Overview
Candid Data Share 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
General metadata is provided at both the service_line and encounter granularities for easy reporting & summarization
Schemas
export_encounter
export_service_line
Financial Transactions Data
Do Not Use For Patient Invoicing
Candid Data Share is not designed to support patient invoicing workflows. For all patient invoicing use cases, you must use the Patient Invoicing API. This is the only supported method for ensuring balance accuracy.
Candid Data Share data is generated on a periodic basis and does not provide a live, real-time view of a patient’s balance. Please be advised that Candid cannot support issues related to invoicing breaks or inaccuracies that result from using Candid Data Share for this purpose.
Transaction Detail Tables
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:
Full diagram of relationships and JOIN predicates:
Each transaction type has its own detail table that can be joined based on the transaction type:
Transaction to Encounter and Service Line
Transactions can be linked to encounters and service lines:
Service Line Charges
Service Line Charges can be joined to Transactions through the charge_id and also to Service Lines through the service_line_id:
In diagram form:
Informational Adjustments
Informational Adjustments are not associated with financial transactions and can be directly associated with Service Lines or Encounters:
Schemas
export_transaction
export_payment_details
export_charge_details
export_adjustment_details
export_informational_adjustments
export_service_line_charge
General Financial Data & Aggregations
export_service_line_projected_financials provides financial projects at service line granularity,
used for projecting revenue calculations. No guarantees are made as to the accuracy of these projections.
This data can be joined to the export_service_line table: