providerPayorAggs
Query to specify individual provider and payor aggregations at a monthly, quarterly, yearly or entire period basis.
Get Started with providerPayorAggs
If you have already setup CareQuery, run the below code to get started with your first providerPayorAggs query.
Quick Example:
United and Cigna Medicare Advantage volumes for Kansas City Metro in 2023
# 1) import
from care_query.care_query import CareQuery
# 2) instantiate and connect
cq = CareQuery(email = "your-email",
token = "your-api-token",
sftp_key = "path/to/your/company.PEM")
# 3) build query
query_name = cq.providerPayorAggs(min_date = "2023-01-01",
max_date = "2023-12-31",
metro = "kansas city, mo-ks",
payor = ["united healthcare", "cigna corporation"],
payor_channel = "medicare advantage",
limit = 25000)
# 4A) submit query to return data
sample_data = query_name.sample()
# 4B) submit query to return data
size_estimate = query_name.estimate()
# 4C) submit query to return data
result_data = query_name.execute()
Query Parameters
The following a parameters are available within the providerPayorAggs query, including details on the parameter values.
| parameter | description | options |
|---|---|---|
min_date | Lower threshold date within the date range of interest, observational start date | Date String |
max_date | Upper threshold date within the date range of interest, observational end date | Date String |
npi | National Provider Identifier (NPI) of individual and/or organizational provider(s) that appear on the encounter. | Any Valid NPI |
payor | Name of the health Insurance payor associated with the claim | values available |
payor_channel | Health Insurance Payor channel-of-business or line-of-business | values available |
taxonomy_code | Taxonomy of the organization or individual provider, 10-digit code that used to identify the type, classification, and area of specialization of an individual or organizational healthcare provider | values available |
specialty_category | Specialty category of the organization or individual provider(s), broad focus of a provider by patient population, disease, skill or philosophy | values available |
specialty | Specialty of the organization or individual provider(s), specific focus of a provider by patient population, disease, skill or philosophy | values available |
subspecialty | Specialty subcategory of the organization or individual provider(s), hyper-specific focus of a provider by patient population, disease, skill or philosophy | values available |
state | US State residence of the query patient population | values available |
division | Nine distinct US State groupings as defined by the US Census Bureau | values available |
region | Four major US State groupings as defined by the US Census Bureau | values available |
metro | Metropolitan and micropolitan statistical areas according to the US Census Bureau | values available |
short_zip | First three digits the zip code of the query patient population specified | First 3 digits of zip code(s) |
agg_level | The level of aggregation to which the aggregate values are to be returned | 'month', 'quarter', 'annual' or 'entire period' |
limit | Number of rows returned in the data request | Integer or False |
show | Binary indicator as to whether you'd like query to be printed for review upon it's creation | True or False |
Query Return Data
The providerPayorAggs query returns the PROV_PAYOR_TABLE for all aggregate totals that meet the criterion specified within the query.
| feature | description | example |
|---|---|---|
| year | Year in which the aggregated values are calculated. | 2022 |
| month | Integer indicator for the month of the year in which the aggregated values are calculated | 5 |
| hcp_npi | Organizational provider, identified via their National Provider Identifier (NPI). | 1306108402 |
| hcp_name | Name of the individual provider identified. | Mai Luu |
| hcp_specialty | Primary specialty of the individual provider. | Family Practice |
| hcp_zip | Primary zip code of the individual provider. | 87101 |
| hcp_state | Primary US State code code of the individual provider. | NM |
| payor | Name of the primary payor on each encounter. | Centers for Medicare & Medicaid Services (CMS) |
| payor_channel | Payor channel-of-business, line-of-business, or plan type. | Medicare |
| num_patients | Total number of patients seen within the aggregation period. | 25 |
| num_visits | Total number of visits within the aggregation period. | 32 |
| num_encounters | Total number of encounters within the aggregation period. | 41 |
| total_line_charges | Sum of line item charges within the aggregation period. Line item charges are directly related to the procedure performed. | $5,729.18 |
| total_claim_charges | Sum of the claim item charges within the aggregation period. Claim charges include the procedure charge and related facility charges. | $9,103.40 |
| total_smart_allowed | Sum of allowed amount estimates within the aggregation period. Smart Allowed® values are derived from multiple sources to estimate the final adjudicated amount at the line-item level. | $3,958.01 |
| mean_line_charge | Average line item charge at the line itemwithin the aggregation period. Line item charges are directly related to the procedure performed. | $139.73 |
| mean_claim_charge | Average claim item charge at the line item within the aggregation period. Claim charges include the procedure charge and related facility charges. | $222.03 |
| mean_smart_allowed | Average allowed amount at the line item within the aggregation period. Smart Allowed® values are derived from multiple sources to estimate the final adjudicated amount at the line-item level. | $96.50 |
Updated 10 months ago