{"openapi":"3.1.0","info":{"title":"Verzi Health API","description":"327M+ rows of healthcare provider intelligence — 9 CMS provider types plus 30+ federal, state, academic, and commercial sources (CMS, HHS OIG, HRSA, CDC, AHRQ, Census/OMB, IRS, DOL, SEC EDGAR, Dartmouth Atlas, state medical boards, Google Maps, FMP, ProPublica). Covers quality, financial, license, employment, market, community health, and VBC/ACO data. Per-source license + cadence at /sources. Most endpoints require an API key.\n\n**Authentication.** Send your Verzi API key in the `X-API-Key` header, or the same key as `Authorization: Bearer <key>`. Each operation's `security` says whether it needs a key: `[]` is public, and a list that starts with `{}` takes an optional key. Get a free key at https://docs.verzi.health/signup.\n\n**Versioning.** `/v1` is the contract. The unversioned paths on api.verzi.health are deprecated twins: they keep working and answer with `Deprecation` and `Link: rel=\"successor-version\"` headers.\n\n**OAuth.** This REST API is not an OAuth resource server. OAuth 2.1 (issuer https://auth.verzi.health, scopes providers:read, receipts:read, offline_access) protects the MCP server at https://mcp.verzi.health/mcp, with metadata at https://mcp.verzi.health/.well-known/oauth-protected-resource.","version":"2.0.0"},"servers":[{"url":"https://api.verzi.health/v1","description":"Verzi Health API (current)"},{"url":"https://api.healthcaredata.io","description":"healthcaredata.io host (unversioned paths, same keys)"}],"paths":{"/check":{"get":{"tags":["DME code check"],"summary":"Check Form","description":"The lookup form. A code in the query redirects to the shareable URL.","operationId":"check_form_check_get","parameters":[{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"}},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/check/{hcpcs}":{"get":{"tags":["DME code check"],"summary":"Check Code","description":"Shareable page for one HCPCS code. Browsers get HTML. Clients get JSON.","operationId":"check_code_check__hcpcs__get","parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","title":"Hcpcs"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state, optional","title":"State"},"description":"Two-letter state, optional"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD, optional","title":"Dos"},"description":"Date of service, YYYY-MM-DD, optional"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/v1/check/{hcpcs}":{"get":{"tags":["DME code check"],"summary":"Check Code Json","description":"Anonymous JSON lookup. Same per-IP limit as the page. Not the signed receipt.\n\nWith no dos, the date of service is today in US Eastern time.\ndate_of_service_source says which: \"given\" or \"default_today_us_eastern\".","operationId":"check_code_json_v1_check__hcpcs__get","parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","title":"Hcpcs"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state, optional","title":"State"},"description":"Two-letter state, optional"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD, optional","title":"Dos"},"description":"Date of service, YYYY-MM-DD, optional"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/admin/organizations":{"post":{"tags":["Organizations"],"summary":"Create Organization","description":"Create a new organization.","operationId":"create_organization_admin_organizations_post","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","title":"Name"}},{"name":"billing_tier","in":"query","required":false,"schema":{"type":"string","default":"free","title":"Billing Tier"}},{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]},"get":{"tags":["Organizations"],"summary":"List Organizations","description":"List all organizations with usage stats.","operationId":"list_organizations_admin_organizations_get","parameters":[{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/admin/organizations/{org_id}":{"get":{"tags":["Organizations"],"summary":"Get Organization","description":"Get organization detail with members.","operationId":"get_organization_admin_organizations__org_id__get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"integer","title":"Org Id"}},{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]},"patch":{"tags":["Organizations"],"summary":"Update Organization","description":"Update organization tier, limits, or status.","operationId":"update_organization_admin_organizations__org_id__patch","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"integer","title":"Org Id"}},{"name":"billing_tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Tier"}},{"name":"org_rate_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Org Rate Limit"}},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/admin/organizations/{org_id}/members":{"post":{"tags":["Organizations"],"summary":"Add Member","description":"Add a user to an organization.","operationId":"add_member_admin_organizations__org_id__members_post","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"integer","title":"Org Id"}},{"name":"user_id","in":"query","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/admin/organizations/{org_id}/members/{user_id}":{"delete":{"tags":["Organizations"],"summary":"Remove Member","description":"Remove a user from an organization.","operationId":"remove_member_admin_organizations__org_id__members__user_id__delete","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"integer","title":"Org Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"integer","title":"User Id"}},{"name":"X-Admin-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Admin-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/health":{"get":{"tags":["Stats & Measures"],"summary":"Health Check","description":"Shallow health check for CI/CD smoke tests.\n\nStatic response — no dependency checks — so CI probes stay fast and\ncan't fail on transient AWS/DB blips. For a real dependency audit see\n/health/deep.","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[],"deprecated":true}},"/health/deep":{"get":{"tags":["Stats & Measures"],"summary":"Health Check Deep","description":"Deep health check — runs live dependency probes against\nPostgreSQL, S3, SES, and the pipeline freshness window.\n\nSlower than /health (typically 100-500ms) because of network hops.\nNot appropriate for high-frequency CI polling; use /health for that.\n/status renders this same payload as HTML for browser visitors.","operationId":"health_check_deep_health_deep_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[],"deprecated":true}},"/stats":{"get":{"tags":["Stats & Measures"],"summary":"Get Stats","description":"Get API statistics — uses DB counts when in DB mode, in-memory data otherwise.","operationId":"get_stats_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/measures/national":{"get":{"tags":["Stats & Measures"],"summary":"Get National Measures Endpoint","description":"Get national-level aggregate measures (DB mode only)","operationId":"get_national_measures_endpoint_measures_national_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Measure category","title":"Category"},"description":"Measure category"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/measures/state":{"get":{"tags":["Stats & Measures"],"summary":"Get State Measures Endpoint","description":"Get state-level aggregate measures (DB mode only)","operationId":"get_state_measures_endpoint_measures_state_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State code (e.g., CA)","title":"State"},"description":"State code (e.g., CA)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/quarters":{"get":{"tags":["Stats & Measures"],"summary":"Get Quarters Endpoint","description":"List all loaded data quarters (DB mode only)","operationId":"get_quarters_endpoint_quarters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/hospitals/{ccn}":{"get":{"tags":["Hospitals"],"summary":"Get one hospital by CCN","description":"Get a specific hospital by its CMS Certification Number (CCN).\n\nA CCN is a 6-character identifier issued by CMS. Hospital CCNs typically\nstart with 0-4 (state region prefix). Response includes the latest star\nrating, address, bed count, system affiliation (if mapped), and\nlatitude/longitude.","operationId":"get_hospital_hospitals__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","title":"Ccn"},"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","example":"460001"}],"responses":{"200":{"description":"Hospital record with star ratings, address, bed count, system affiliation, and coordinates.","content":{"application/json":{"schema":{},"example":{"ccn":"460001","name":"Intermountain Health Utah Valley Hospital","city":"Provo","state":"UT","zip_code":"84604","overall_rating":5,"type":"Acute Care","beds":395,"system_name":"Intermountain Health","latitude":40.2456,"longitude":-111.6547}}}},"404":{"description":"No hospital found with that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/history":{"get":{"tags":["Hospitals"],"summary":"Star rating history for a hospital","description":"Historical star ratings for a hospital, one row per quarter.\n\nHospitals typically have 30+ quarters of ratings history in our dataset.\nUse this to visualize rating trends or detect a facility that's improving\nor declining.","operationId":"get_hospital_history_hospitals__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","title":"Ccn"},"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","example":"460001"}],"responses":{"200":{"description":"Time series of overall star ratings, oldest to newest.","content":{"application/json":{"schema":{}}}},"404":{"description":"No historical data found for that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/measures":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Measures Endpoint","description":"Get clinical measures for a hospital (DB mode only)","operationId":"get_hospital_measures_endpoint_hospitals__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Measure category (e.g., infections, complications)","title":"Category"},"description":"Measure category (e.g., infections, complications)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/hcahps":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Hcahps Endpoint","description":"Get HCAHPS patient experience data for a hospital (DB mode only)","operationId":"get_hospital_hcahps_endpoint_hospitals__ccn__hcahps_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HCAHPS dimension filter (e.g., nurse_communication, overall_rating)","title":"Dimension"},"description":"HCAHPS dimension filter (e.g., nurse_communication, overall_rating)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/hai":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Hai Endpoint","description":"Get Healthcare Associated Infections (HAI) detail for a hospital","operationId":"get_hospital_hai_endpoint_hospitals__ccn__hai_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/leapfrog":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Leapfrog Endpoint","description":"Get Leapfrog Hospital Safety Grade for a hospital","operationId":"get_hospital_leapfrog_endpoint_hospitals__ccn__leapfrog_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading period (e.g., spring_2025). Defaults to latest.","title":"Period"},"description":"Grading period (e.g., spring_2025). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/leapfrog/history":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Leapfrog History Endpoint","description":"Get all Leapfrog Hospital Safety Grade periods for a hospital","operationId":"get_hospital_leapfrog_history_endpoint_hospitals__ccn__leapfrog_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/case-mix-index":{"get":{"tags":["Hospitals"],"summary":"Get Case Mix Index Endpoint","description":"Get CMS IPPS Impact File history for a hospital: case mix index, wage index, DSH percentage, by fiscal year (DB mode only)","operationId":"get_case_mix_index_endpoint_hospitals__ccn__case_mix_index_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/services":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Services Endpoint","description":"Get service-line availability for a hospital from the CMS Provider of Services file (DB mode only)","operationId":"get_hospital_services_endpoint_hospitals__ccn__services_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals/{ccn}/clinical-trials":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Clinical Trials Endpoint","description":"Get clinical trials with a matched site at this hospital, from ClinicalTrials.gov (DB mode only)","operationId":"get_hospital_clinical_trials_endpoint_hospitals__ccn__clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospitals":{"get":{"tags":["Hospitals"],"summary":"Search hospitals","description":"Search hospitals by state, city, name, rating, or proximity.\n\nCombine filters freely — all filters AND together. For proximity search,\nsupply `lat`, `lng`, and `radius_miles` together. Results include star\nrating, address, bed count, system affiliation (where mapped), and\ncoordinates.\n\nPro tip: for large data pulls, use `limit=1000` with `offset` pagination\nrather than tightening filters — pagination is cheaper than a wider\nfilter's server-side scan.","operationId":"search_hospitals_hospitals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state code.","title":"State"},"description":"2-letter state code.","example":"CA"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City name (case-insensitive, partial match).","title":"City"},"description":"City name (case-insensitive, partial match).","example":"Los Angeles"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"County name (case-insensitive, partial match).","title":"County"},"description":"County name (case-insensitive, partial match).","example":"Los Angeles"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall star rating (1-5).","title":"Min Rating"},"description":"Minimum overall star rating (1-5).","example":4},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall star rating (1-5).","title":"Max Rating"},"description":"Maximum overall star rating (1-5)."},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital name (partial match, case-insensitive).","title":"Name"},"description":"Hospital name (partial match, case-insensitive).","example":"Cedars"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Center latitude for proximity search (decimal degrees).","title":"Lat"},"description":"Center latitude for proximity search (decimal degrees).","example":34.0522},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Center longitude for proximity search (decimal degrees).","title":"Lng"},"description":"Center longitude for proximity search (decimal degrees).","example":-118.2437},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius from (lat, lng) in miles.","title":"Radius Miles"},"description":"Search radius from (lat, lng) in miles.","example":25},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Core-Based Statistical Area code (Census / OMB). See /market-intelligence for CBSA lookups.","title":"Cbsa Code"},"description":"Core-Based Statistical Area code (Census / OMB). See /market-intelligence for CBSA lookups.","example":"19100"},{"name":"metro_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to metro (true) or micro (false) areas only.","title":"Metro Only"},"description":"Filter to metro (true) or micro (false) areas only."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results.","default":100,"title":"Limit"},"description":"Maximum number of results.","example":25},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Skip N results (pagination cursor).","default":0,"title":"Offset"},"description":"Skip N results (pagination cursor).","example":0}],"responses":{"200":{"description":"Paginated hospital results matching the filters.","content":{"application/json":{"schema":{},"example":{"count":5,"results":[{"ccn":"460001","name":"Intermountain Health Utah Valley Hospital","city":"Provo","state":"UT","zip_code":"84604","overall_rating":5,"type":"Acute Care","beds":395,"system_name":"Intermountain Health","latitude":40.2456,"longitude":-111.6547}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/nursing-homes/{ccn}":{"get":{"tags":["Nursing Homes"],"summary":"Get one nursing home by CCN","description":"Get a specific nursing home by its 6-character CCN.\n\nResponse includes the CMS 5-star Nursing Home Compare ratings across\nall four domains (overall, health inspection, quality measures,\nstaffing) plus bed count, penalties, and chain/system affiliation\nwhere mapped.","operationId":"get_nursing_home_nursing_homes__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character Nursing Home CCN.","title":"Ccn"},"description":"6-character Nursing Home CCN.","example":"015009"}],"responses":{"200":{"description":"Nursing home record with 5-star ratings across overall, health inspection, staffing, and quality domains.","content":{"application/json":{"schema":{},"example":{"ccn":"015009","name":"Chapman Nursing & Rehab","state":"AL","overall_rating":3,"health_rating":2,"quality_rating":4,"staffing_rating":3,"beds":98}}}},"404":{"description":"No nursing home with that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/nursing-homes/{ccn}/history":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home History","description":"Get historical star ratings for a specific nursing home","operationId":"get_nursing_home_history_nursing_homes__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/nursing-homes/{ccn}/measures":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home Measures","description":"Get quality measures for a nursing home (DB mode only)","operationId":"get_nursing_home_measures_nursing_homes__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-09). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-09). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/nursing-homes/{ccn}/staffing":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home Staffing","description":"Get staffing data for a nursing home (DB mode only)","operationId":"get_nursing_home_staffing_nursing_homes__ccn__staffing_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/nursing-homes":{"get":{"tags":["Nursing Homes"],"summary":"Search Nursing Homes","description":"Search and filter nursing homes","operationId":"search_nursing_homes_nursing_homes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall rating","title":"Min Rating"},"description":"Minimum overall rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall rating","title":"Max Rating"},"description":"Maximum overall rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dialysis/{ccn}":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Facility","description":"Get a specific dialysis facility by CCN","operationId":"get_dialysis_facility_dialysis__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dialysis/{ccn}/history":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis History","description":"Get historical star ratings for a specific dialysis facility","operationId":"get_dialysis_history_dialysis__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dialysis/{ccn}/measures":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Measures","description":"Get quality measures for a dialysis facility (DB mode only)","operationId":"get_dialysis_measures_dialysis__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-09). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-09). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dialysis/{ccn}/patient-experience":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Patient Experience","description":"Get patient experience data for a dialysis facility (DB mode only)","operationId":"get_dialysis_patient_experience_dialysis__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dialysis":{"get":{"tags":["Dialysis"],"summary":"Search Dialysis","description":"Search and filter dialysis facilities","operationId":"search_dialysis_dialysis_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum star rating","title":"Min Rating"},"description":"Minimum star rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum star rating","title":"Max Rating"},"description":"Maximum star rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/home-health/{ccn}":{"get":{"tags":["Home Health"],"summary":"Get Home Health Agency","description":"Get a specific home health agency by CCN","operationId":"get_home_health_agency_home_health__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/home-health/{ccn}/history":{"get":{"tags":["Home Health"],"summary":"Get Home Health History","description":"Get historical star ratings for a specific home health agency","operationId":"get_home_health_history_home_health__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/home-health/{ccn}/patient-experience":{"get":{"tags":["Home Health"],"summary":"Get Home Health Patient Experience","description":"Get patient experience data for a home health agency (DB mode only)","operationId":"get_home_health_patient_experience_home_health__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/home-health":{"get":{"tags":["Home Health"],"summary":"Search Home Health","description":"Search and filter home health agencies","operationId":"search_home_health_home_health_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum quality rating","title":"Min Rating"},"description":"Minimum quality rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum quality rating","title":"Max Rating"},"description":"Maximum quality rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospice/{ccn}":{"get":{"tags":["Hospice"],"summary":"Get Hospice","description":"Get a specific hospice facility by CCN","operationId":"get_hospice_hospice__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospice/{ccn}/history":{"get":{"tags":["Hospice"],"summary":"Get Hospice History","description":"Get historical quality data for a hospice facility (DB mode only)","operationId":"get_hospice_history_hospice__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospice/{ccn}/measures":{"get":{"tags":["Hospice"],"summary":"Get Hospice Measures","description":"Get quality measures for a hospice facility (DB mode only)","operationId":"get_hospice_measures_hospice__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospice/{ccn}/patient-experience":{"get":{"tags":["Hospice"],"summary":"Get Hospice Patient Experience","description":"Get patient experience data for a hospice facility (DB mode only)","operationId":"get_hospice_patient_experience_hospice__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/hospice":{"get":{"tags":["Hospice"],"summary":"Search Hospice","description":"Search and filter hospice facilities","operationId":"search_hospice_hospice_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by facility name (partial match)","title":"Name"},"description":"Search by facility name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/irf/{ccn}":{"get":{"tags":["IRF"],"summary":"Get Irf","description":"Get a specific IRF (Inpatient Rehabilitation Facility) by CCN","operationId":"get_irf_irf__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/irf/{ccn}/history":{"get":{"tags":["IRF"],"summary":"Get Irf History","description":"Get historical data for an IRF facility (DB mode only)","operationId":"get_irf_history_irf__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/irf/{ccn}/measures":{"get":{"tags":["IRF"],"summary":"Get Irf Measures","description":"Get quality measures for an IRF facility (DB mode only)","operationId":"get_irf_measures_irf__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/irf":{"get":{"tags":["IRF"],"summary":"Search Irf","description":"Search and filter Inpatient Rehabilitation Facilities","operationId":"search_irf_irf_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ltch/{ccn}":{"get":{"tags":["LTCH"],"summary":"Get Ltch","description":"Get a specific LTCH (Long-Term Care Hospital) by CCN","operationId":"get_ltch_ltch__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ltch/{ccn}/history":{"get":{"tags":["LTCH"],"summary":"Get Ltch History","description":"Get historical data for an LTCH facility (DB mode only)","operationId":"get_ltch_history_ltch__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ltch/{ccn}/measures":{"get":{"tags":["LTCH"],"summary":"Get Ltch Measures","description":"Get quality measures for an LTCH facility (DB mode only)","operationId":"get_ltch_measures_ltch__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ltch":{"get":{"tags":["LTCH"],"summary":"Search Ltch","description":"Search and filter Long-Term Care Hospitals","operationId":"search_ltch_ltch_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/groups/{org_pac_id}/measures":{"get":{"tags":["Clinicians"],"summary":"Get Group Measures","description":"Get group-level measure detail for an organization","operationId":"get_group_measures_clinicians_groups__org_pac_id__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific quarter (defaults to latest)","title":"Quarter"},"description":"Specific quarter (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/qpp-cohorts/{cohort}":{"get":{"tags":["Clinicians"],"summary":"Get Qpp Cohort","description":"The clinicians of one inferred practice cohort in one performance year.\n\nA cohort is inferred, not stated: CMS's QPP Experience file names no\npractice, but it repeats state, practice size, Medicare patients and\nallowed charges on every Group row of one practice. Treat a small cohort\nas low confidence. Find a cohort from `/clinicians/{npi}/qpp-history`.","operationId":"get_qpp_cohort_clinicians_qpp_cohorts__cohort__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"cohort","in":"path","required":true,"schema":{"type":"string","title":"Cohort"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/{npi}":{"get":{"tags":["Clinicians"],"summary":"Get Clinician","description":"Get a specific clinician by NPI with latest MIPS scores","operationId":"get_clinician_clinicians__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/{npi}/history":{"get":{"tags":["Clinicians"],"summary":"Get Clinician History","description":"MIPS score history for a clinician, one row per CMS release month.\n\n`quarter` is the month CMS published the release, not the MIPS\nperformance year: the 2026-09 release carries PY2024 scores. For scores\nkeyed by performance year, use `/clinicians/{npi}/performance-years`.","operationId":"get_clinician_history_clinicians__npi__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/{npi}/qpp-history":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Qpp History","description":"CMS QPP Experience rows for a clinician, PY2017 onward.\n\nOne row per practice the clinician reported with, per performance year:\nthe participation path, practice size and state, special statuses, final\nand category scores, and the payment adjustment. `medicare_patients`,\n`allowed_charges` and `services` are the practice's totals. Group rows\ncarry an inferred `practice_cohort` and its size.","operationId":"get_clinician_qpp_history_clinicians__npi__qpp_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/{npi}/performance-years":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Performance Years","description":"MIPS scores per performance year, PY2017 onward.\n\nEach entry is one performance year, from the CMS release that states\nthat year. CMS publishes one score per group the clinician reported with,\nplus any individual or APM score, so `scores` lists each with its group\n(`org_pac_id`) and category scores. `highest_final_mips_score` is the\nhighest final score CMS published for the clinician that year, across all\nits scores. CMS applies the payment adjustment per TIN/NPI, using the\nhighest final score for that TIN/NPI, so a clinician who bills under\nseveral groups can have a different adjustment in each. `apm_programs`\nare the programs CMS states for the clinician that year, such as SSP or\nREACH.\nPY2017 names no group.","operationId":"get_clinician_performance_years_clinicians__npi__performance_years_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians/{npi}/measures":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Measures","description":"Get measure-level detail for a clinician","operationId":"get_clinician_measures_clinicians__npi__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific quarter (defaults to latest)","title":"Quarter"},"description":"Specific quarter (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinicians":{"get":{"tags":["Clinicians"],"summary":"Search Clinicians","description":"Search and filter clinicians by name, organization, state, specialty, or MIPS score.\nName, org_pac_id, or specialty is required — unfiltered queries on 1M+ clinicians are too expensive.","operationId":"search_clinicians_clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by clinician name (partial match)","title":"Name"},"description":"Search by clinician name (partial match)"},{"name":"org_pac_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by organization PAC ID","title":"Org Pac Id"},"description":"Filter by organization PAC ID"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., AL, CA, TX)","title":"State"},"description":"Filter by state (e.g., AL, CA, TX)"},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by specialty (partial match, e.g., 'Cardiology', 'Orthopedic')","title":"Specialty"},"description":"Filter by specialty (partial match, e.g., 'Cardiology', 'Orthopedic')"},{"name":"gender","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by gender (M or F)","title":"Gender"},"description":"Filter by gender (M or F)"},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"description":"Minimum final MIPS score","title":"Min Score"},"description":"Minimum final MIPS score"},{"name":"max_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"description":"Maximum final MIPS score","title":"Max Score"},"description":"Maximum final MIPS score"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/asc/{ccn}":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc","description":"Get a specific ASC facility by CCN","operationId":"get_asc_asc__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/asc/{ccn}/history":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc History","description":"Get historical quality data for an ASC facility","operationId":"get_asc_history_asc__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/asc/{ccn}/measures":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc Measures","description":"Get quality measures for an ASC facility","operationId":"get_asc_measures_asc__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/asc/{ccn}/patient-experience":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc Patient Experience","description":"Get OAS CAHPS patient experience data for an ASC facility","operationId":"get_asc_patient_experience_asc__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/asc":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Search Ascs","description":"Search and filter ASC facilities","operationId":"search_ascs_asc_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by facility name (partial match)","title":"Name"},"description":"Search by facility name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/distressed":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Find Distressed Hospitals","description":"Find hospitals with negative operating margins (financial distress indicators).","operationId":"find_distressed_hospitals_cost_reports_distressed_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":100,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/compare":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Compare Cost Reports Endpoint","description":"Compare cost reports for multiple hospitals side by side.","operationId":"compare_cost_reports_endpoint_cost_reports_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccns","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated CCNs to compare","title":"Ccns"},"description":"Comma-separated CCNs to compare"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}/financial-health":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Financial Health","description":"Financial health analysis: margin trends, YoY changes, distress indicators.","operationId":"get_financial_health_cost_reports__ccn__financial_health_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Report Endpoint","description":"Get the latest hospital cost report by CCN.","operationId":"get_cost_report_endpoint_cost_reports__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}/history":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Report History Endpoint","description":"Get all historical cost reports for a hospital.","operationId":"get_cost_report_history_endpoint_cost_reports__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}/balance-sheet":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Balance Sheet Endpoint","description":"HCRIS Worksheet G (balance sheet) history for a hospital, with derived liquidity ratios.","operationId":"get_balance_sheet_endpoint_cost_reports__ccn__balance_sheet_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}/charity-care":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Charity Care Endpoint","description":"HCRIS Worksheet S-10 (uncompensated/indigent care) history for a hospital.","operationId":"get_charity_care_endpoint_cost_reports__ccn__charity_care_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports/{ccn}/cost-centers":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Centers Endpoint","description":"Cost-center detail (charges, total costs, salary/non-salary split) for a hospital.","operationId":"get_cost_centers_endpoint_cost_reports__ccn__cost_centers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year_end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fiscal year end date (YYYY-MM-DD). Defaults to latest.","title":"Fiscal Year End"},"description":"Fiscal year end date (YYYY-MM-DD). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/cost-reports":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Search Cost Reports Endpoint","description":"Search hospital cost reports with filters.","operationId":"search_cost_reports_endpoint_cost_reports_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., AL, TX)","title":"State"},"description":"Filter by state (e.g., AL, TX)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital name (partial match)","title":"Name"},"description":"Hospital name (partial match)"},{"name":"min_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum bed count","title":"Min Beds"},"description":"Minimum bed count"},{"name":"max_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Maximum bed count","title":"Max Beds"},"description":"Maximum bed count"},{"name":"min_revenue","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum total revenue","title":"Min Revenue"},"description":"Minimum total revenue"},{"name":"max_revenue","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Maximum total revenue","title":"Max Revenue"},"description":"Maximum total revenue"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (e.g., 2023)","title":"Year"},"description":"Fiscal year (e.g., 2023)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Max results","default":100,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/check/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Federal exclusion check by NPI","description":"Check whether an NPI is currently on the HHS OIG exclusion list.\n\nFederal law (42 CFR 1001.1901) requires any entity that receives\nfederal healthcare payments to screen its providers against the OIG\nLEIE monthly. This endpoint is the machine-readable path for that\ncompliance requirement.\n\nResponse includes the check timestamp and the source list version so\nyou have an audit trail. For batch screening of many NPIs at once,\nuse `POST /exclusions/batch-screen`.","operationId":"check_exclusion_exclusions_check__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1234567890"}],"responses":{"200":{"description":"Whether the NPI appears on the HHS OIG List of Excluded Individuals/Entities.","content":{"application/json":{"schema":{},"example":{"npi":"1234567890","excluded":false,"checked_against":"OIG_LEIE","as_of":"2026-06-15"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/comprehensive/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Combined federal + state exclusion check by NPI","description":"Check an NPI against the federal OIG LEIE AND every loaded state\nMedicaid exclusion list in one call.\n\nState lists are additive coverage: about 70% of state-excluded NPIs\nnever appear in LEIE, so a federal-only check misses them. The\ntop-level `excluded` flag is true when any list — federal or state —\ncurrently excludes the NPI. See `GET /exclusions/state/coverage` for\nwhich states are loaded and how fresh each list is.","operationId":"comprehensive_check_exclusions_comprehensive__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/state/coverage":{"get":{"tags":["OIG Exclusions"],"summary":"State exclusion list coverage","description":"Which state Medicaid exclusion lists are loaded, with per-state\nrecord counts, NPI coverage, LEIE overlap, and last-load timestamps.\nLists sync monthly from each state's primary public source.","operationId":"state_exclusion_coverage_exclusions_state_coverage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/exclusions/state/search":{"get":{"tags":["OIG Exclusions"],"summary":"Search state exclusion lists","description":"Search the state Medicaid exclusion lists. Most state records\ncarry a name only (no NPI) — name search is the primary path here.","operationId":"search_state_exclusions_exclusions_state_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Program state, e.g. CA","title":"State"},"description":"Program state, e.g. CA"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or business name (partial match)","title":"Name"},"description":"Name or business name (partial match)"},{"name":"entity_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"individual | business | unknown","title":"Entity Type"},"description":"individual | business | unknown"},{"name":"active_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only currently-excluded records","default":false,"title":"Active Only"},"description":"Only currently-excluded records"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/state/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"State exclusion check by NPI","description":"Check an NPI against every loaded state Medicaid exclusion list.\nRecords the state published without an NPI cannot match here — use\n`GET /exclusions/state/search` for name-based screening.","operationId":"check_state_exclusions_exclusions_state__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/search":{"get":{"tags":["OIG Exclusions"],"summary":"Search Exclusions","description":"Search OIG exclusions by state, name, or exclusion type","operationId":"search_exclusions_exclusions_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"excltype","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by exclusion type code","title":"Excltype"},"description":"Filter by exclusion type code"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/crossref/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Cross Reference Npi","description":"Cross-reference an NPI across all datasets: exclusions, utilization, prescribing, clinicians.\nFlags excluded NPIs that still appear in active Medicare data.","operationId":"cross_reference_npi_exclusions_crossref__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/exclusions/screen":{"post":{"tags":["OIG Exclusions"],"summary":"Batch Screen","description":"Screen a batch of NPIs against the federal OIG LEIE and every\nloaded state Medicaid exclusion list. Returns hits only — federal\nhits under `excluded`, state-list hits under `state_excluded`.\nMax 500 NPIs per request.","operationId":"batch_screen_exclusions_screen_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","maxItems":500,"title":"Npis","description":"List of NPIs to screen"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/exclusions/recent":{"get":{"tags":["OIG Exclusions"],"summary":"Get Recent Exclusions","description":"Get recently excluded providers within the last N days","operationId":"get_recent_exclusions_exclusions_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"description":"Number of days to look back","default":30,"title":"Days"},"description":"Number of days to look back"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ma-plans/search":{"get":{"tags":["MA Plans"],"summary":"Search Plans","description":"Search Medicare Advantage and Part D plans","operationId":"search_plans_ma_plans_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by contract state","title":"State"},"description":"Filter by contract state"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by organization name (partial match)","title":"Name"},"description":"Search by organization name (partial match)"},{"name":"org_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by organization type (e.g., 'Local CCP', 'PDP')","title":"Org Type"},"description":"Filter by organization type (e.g., 'Local CCP', 'PDP')"},{"name":"parent","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by parent organization (partial match)","title":"Parent"},"description":"Search by parent organization (partial match)"},{"name":"min_stars","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall star rating","title":"Min Stars"},"description":"Minimum overall star rating"},{"name":"max_stars","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall star rating","title":"Max Stars"},"description":"Maximum overall star rating"},{"name":"bonus_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only return plans qualifying for QBP (4+ stars)","default":false,"title":"Bonus Only"},"description":"Only return plans qualifying for QBP (4+ stars)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ma-plans/compare":{"get":{"tags":["MA Plans"],"summary":"Compare Plans","description":"Compare multiple MA plans side by side","operationId":"compare_plans_ma_plans_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contracts","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated contract IDs (e.g., H0028,H1036)","title":"Contracts"},"description":"Comma-separated contract IDs (e.g., H0028,H1036)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ma-plans/{contract_id}":{"get":{"tags":["MA Plans"],"summary":"Get Plan","description":"Get a specific MA plan by contract ID (e.g., H0028)","operationId":"get_plan_ma_plans__contract_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ma-plans/{contract_id}/history":{"get":{"tags":["MA Plans"],"summary":"Get Plan History","description":"Get historical star ratings for an MA plan","operationId":"get_plan_history_ma_plans__contract_id__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/open-payments/by-physician/{npi}":{"get":{"tags":["Open Payments"],"summary":"Open Payments By Physician","description":"Get all Open Payments records for a physician by NPI.","operationId":"open_payments_by_physician_open_payments_by_physician__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year (e.g., 2023)","title":"Year"},"description":"Filter by year (e.g., 2023)"},{"name":"payment_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: general, research, or ownership","title":"Payment Type"},"description":"Filter: general, research, or ownership"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/open-payments/by-physician/{npi}/summary":{"get":{"tags":["Open Payments"],"summary":"Open Payments Physician Summary","description":"Get aggregated payment summary for a physician — totals, top companies, yearly breakdown.","operationId":"open_payments_physician_summary_open_payments_by_physician__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/open-payments/by-company":{"get":{"tags":["Open Payments"],"summary":"Open Payments By Company","description":"Get payments made by a specific pharmaceutical/device company.","operationId":"open_payments_by_company_open_payments_by_company_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"company","in":"query","required":true,"schema":{"type":"string","description":"Company name (partial match)","title":"Company"},"description":"Company name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/open-payments/search":{"get":{"tags":["Open Payments"],"summary":"Open Payments Search","description":"Search Open Payments with multiple filters. At least one filter is required.","operationId":"open_payments_search_open_payments_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"physician_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Physician name (partial match)","title":"Physician Name"},"description":"Physician name (partial match)"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company name (partial match)","title":"Company"},"description":"Company name (partial match)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by NPI","title":"Npi"},"description":"Filter by NPI"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., CA, TX)","title":"State"},"description":"Filter by state (e.g., CA, TX)"},{"name":"nature_of_payment","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Payment nature (e.g., Food and Beverage)","title":"Nature Of Payment"},"description":"Payment nature (e.g., Food and Beverage)"},{"name":"min_amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Minimum payment amount","title":"Min Amount"},"description":"Minimum payment amount"},{"name":"max_amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Maximum payment amount","title":"Max Amount"},"description":"Maximum payment amount"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"payment_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: general, research, or ownership","title":"Payment Type"},"description":"Filter: general, research, or ownership"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/physician-utilization/search":{"get":{"tags":["Physician Utilization"],"summary":"Search Utilization","description":"Search physician utilization records by specialty, state, procedure, or name.\nAt least one filter is required.","operationId":"search_utilization_physician_utilization_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by provider specialty (partial match)","title":"Specialty"},"description":"Filter by provider specialty (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TX, CA)","title":"State"},"description":"Filter by state (e.g., TX, CA)"},{"name":"hcpcs_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by HCPCS procedure code","title":"Hcpcs Code"},"description":"Filter by HCPCS procedure code"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year (e.g., 2022)","title":"Year"},"description":"Filter by year (e.g., 2022)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/physician-utilization/by-procedure/{hcpcs_code}":{"get":{"tags":["Physician Utilization"],"summary":"Get By Procedure","description":"Find top physicians performing a specific HCPCS procedure code.","operationId":"get_by_procedure_physician_utilization_by_procedure__hcpcs_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs_code","in":"path","required":true,"schema":{"type":"string","title":"Hcpcs Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/physician-utilization/{npi}/benchmarks":{"get":{"tags":["Physician Utilization"],"summary":"Get Benchmarks","description":"Compare a physician's utilization against specialty/state peers with percentile ranks.","operationId":"get_benchmarks_physician_utilization__npi__benchmarks_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year for benchmarks (defaults to latest)","title":"Year"},"description":"Year for benchmarks (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/physician-utilization/{npi}/summary":{"get":{"tags":["Physician Utilization"],"summary":"Get Utilization Summary","description":"Get utilization summary for a physician: top procedures, total volumes, payments.","operationId":"get_utilization_summary_physician_utilization__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/physician-utilization/{npi}":{"get":{"tags":["Physician Utilization"],"summary":"Get Utilization","description":"Get all procedures for a physician by NPI (paginated).","operationId":"get_utilization_physician_utilization__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/prescriber/search":{"get":{"tags":["Part D Prescriber"],"summary":"Search Prescriber","description":"Search prescriber records by drug, state, or NPI.\nAt least one filter is required.","operationId":"search_prescriber_prescriber_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by drug brand name (partial match)","title":"Drug"},"description":"Search by drug brand name (partial match)"},{"name":"generic","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by generic drug name (partial match)","title":"Generic"},"description":"Search by generic drug name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., CA)","title":"State"},"description":"Filter by state (e.g., CA)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by NPI","title":"Npi"},"description":"Filter by NPI"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year (e.g., 2022)","title":"Year"},"description":"Filter by year (e.g., 2022)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/prescriber/by-drug/{drug_name}":{"get":{"tags":["Part D Prescriber"],"summary":"Get By Drug","description":"Find top prescribers of a specific drug (brand name, partial match).","operationId":"get_by_drug_prescriber_by_drug__drug_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"drug_name","in":"path","required":true,"schema":{"type":"string","title":"Drug Name"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/prescriber/{npi}/analytics":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber Analytics","description":"Prescriber analytics: generic vs brand prescribing rate and opioid profile.","operationId":"get_prescriber_analytics_prescriber__npi__analytics_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/prescriber/{npi}/summary":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber Summary","description":"Get prescriber summary: top drugs, total cost, total claims.","operationId":"get_prescriber_summary_prescriber__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/prescriber/{npi}":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber","description":"Get all drugs prescribed by a physician (paginated).","operationId":"get_prescriber_prescriber__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/shortage-areas":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Search Shortage Areas","description":"Search HPSA shortage areas with filters","operationId":"search_shortage_areas_shortage_areas_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"discipline","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by discipline (Primary Care, Dental Health, Mental Health)","title":"Discipline"},"description":"Filter by discipline (Primary Care, Dental Health, Mental Health)"},{"name":"hpsa_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by HPSA type (Geographic, Population, Facility)","title":"Hpsa Type"},"description":"Filter by HPSA type (Geographic, Population, Facility)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by designation status (Designated, Withdrawn)","title":"Status"},"description":"Filter by designation status (Designated, Withdrawn)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/shortage-areas/summary":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Get Shortage Area Summary","description":"Get summary of HPSA shortage areas by state and discipline","operationId":"get_shortage_area_summary_shortage_areas_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/shortage-areas/by-county/{fips_code}":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Get Shortage Areas By County","description":"Get all shortage area designations for a county by FIPS code","operationId":"get_shortage_areas_by_county_shortage_areas_by_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/enrollments/by-ccn/{ccn}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get Enrollment By Ccn","description":"Get enrollment records for a hospital by CCN","operationId":"get_enrollment_by_ccn_enrollments_by_ccn__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/enrollments/by-npi/{npi}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get Enrollment By Npi","description":"Get enrollment records for a hospital by NPI","operationId":"get_enrollment_by_npi_enrollments_by_npi__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/enrollments/search":{"get":{"tags":["Hospital Enrollments"],"summary":"Search Enrollments","description":"Search hospital enrollment records","operationId":"search_enrollments_enrollments_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TN, FL)","title":"State"},"description":"Filter by state (e.g., TN, FL)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by hospital or organization name","title":"Name"},"description":"Search by hospital or organization name"},{"name":"organization","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by organization name only","title":"Organization"},"description":"Search by organization name only"},{"name":"ownership","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"P=Proprietary, N=Non-profit","title":"Ownership"},"description":"P=Proprietary, N=Non-profit"},{"name":"subgroup","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by subgroup: acute_care, childrens, psychiatric, rehabilitation, long_term, swing_bed","title":"Subgroup"},"description":"Filter by subgroup: acute_care, childrens, psychiatric, rehabilitation, long_term, swing_bed"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/enrollments/systems":{"get":{"tags":["Hospital Enrollments"],"summary":"List Systems","description":"List all known health systems with hospital counts","operationId":"list_systems_enrollments_systems_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/enrollments/systems/{system_name}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get System Hospitals","description":"Get all hospitals in a health system by system name","operationId":"get_system_hospitals_enrollments_systems__system_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_name","in":"path","required":true,"schema":{"type":"string","title":"System Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":500,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dac/search":{"get":{"tags":["DAC Provider Directory"],"summary":"Search Providers","description":"Search the DAC provider directory with filters.","operationId":"search_providers_dac_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TX, CA)","title":"State"},"description":"Filter by state (e.g., TX, CA)"},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by primary specialty","title":"Specialty"},"description":"Search by primary specialty"},{"name":"org_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by group practice name","title":"Org Name"},"description":"Search by group practice name"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name","title":"Name"},"description":"Search by provider name"},{"name":"telehealth","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter telehealth providers only","title":"Telehealth"},"description":"Filter telehealth providers only"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dac/group/{org_pac_id}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Group Members","description":"Get all providers in a group practice by organization PAC ID.","operationId":"get_group_members_dac_group__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dac/hospital/{ccn}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Hospital Affiliates","description":"Get providers affiliated with a hospital by CCN.","operationId":"get_hospital_affiliates_dac_hospital__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dac/{npi}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Provider","description":"Get DAC record for a single NPI with group and hospital affiliations.","operationId":"get_provider_dac__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/pecos/enrollment/org/{org_name}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Org Enrollees","description":"Get providers enrolled under an organization.","operationId":"get_org_enrollees_pecos_enrollment_org__org_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_name","in":"path","required":true,"schema":{"type":"string","title":"Org Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/pecos/enrollment/{npi}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Enrollment","description":"Get PECOS enrollment records for an individual NPI.","operationId":"get_enrollment_pecos_enrollment__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/pecos/reassignment/org/{org_pac_id}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Org Reassignees","description":"Get individuals who bill through an organization (by org PAC ID).","operationId":"get_org_reassignees_pecos_reassignment_org__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/pecos/reassignment/{npi}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Reassignments","description":"Get organizations this provider bills through (reassignment/855R).","operationId":"get_reassignments_pecos_reassignment__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}":{"get":{"tags":["Providers — Profile"],"summary":"Full provider dossier by NPI","description":"Unified provider dossier — the marquee cross-source lookup.\n\nJoins these datasets on the NPI, on one database connection:\n- **NPPES**: provider identity, specialty, address\n- **Open Payments**: industry payments, totals and one row per program year (`open_payments.by_year`)\n- **Physician Utilization**: Medicare billing patterns, totals and by year; `cms_summary` carries\n  CMS's by-provider totals, which include the services CMS suppresses from the per-service rows\n- **Part D Prescriber**: drug prescribing profile, totals and by year; `cms_summary` carries\n  CMS's by-provider totals, which include the drugs CMS suppresses from the per-drug rows\n- In both blocks, `years_covered` gives the years of the detail rows. When CMS suppressed every\n  detail row, it gives the years of `cms_summary`, and the other detail fields are null.\n- **OIG Exclusions**: federal exclusion status\n- **DAC and PECOS**: group practice, facility affiliations, billing organizations\n- **License, quality, financial and clinical-trial** summary cards with deep links\n\nUse this for due diligence, compliance screening, or building\nprovider-comparison tools. For domain-specific detail, see the\nsub-resources: `/provider/{npi}/quality`, `/provider/{npi}/licenses`,\n`/provider/{npi}/employment`, `/provider/{npi}/financial-affiliation`.","operationId":"get_provider_profile_provider__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1245319599"}],"responses":{"200":{"description":"Cross-source dossier for the provider. Includes NPPES identity, Open Payments, Physician Utilization, Part D Prescriber, OIG exclusion status, and attribution signals.","content":{"application/json":{"schema":{},"example":{"npi":"1245319599","entity_type":"individual","identity":{"name":"JANE DOE","credential":"M.D.","specialty":"Internal Medicine Physician","taxonomy_code":"207R00000X","deactivated":false},"location":{"city":"SALT LAKE CITY","state":"UT","zip_code":"841320000"},"quality":{"data_period":"2026-09","final_mips_score":82.9},"prescribing":{"unique_drugs":16,"total_claims":504,"total_drug_cost":49545.98,"years_covered":"2020-2024","opioid_claim_rate_pct":0.0,"high_opioid_prescriber":false,"by_year":[{"year":2024,"unique_drugs":14,"total_claims":387,"total_drug_cost":41460.24}],"cms_summary":{"source":"CMS Medicare Part D Prescribers - by Provider","note":"CMS's own per-prescriber totals. They include the drugs CMS suppresses from the per-drug rows (fewer than 11 claims), so they can be higher than the per-drug figures in this block.","by_year":[{"year":2024,"total_claims":488,"total_drug_cost":70415.29,"total_beneficiaries":118}]}},"utilization":{"unique_procedures":17,"total_services":985.0,"total_beneficiaries":841,"total_medicare_payments":81689.21,"years_covered":"2020-2024","by_year":[{"year":2024,"unique_procedures":17,"total_services":773.0,"total_beneficiaries":649,"total_medicare_payments":52524.51}],"cms_summary":{"source":"CMS Medicare Physician & Other Practitioners - by Provider","note":"CMS's own per-provider totals. They include the services CMS suppresses from the per-service rows (fewer than 11 beneficiaries), so they can be higher than the per-service figures in this block.","by_year":[{"year":2024,"total_services":901.0,"total_beneficiaries":447,"total_medicare_payments":70587.8}]}},"open_payments":{"data_available":true,"record_count":36,"payment_count":36,"total_amount":9373.5,"ownership_interest_value":0.0,"manufacturer_count":6,"years_covered":"2025-2025","by_payment_type":{"general":{"record_count":30,"payment_count":30,"total_amount":9000.0},"research":{"record_count":6,"payment_count":6,"total_amount":373.5}},"by_year":[{"program_year":2025,"record_count":36,"payment_count":36,"total_amount":9373.5,"ownership_interest_value":0.0,"manufacturer_count":6,"by_payment_type":{"general":{"record_count":30,"payment_count":30,"total_amount":9000.0},"research":{"record_count":6,"payment_count":6,"total_amount":373.5}}}],"deep_link":"/open-payments/by-physician/1245319599/summary"},"compliance":{"oig_excluded":false,"exclusion_count":0,"exclusion_history":[]},"data_available":{"nppes":true,"mips_quality":true,"partd_prescribing":true,"physician_utilization":true,"open_payments":true,"oig_exclusions":false,"dac_directory":true,"pecos_reassignment":true,"clinical_trials":false},"risk_flags":[]}}}},"404":{"description":"No provider found for that NPI."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/quality":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Quality","description":"MIPS score history + ACO/affiliation context for a provider.\n\nReturns the 20 most-recent quarters of CMS MIPS scoring (quality / cost /\nIA / PI subscores plus final score), plus this NPI's clinicians-affiliation\n(org_pac_id, facility, system attribution from v2 crosswalk including EIN\nwhere org_eins has it).\n\nLives under /provider/{npi}/quality (canonical NPI dossier sub-resource).\nFor specialty leaderboards and system-level MIPS rollups, see /mips/*.","operationId":"get_provider_quality_provider__npi__quality_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/licenses":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Licenses","description":"All state-issued licenses for a provider + disciplinary action summary.\n\nLives under /provider/{npi}/licenses (canonical NPI dossier sub-resource).\nFor state-level overviews and cross-state alert feeds, see /licenses/*.","operationId":"get_provider_licenses_provider__npi__licenses_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/licenses/disciplinary":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Disciplinary","description":"Full disciplinary action history for a provider across all loaded states.","operationId":"get_provider_disciplinary_provider__npi__licenses_disciplinary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/financial-affiliation":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Financial Affiliation","description":"Links a physician's PECOS billing employer to its financial profile.\n\nSurfaces the employer's EIN + system_id + most-recent revenue +\nworkforce headcount, plus any exec-comp match when the physician is\nthemselves a top-compensated executive (rare but happens for academic\nmedical center deans, hospital CEOs who are MDs, etc.).","operationId":"get_provider_financial_affiliation_provider__npi__financial_affiliation_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/clinical-trials":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Clinical Trials","description":"Clinical trials where this provider is listed as an investigator (ClinicalTrials.gov).","operationId":"get_provider_clinical_trials_provider__npi__clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/employment":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Employment","description":"Resolve all current billing-org employers for an NPI, with parent-system attribution.\n\nSource: PECOS Medicare billing reassignment (NPI -> org PAC ID) joined to\nNPPES, DAC, hospital_enrollments, the physician_employer_systems\ncrosswalk, and the employer_facts aggregate. Each employer entry includes\nconfidence + attribution method, employer_type (hospital_system /\npe_platform / payer_vertical / staffing / academic_faculty / safety_net /\ngovernment / physician_partnership / independent_group), solo-PC flag,\nand pre-aggregated scale (distinct NPIs, primary state, specialty mix).\n\nThe summary block tells callers how concentrated the panel is and which\nemployer-type buckets the physician sits in — the consolidation-trend\nquestion is \"is this MD employed by a PE platform or a payer?\" not \"who's\ntheir hospital.\"","operationId":"get_provider_employment_provider__npi__employment_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208). Excludes PAs, APRNs, nurses, dentists, optometrists, podiatrists.","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208). Excludes PAs, APRNs, nurses, dentists, optometrists, podiatrists."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/employment/history":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Employment History","description":"Temporal employment history for an NPI from pecos_reassignment_history snapshots.\n\nEach snapshot is a point-in-time capture taken when the PECOS loader runs\n(currently monthly). History entries bracket employment windows with\neffective_from / effective_to. The `data_quality.is_meaningful` flag\nindicates whether the history table has accumulated enough snapshots to\nshow change — meaningful from the second snapshot onward.\n\nUse this for: tracking when a physician changed employers, supporting\n\"who left System X in the past 6 months\" queries, and feeding\nconsolidation-trend analysis. Per-event date granularity is bounded by\nsnapshot cadence — we know an employer relationship existed at snapshot\nT, not the exact day it started.","operationId":"get_provider_employment_history_provider__npi__employment_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/employment/primary":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Primary Employer","description":"Best-guess primary employer for an NPI.\n\nSelects the single most-likely current employer from the physician's PECOS\nreassignments using a deterministic ranking: (1) sole employer; (2) DAC\npractice-location corroboration; (3) state match against NPPES; (4) largest\nby distinct-NPI count; (5) alphabetical tiebreaker. The response includes\n`ranking_signals[]` with the methods that fired and their confidence, plus\nannual Medicare allowed-amount totals for the NPI as context.\n\nNote on claims attribution: Medicare claims data is keyed to the rendering\nNPI, not the billing org. We do NOT compute \"% of claims at this employer\"\nbecause that data doesn't exist publicly. Use the signal trail to judge\nwhether the primary-employer pick is reliable for your use case.","operationId":"get_provider_primary_employer_provider__npi__employment_primary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/acos":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Acos","description":"ACO membership links for an NPI, each with its match method and confidence.\n\nCMS publishes MSSP participants and ACO REACH providers by legal business\nname only. This resource serves the NPI-keyed links Verzi derives, and says\nfor every row how it was made:\n\n- `cms_qpp_participation` (confidence `high`, or `stated_unresolved`): CMS's\n  QPP participation status names the APM entity for the NPI; the entity\n  name is resolved to an ACO ID by name.\n- `organization_name_match` (`medium`): the NPI's PECOS billing organization\n  carries the same legal business name as an MSSP participant.\n- `individual_name_match` (`low`): an ACO REACH participant name equal to the\n  NPI's NPPES name and unique nationally.\n\nA name match is never presented as exact. Treat `medium` and `low` rows as\nleads to verify. `deep_link` opens the ACO's own resource.","operationId":"get_provider_acos_provider__npi__acos_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1245319599"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/employers":{"get":{"tags":["Physician Employment Intelligence"],"summary":"By Specialty","description":"Groups ranked by how many members have the given primary specialties.\n\nAnswers \"every anesthesia group in the US and how many anesthesiologists\nand CRNAs each one has\". Counts come from the CMS Doctors and Clinicians\nfile (one row per clinician per group, so a clinician in two groups\ncounts in both). Parent system and employer_type come from the curated\ncrosswalk; a null employer_type means we hold no label, not that the\ngroup is independent.","operationId":"by_specialty_employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"DAC primary specialty, exact CMS wording, case-insensitive. Repeat for more than one. At most 10. Example: specialty=ANESTHESIOLOGY&specialty=CERTIFIED REGISTERED NURSE ANESTHETIST (CRNA).","title":"Specialty"},"description":"DAC primary specialty, exact CMS wording, case-insensitive. Repeat for more than one. At most 10. Example: specialty=ANESTHESIOLOGY&specialty=CERTIFIED REGISTERED NURSE ANESTHETIST (CRNA)."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Count only members in this state.","title":"State"},"description":"Count only members in this state."},{"name":"min_providers","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Leave out groups with fewer matching members.","default":1,"title":"Min Providers"},"description":"Leave out groups with fewer matching members."},{"name":"employer_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["hospital_system","academic_faculty","pe_platform","payer_vertical","physician_partnership","staffing","safety_net","government","independent_group"],"type":"string"},{"type":"null"}],"description":"Only groups with this curated employer type.","title":"Employer Type"},"description":"Only groups with this curated employer type."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/employers/search":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Search","description":"Autocomplete by employer name.\n\nSearches DAC's org_name (GIN trigram index) then joins to employer_facts so\nevery match includes scale (distinct NPIs), geography (primary state), and\nparent-system attribution when available. Use for typeahead UI or to\nresolve a free-text employer to a stable org_pac_id.","operationId":"search_employers_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"description":"Substring of org name (case-insensitive).","title":"Q"},"description":"Substring of org name (case-insensitive)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/employers/{org_pac_id}":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Detail","description":"Employer detail: scale, parent system, geography, specialty mix, hospital affiliations.\n\nBacked by employer_facts MV + physician_employer_systems crosswalk +\non-demand DAC aggregation for the specialty / state breakdowns. Returns\n404 if the org_pac_id has no PECOS reassignments (i.e., no NPIs bill\nunder it).","operationId":"detail_employers__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/employers/{org_pac_id}/physicians":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Physicians","description":"Paginated list of physicians currently billing under this employer's PAC ID.\n\nResolves NPIs from PECOS reassignment, enriches with DAC specialty/state\nand NPPES identity, and applies optional filters. The total_count reflects\nthe full filtered set; use limit/offset to page.","operationId":"physicians_employers__org_pac_id__physicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring match on DAC pri_spec (case-insensitive).","title":"Specialty"},"description":"Substring match on DAC pri_spec (case-insensitive)."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state filter.","title":"State"},"description":"2-letter state filter."},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208).","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Detail","description":"System rollup: scale, state mix, specialty mix, top captive employers, hospital CCN count.\n\nA system is identified by the same system_id used in hospital_systems where\none exists (Kaiser, Northwell, Mayo, etc.) and by synthetic IDs for\nnon-hospital systems (USAP, OPTUM, ENVISION, etc.). Returns 404 if no\ncaptive employer is mapped to the system_id.","operationId":"detail_systems__system_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/divisions":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Divisions","description":"Child systems under a parent system.\n\nFor hierarchical for-profits (Tenet → USPI + regional divisions) and nonprofit parents\nwith related operating subsidiaries (Sutter Health → PAMF/EBMF/SMG/...),\nthis returns the direct children with per-child scale aggregates.\nReturns 404 if the system_id has no children in system_hierarchy.\n\nThe parent rollup at /systems/{system_id} aggregates automatically\nacross all transitive descendants — use this endpoint to enumerate\nthem explicitly.","operationId":"divisions_systems__system_id__divisions_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/employers":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Employers","description":"All captive billing PAC IDs (medical groups) under a system.\n\nReturns the dimension-table list of every classified employer with its\nemployer_type, attribution method, and scale. Use this to enumerate the\ncaptive medical groups that bill under a single parent system.","operationId":"employers_systems__system_id__employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/physicians":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Physicians","description":"Reverse lookup: every physician employed by any captive group of this system.\n\nFilterable by specialty/state/role. Pagination via limit + offset. The\nbilling_org_pac_id and billing_org_name on each row indicate which\ncaptive group within the system actually employs the physician.","operationId":"physicians_systems__system_id__physicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring match on DAC pri_spec.","title":"Specialty"},"description":"Substring match on DAC pri_spec."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state filter.","title":"State"},"description":"2-letter state filter."},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC 207/208).","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC 207/208)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/hcahps":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Hcahps","description":"HCAHPS patient experience rollup for all hospitals in a health system.\n\nAccepts a canonical system_id (preferred) or a system_name (case-insensitive)\nfor backward compatibility with legacy callers. Returns per-facility\nHCAHPS detail (overall star rating, beds, survey volume, state + national\npercentiles) plus system-level rollups.\n\nFor the clinician-level MIPS rollup of the same system, see\nGET /mips/systems/{system_id}.","operationId":"system_hcahps_systems__system_id__hcahps_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Filter to a 2-letter state code.","title":"State"},"description":"Filter to a 2-letter state code."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/financials":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials","description":"Multi-source financial filings for all EINs in a system.\n\nRolls up across system_hierarchy descendants. Returns IRS 990 + DOL 5500\n+ SEC 10-K rows side by side per fiscal year so customers can see the\ncross-source picture. Each row cites its filing source URL.","operationId":"system_financials_systems__system_id__financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/financials/executives":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials Executives","description":"Top compensated executives across all EINs in a system.\n\nSourced from IRS Form 990 Schedule J (nonprofit) + SEC 10-K named\nexecutive officers (public companies). Includes matched_npi where the\nexecutive has been linked to an NPI via fuzzy name+state matching.","operationId":"system_financials_executives_systems__system_id__financials_executives_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/systems/{system_id}/financials/workforce":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials Workforce","description":"DOL Form 5500 W-2 active-participant counts for all EINs in a system.\n\nEach EIN typically has multiple plans (welfare, retirement, etc.); the\nheadline_active_participants_latest is the MAX across plans for the most\nrecent year — usually the welfare/health plan, the cleanest \"total W-2\nemployees\" anchor available in public data.","operationId":"system_financials_workforce_systems__system_id__financials_workforce_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/sources":{"get":{"tags":["Data Transparency"],"summary":"List All","description":"Public catalog of every external dataset we ingest.\n\nEach entry includes the source's license, update cadence, our accuracy\nclassification, and last-loaded state. Use this to validate the\nprovenance of any claim in our API — every employment attribution traces\nback to one or more registered sources via /provider/{npi}/employment's\nattribution_signals[] array.\n\nContent-negotiated: browsers get a styled HTML catalog, API clients get\nJSON. Force a format with ?format=json or ?format=html. Unauthenticated\nby design (it's a transparency feature).","operationId":"list_all_sources_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/sources/{source_id}":{"get":{"tags":["Data Transparency"],"summary":"Detail","description":"Detail for a single registered source. Content-negotiated.","operationId":"detail_sources__source_id__get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/sources/{source_id}/history":{"get":{"tags":["Data Transparency"],"summary":"History","description":"Recent load sessions for a single source — auditable refresh history.\n\nEvery loader run (pipeline or manual) is recorded: when it started,\nhow long it took, whether it succeeded, how many rows it loaded, and\non failure the error message. This is the trust-by-transparency layer\nunderneath /sources — customers can audit not just *what* we serve\nbut *how often we refresh* and *whether our last refresh worked*.\n\nContent-negotiated: browsers get a timeline page, API clients get\nJSON. Unauthenticated by design.","operationId":"history_sources__source_id__history_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Maximum sessions to return (default 20, max 200)","default":20,"title":"Limit"},"description":"Maximum sessions to return (default 20, max 200)"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/sources":{"get":{"tags":["Source Archive"],"summary":"Archived sources with their receipt levels, last fetch, last change, and file counts","description":"Every public source the archive holds. `receipts` says which claims\nthe source can back (R0 provider standing, R1 fee-schedule cell, R2\nNCCI/MUE edit, R3 LCD/Article clause). `last_change_at` is the last run\nthat stored at least one new file.","operationId":"archive_sources_archive_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[],"deprecated":true}},"/archive/runs":{"get":{"tags":["Source Archive"],"summary":"Archive run ledger","description":"One row per run: candidates discovered, files new and unchanged,\nbytes stored, and the status (ok, no_change, partial, failed). `notes`\nlists files stored without a version and containers that could not be\nopened. Zero candidates after a good run is a failed run: the page moved.","operationId":"archive_runs_archive_runs_get","parameters":[{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one source","title":"Source Id"},"description":"Limit to one source"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/changes":{"get":{"tags":["Source Archive"],"summary":"New document versions observed in the last N days (the updates feed)","description":"The change feed behind updates.verzi.health. One row per new version\nthe archive observed: the document title, the publisher version, the\neffective window, when we observed it, the sha256 of the stored bytes,\nand `affected_codes` (the HCPCS codes the coverage layer maps to the\ndocument; empty when no mapping exists). Nobody writes these entries;\nthe pipeline observes them. `truncated` is true when the window holds\nmore rows than `limit`. Every row carries `news` and `newly_archived`.\nA revision note that quotes licensed code text, or comes from a document\nthat does, is null, with `revision_note_withheld` set to `licensed_text`.\nPublic, no key.","operationId":"archive_changes_archive_changes_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":30,"title":"Days"}},{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one source","title":"Source Id"},"description":"Limit to one source"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"origin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(live|historical)$"},{"type":"null"}],"description":"live = versions a scheduled run observed; historical = versions pulled from the past (backfill or Wayback copies). Omit for both.","title":"Origin"},"description":"live = versions a scheduled run observed; historical = versions pulled from the past (backfill or Wayback copies). Omit for both."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(claim_policy|fee_schedule|code_set|regulatory|other)$"},{"type":"null"}],"description":"One source category (the feed's chips), filtered before the row cap.","title":"Category"},"description":"One source category (the feed's chips), filtered before the row cap."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(news|newly_archived)$"},{"type":"null"}],"description":"news = a live version of a document already held that is newer than every version held before it (publisher order: effective date, then version number, then observed), or a first capture whose effective date is in the window or later; newly_archived = every other live capture (first captures, older versions filled in later). Omit for both. Filtered before the cap.","title":"Kind"},"description":"news = a live version of a document already held that is newer than every version held before it (publisher order: effective date, then version number, then observed), or a first capture whose effective date is in the window or later; newly_archived = every other live capture (first captures, older versions filled in later). Omit for both. Filtered before the cap."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/upcoming":{"get":{"tags":["Source Archive"],"summary":"Future-effective document versions, soonest first (the upcoming-changes calendar)","description":"Versions whose publisher effective date is in the future: new fee\nschedule quarters, dated LCD revisions, transmittal batches. Soonest\nfirst, grouped client-side by effective date. The publisher's dates\nonly; a version with no stated effective date never appears here.\nEach row carries `affected_codes`: the codes a coverage mapping links to\nthe document, and for a version of the Required Face-to-Face Encounter\nand Written Order Prior to Delivery List, the codes that version names.\n`kind` is `document_version`, or `code_list_phase` for a future phase\nthat the Required Prior Authorization List in force today prints for\nsome codes: one row per printed phase date and scope\n(`phase_date_text`, `phase_scope_text`, verbatim), with the codes that\nphase covers and the list's own version and file.\nHorizon: only effective dates up to 2 years after today (US Eastern)\nare listed, and `horizon_through` names the last date listed. A\npublisher's text can state a typo year (CMS R499PI states 2104). That\nversion and its as-of answer stay as stated; the calendar does not\nlist it.\nPublic, no key. The page: updates.verzi.health/calendar.","operationId":"archive_upcoming_archive_upcoming_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/docs/{doc_id}/versions":{"get":{"tags":["Source Archive"],"summary":"Every version of a document with its publisher and observed windows","description":"Versions in window order. `observed_to` and `superseded_by` are\nderived, never written into a row. `observed_to` is set only for undated\nlive versions (the next live capture's observed_from) and is null for\ndated versions and for wayback and backfill copies.\n`origin` says how the file reached the archive: live (a scheduled run),\nbackfill (a manual historical pull), wayback (a Wayback Machine copy).","operationId":"doc_versions_archive_docs__doc_id__versions_get","parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED","title":"Doc Id"},"description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/docs/{doc_id}/as-of":{"get":{"tags":["Source Archive"],"summary":"The version of a document in force on a date","description":"Which version was in force on the date, and which rule decided it.\n`publisher_effective`: the publisher's stated window, both ends\ninclusive. `observed`: when the archive first saw the version and its\nsuccessor, half-open, live rows only. This rule applies only to versions\nwith no publisher start date. A dated version is never in force outside\nits stated window. `none`: no version qualifies, and `reason` says why\n(before_first_stated_start, after_last_stated_end,\ngap_between_stated_windows, not_observed_on_date, no_versions, or\nonly_defective_versions: every held version is excluded, either its\nfile is recorded as cut short or the version itself as defective).\n`effective_from_source` says where the start date came from. For a\nmanual chapter it is `transmittal_effective` (the Effective date of the\ntransmittal the revision names) or `transmittal` (its Implementation\ndate, kept when the Effective date is missing, ambiguous or more than\n365 days before the transmittal's issue date). `transmittal_issue_date`\nis set when the Effective date used precedes the issue date.\nFor a manual chapter the highest Rev in force answers (a lower Rev is\ncapped once a higher Rev has started). `inverted_window` is set when a\nlower Rev of the chapter starts AFTER the date of service: it names the\nanswering Rev and each such lower Rev with its transmittal's issue,\neffective and implementation dates and the transmittal's own wording\n(`effective_text`, `implementation_text`, quoted from the parsed\ntransmittal); its `note` is a Verzi label, not CMS text. Null otherwise.\nIncludes the file's sha256 and, with a key, a one-hour link to the\noriginal bytes. Bytes that any source under CPT-licensed terms holds\nget no link (`url_withheld` says why), and so do the bytes of a document\nthat quotes licensed code text CMS cites. Never guesses.","operationId":"doc_as_of_archive_docs__doc_id__as_of_get","security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED","title":"Doc Id"},"description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED"},{"name":"date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Date of service, YYYY-MM-DD","title":"Date"},"description":"Date of service, YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/archive/docs/{doc_id}/section":{"get":{"tags":["Source Archive"],"summary":"One section of a manual chapter on a date, from the chapter or the transmittal that changed it","description":"The section's own words on the date, verbatim, never a paraphrase. `status`: `served`\n(with `text`, and a `citation` to the stored file and the character span: a held chapter\nversion, or the transmittal that changed the section), `deleted` (a transmittal deleted it;\n`text` is null; the citation is that transmittal) or `unknown` (the archive cannot prove the\ntext on that date; `unknown_reason` says why, for example `chain_incomplete`, which names the\nrevision whose transmittal is missing). A transmittal serves a section only when every revision\nof the chapter after the latest held chapter version has a held transmittal whose change table\nwas read; `basis` states the revision set (the chapter's own table plus the held transmittals\nthat name the chapter; a revision in neither is not known). Dates are the chapter windows' own\n(`in_force_from`: the transmittal's Effective date, or its Implementation date when the Effective date\nis missing or more than 365 days before its issue date; `date_source` says which). Manuals and\ntransmittals are public domain; a source\nor a cited file whose license keeps its text off the API answers `license_held`. A section whose\ncited file's stored rendering is not verified to keep the publisher's word order answers\n`unknown` with `rendering_not_in_document_order`: `text` is null, and the citation (file,\n`render_sha256`, span), `chain` and `basis` are kept. Today that is every manual and transmittal\nPDF, so the route serves no section text until the PDF order check lands; `deleted` and every\nother answer are unchanged. Needs a key, like the stored text renderings.","operationId":"manual_section_archive_docs__doc_id__section_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"A manual chapter document, e.g. manual:clm104c20 (Claims Processing ch.20) or manual:pim83c05 (Program Integrity ch.5)","title":"Doc Id"},"description":"A manual chapter document, e.g. manual:clm104c20 (Claims Processing ch.20) or manual:pim83c05 (Program Integrity ch.5)"},{"name":"section","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d{1,3}(\\.\\d{1,3}){0,6}$","description":"Section number as the manual prints it, e.g. 181 or 30.9.1","title":"Section"},"description":"Section number as the manual prints it, e.g. 181 or 30.9.1"},{"name":"date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Date of service, YYYY-MM-DD","title":"Date"},"description":"Date of service, YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/archive/files/{sha256}":{"get":{"tags":["Source Archive"],"summary":"Archived file metadata and a one-hour link to the original bytes","description":"Provenance for one byte-stream: the URL it was fetched from, when,\nthe publisher's ETag and Last-Modified, the size, the container it came\nfrom (for zip members), the versions it backs, and how many later runs\nsaw the same bytes again. Public. `url` (the presigned link to the original\nbytes) needs a key, so it is null on a keyless response; the sha256 and the\npublisher's resolved_url are always present. Bytes that any source under\nCPT-licensed terms holds get no link even with a key, and neither do\nthe bytes of a document that quotes licensed code text CMS cites;\n`url_withheld` says why.","operationId":"file_meta_archive_files__sha256__get","security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"sha256","in":"path","required":true,"schema":{"type":"string","description":"sha256 of the original bytes, 64 hex characters","title":"Sha256"},"description":"sha256 of the original bytes, 64 hex characters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/archive/files/{sha256}/text":{"get":{"tags":["Source Archive"],"summary":"The stored deterministic text rendering of an archived file, where it keeps the publisher's word order","description":"The rendering that span-level citations point into, with the renderer\nversion that produced it. Text of bytes that any source holds under\nterms that do not allow its whole text is not served: the response says\nso and carries `contains_licensed_descriptors: true` and\n`text_withheld: licensed_text`. A rendering that is not verified to keep\nthe publisher's word order is not served either: `text_withheld` is\n`rendering_not_in_document_order`, and the response\ncarries the file's receipt and `url`, the one-hour link to the original\nbytes. Today only CFR XML renderings serve whole. A rendering that\nquotes licensed code text that CMS cites (such as the ADA's CDT\ndescriptors) is not served: `text_withheld` is `licensed_text`.","operationId":"file_text_archive_files__sha256__text_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"sha256","in":"path","required":true,"schema":{"type":"string","description":"sha256 of the original bytes, 64 hex characters","title":"Sha256"},"description":"sha256 of the original bytes, 64 hex characters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/archive/{source_id}/files":{"get":{"tags":["Source Archive"],"summary":"Archived files of one source, newest first","description":"Metadata only: sha256, resolved URL, fetch time, size, publisher\nversion, and whether a rendering exists. Bytes are behind\n/archive/files/{sha256}.","operationId":"source_files_archive__source_id__files_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","description":"Catalog source id, e.g. dmepos_fee_schedule","title":"Source Id"},"description":"Catalog source id, e.g. dmepos_fee_schedule"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only files fetched at or after this time (ISO-8601)","title":"Since"},"description":"Only files fetched at or after this time (ISO-8601)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"members","in":"query","required":false,"schema":{"type":"boolean","description":"Include zip members (default: top-level files only)","default":false,"title":"Members"},"description":"Include zip members (default: top-level files only)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/archive/{source_id}/docs":{"get":{"tags":["Source Archive"],"summary":"Documents of one source with version counts","description":"A document is the logical thing that has versions over time: a fee\nschedule quarter, an NCCI table for a quarter, the LEIE full file.\nFiles whose names fit no versioning rule are stored but belong to no\ndocument; they appear under /archive/{source_id}/files and in the run\nnotes.","operationId":"source_docs_archive__source_id__docs_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","description":"Catalog source id, e.g. dmepos_fee_schedule","title":"Source Id"},"description":"Catalog source id, e.g. dmepos_fee_schedule"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":2000,"minimum":1,"default":200,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/platform/stats":{"get":{"tags":["Data Transparency"],"summary":"Stats","description":"Live platform stats — total rows, source counts, facility / clinician\ncounts, and the timestamp + status of the most recent pipeline run.\n\nContent-negotiated: browsers get a styled HTML dashboard, API clients\nget JSON. Force with ?format=json or ?format=html.\n\nRow counts are PostgreSQL planner estimates (pg_class.reltuples).\nThey're updated by autovacuum, accurate to within single-digit percent,\nand orders of magnitude faster than COUNT(*) on 327M-row tables —\nthe right tradeoff for an unauthenticated endpoint that customers and\nbots can both hit.\n\nUnauthenticated by design — trust-by-transparency.","operationId":"stats_platform_stats_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/accuracy":{"get":{"tags":["Data Transparency"],"summary":"Latest Results","description":"Latest benchmark run: per-system accuracy with public source URLs.\n\nEach entry shows our number, the publicly-reported number, the\nvariance, and the source URL for ground truth. Use this as the\nreceipts to validate any claim our API makes about a system. We\nre-run the benchmark on every release. The major enterprise data\nplatforms do not publish per-system accuracy benchmarks.\n\nContent-negotiated: browsers get a styled HTML page with the\nvariance table and summary tiles; API clients get JSON.\n\nUnauthenticated by design (transparency feature).","operationId":"latest_results_accuracy_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/accuracy/discipline-coverage":{"get":{"tags":["Data Transparency"],"summary":"Discipline Coverage","description":"How much of the nation's practitioner discipline we hold, per state.\n\nBenchmarks our disciplinary-action coverage against the NPDB Public\nUse File — the only national count of state licensure actions and\nexclusions. Two classes are reported separately because they are\ndifferent populations: `exclusion` (federal LEIE + state Medicaid\nexclusion lists) and `licensure_action` (state medical board feeds).\nMixing them would overstate one and understate the other.\n\nWe publish the gaps, not just the wins: a state near zero in the\nlicensure_action class means we have no board feed for it yet.\n\nThe benchmark file is de-identified by statute and carries no names\nor NPIs. Only aggregate counts are published, per its Data Use\nAgreement; counts below the small-cell threshold are withheld.\n\nUnauthenticated by design (transparency feature).","operationId":"discipline_coverage_accuracy_discipline_coverage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[],"deprecated":true}},"/licenses/state/{state_code}":{"get":{"tags":["License Intelligence"],"summary":"License overview for a state","description":"State-level license intelligence overview.\n\nReturns aggregate licensed-provider counts broken out by license\ntype (medical_md, medical_do, advanced_practice, nursing, dental,\npodiatric, optometric) and current status (active, expired), plus\nthe 25 most-recent currently-active disciplinary actions in the\nstate.\n\nSold to credentialing platforms, staffing agencies, and compliance\nteams. For an individual NPI's licenses across all states, see\n`/licenses/{npi}`.","operationId":"state_view_licenses_state__state_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state_code","in":"path","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"description":"2-letter US state code (uppercase). Example: `CA` for California.","title":"State Code"},"description":"2-letter US state code (uppercase). Example: `CA` for California.","example":"CA"}],"responses":{"200":{"description":"Licensed provider counts by type + recent disciplinary actions in the state.","content":{"application/json":{"schema":{},"example":{"state":"CA","count":2,"results":[{"npi":"1245319599","license_number":"A12345","license_type":"medical_md","status":"active","practice_city":"Los Angeles"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/licenses/{npi}":{"get":{"tags":["License Intelligence"],"summary":"Npi Summary","description":"All licenses for an NPI (across states) + disciplinary action summary.","operationId":"npi_summary_licenses__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/licenses/{npi}/disciplinary":{"get":{"tags":["License Intelligence"],"summary":"Npi Disciplinary","description":"Full disciplinary action history for an NPI.","operationId":"npi_disciplinary_licenses__npi__disciplinary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/licenses/alerts/recent":{"get":{"tags":["License Intelligence"],"summary":"Alerts Recent","description":"Recent disciplinary action feed across all states.\n\nReturns recent currently-active actions at or above the severity_floor.\nDefault: high+critical actions in the last 90 days. Use this as the\ndaily monitoring feed for compliance / credentialing workflows.","operationId":"alerts_recent_licenses_alerts_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":730,"minimum":1,"description":"Lookback window in days.","default":90,"title":"Days"},"description":"Lookback window in days."},{"name":"severity_floor","in":"query","required":false,"schema":{"enum":["low","medium","high","critical"],"type":"string","description":"Minimum severity to include.","default":"high","title":"Severity Floor"},"description":"Minimum severity to include."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/mips/leaderboards/{specialty_substring}":{"get":{"tags":["MIPS — Cross-NPI Analytics"],"summary":"MIPS leaderboard by specialty","description":"Top MIPS performers in a specialty, latest reporting year.\n\n`specialty_substring` is matched case-insensitive against the DAC\n(Doctors and Clinicians) primary specialty taxonomy. Returns the top\nN NPIs by final MIPS score descending. Useful for building\n\"top-doctors\" lists, peer benchmarking, or spot-checking outlier\nphysicians.","operationId":"leaderboard_mips_leaderboards__specialty_substring__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty_substring","in":"path","required":true,"schema":{"type":"string","description":"Case-insensitive substring match against DAC primary specialty (e.g., 'Internal', 'Cardiology').","title":"Specialty Substring"},"description":"Case-insensitive substring match against DAC primary specialty (e.g., 'Internal', 'Cardiology').","example":"Internal Medicine"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max results to return.","default":50,"title":"Limit"},"description":"Max results to return.","example":20}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/mips/systems/{system_id}":{"get":{"tags":["MIPS — Cross-NPI Analytics"],"summary":"System-level MIPS rollup","description":"System-level MIPS rollup — mean, median, quartiles across every NPI\nbilling under any descendant of the system.\n\nWalks the `system_hierarchy` tree (e.g., `TENET` → USPI + regional\ndivisions, `SUTTER` → 8 foundations, `KAISER` → 9 Permanente medical groups)\nand aggregates the latest-year MIPS scores for every NPI attributed\nto any descendant.\n\nPair with `/systems/{system_id}/divisions` for the structural\nbreakdown. Answers questions like \"Are physicians at PE platforms\nscoring differently on MIPS than at hospital systems in the same\nmarket?\"","operationId":"system_rollup_mips_systems__system_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","description":"Verzi canonical system ID (e.g., `INTERMOUNTAIN`, `KAISER`, `TENET`).","title":"System Id"},"description":"Verzi canonical system ID (e.g., `INTERMOUNTAIN`, `KAISER`, `TENET`).","example":"INTERMOUNTAIN"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/companies/search":{"get":{"tags":["Financial Intelligence"],"summary":"Companies Search","description":"Search public healthcare companies by ticker or name substring.","operationId":"companies_search_companies_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"description":"Ticker or company name substring.","title":"Q"},"description":"Ticker or company name substring."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/companies/{ticker}":{"get":{"tags":["Financial Intelligence"],"summary":"Company Detail","description":"Public company financial profile + filings inventory.\n\nReturns ticker / CIK / system_id linkage plus 5 years of 10-K income\nstatement + balance sheet data, and counts of ingested filings. Data\nis sourced from SEC EDGAR via Financial Modeling Prep.","operationId":"company_detail_companies__ticker__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/ma-events/recent":{"get":{"tags":["Financial Intelligence"],"summary":"Recent Ma Events","description":"Recent healthcare M&A activity derived from SEC 8-K filings.\n\nDefinitive Healthcare publishes some M&A data behind their paid tier;\nwe surface SEC-disclosed M&A events with source URLs to the original\n8-K filing. Empty array means no 8-K-derived events have been parsed\nyet for the lookback window — the data populates as the SEC ingestion\nextracts Item 1.01 + 2.01 content.","operationId":"recent_ma_events_ma_events_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":730,"minimum":1,"description":"Lookback window in days.","default":180,"title":"Days"},"description":"Lookback window in days."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/resources":{"get":{"tags":["Data Transparency"],"summary":"List Resources","description":"List all published methodology + sales artifacts. Content-negotiated.","operationId":"list_resources_resources_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/resources/{slug}":{"get":{"tags":["Data Transparency"],"summary":"Render Resource","description":"Render a single resource.\n\nContent negotiation:\n  - Browsers (Accept: text/html) → styled HTML page with brand chrome\n  - curl (Accept: */*) → raw markdown text\n  - ?format=markdown → raw markdown (curl-friendly explicit override)\n  - ?format=html → HTML even from curl\n  - ?format=json → JSON envelope with metadata + markdown body","operationId":"render_resource_resources__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html|markdown)$"},{"type":"null"}],"title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[],"deprecated":true}},"/benchmarks/hcahps/national":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"National Benchmarks","description":"National HCAHPS benchmarks with mean, median, percentiles, and std dev.","operationId":"national_benchmarks_benchmarks_hcahps_national_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-11). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-11). Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension (e.g., nurse_communication)","title":"Dimension"},"description":"Filter by dimension (e.g., nurse_communication)"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/national/trends":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"National Benchmark Trends","description":"National benchmark trends over time — see how the industry average moves.","operationId":"national_benchmark_trends_benchmarks_hcahps_national_trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"type":"string","description":"Measure type to trend","default":"top_box","title":"Measure Type"},"description":"Measure type to trend"},{"name":"quarters","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of quarters of history","default":12,"title":"Quarters"},"description":"Number of quarters of history"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/state":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"State Benchmarks","description":"State-level HCAHPS benchmarks.","operationId":"state_benchmarks_benchmarks_hcahps_state_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"State code (e.g., TN, FL, CA)","title":"State"},"description":"State code (e.g., TN, FL, CA)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/peer":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Peer Benchmarks","description":"Peer group HCAHPS benchmarks — by ownership type, hospital type, or bed size.","operationId":"peer_benchmarks_benchmarks_hcahps_peer_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"peer_type","in":"query","required":true,"schema":{"type":"string","description":"Peer group type: ownership, type, bed_size","title":"Peer Type"},"description":"Peer group type: ownership, type, bed_size"},{"name":"peer_value","in":"query","required":true,"schema":{"type":"string","description":"Peer group value (e.g., Proprietary, Acute Care Hospitals, large)","title":"Peer Value"},"description":"Peer group value (e.g., Proprietary, Acute Care Hospitals, large)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/peer/values":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Peer Group Values","description":"List available values for a peer group type (e.g., all ownership types with hospital counts).","operationId":"peer_group_values_benchmarks_hcahps_peer_values_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"peer_type","in":"query","required":true,"schema":{"type":"string","description":"Peer group type: ownership, type, bed_size","title":"Peer Type"},"description":"Peer group type: ownership, type, bed_size"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/facility/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Benchmarks","description":"Facility-level HCAHPS values with national/state/peer percentile rankings.","operationId":"facility_benchmarks_benchmarks_hcahps_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/facility/{ccn}/dimensions":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Dimensions","description":"Dimension-level HCAHPS summary with top-box, bottom-box, linear score, star rating, and percentiles.","operationId":"facility_dimensions_benchmarks_hcahps_facility__ccn__dimensions_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/facility/{ccn}/trends":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Trends","description":"HCAHPS trend analysis — QoQ/YoY changes, direction, streaks, significance.","operationId":"facility_trends_benchmarks_hcahps_facility__ccn__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"quarters","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of quarters of history","default":8,"title":"Quarters"},"description":"Number of quarters of history"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/compare":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Compare","description":"Side-by-side HCAHPS comparison of multiple facilities.","operationId":"compare_benchmarks_hcahps_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"facilities","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated CCNs (max 50)","title":"Facilities"},"description":"Comma-separated CCNs (max 50)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/movers":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Top Movers","description":"Biggest HCAHPS movers — hospitals with largest QoQ changes.","operationId":"top_movers_benchmarks_hcahps_movers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Direction: improving or declining","default":"declining","title":"Direction"},"description":"Direction: improving or declining"},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"min_change","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Minimum absolute change (percentage points)","default":3,"title":"Min Change"},"description":"Minimum absolute change (percentage points)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hcahps/market":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Market Benchmarks","description":"HCAHPS benchmarks for all hospitals within a geographic radius.","operationId":"market_benchmarks_benchmarks_hcahps_market_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","description":"Latitude of center point","title":"Lat"},"description":"Latitude of center point"},{"name":"lng","in":"query","required":true,"schema":{"type":"number","description":"Longitude of center point","title":"Lng"},"description":"Longitude of center point"},{"name":"radius_miles","in":"query","required":true,"schema":{"type":"number","maximum":500,"exclusiveMinimum":0,"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/scorecard/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Hospital Scorecard","description":"Comprehensive hospital scorecard — HCAHPS + HVBP + HAC + HCRIS + Star Ratings in one call.","operationId":"hospital_scorecard_benchmarks_scorecard__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/benchmarks/hvbp/revenue-impact/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Hvbp Revenue Impact","description":"Estimate HVBP payment adjustment and revenue impact.\n\nCombines HVBP Total Performance Score with HCRIS financial data to estimate\nthe Medicare payment adjustment (±2%) and dollar impact. Includes TPS percentile\nranking and domain-level breakdown.","operationId":"hvbp_revenue_impact_benchmarks_hvbp_revenue_impact__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"HVBP fiscal year. Defaults to latest.","title":"Fiscal Year"},"description":"HVBP fiscal year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/hospitals/{ccn}/market-share":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Market Share","description":"Hospital's market share across all ZIP codes it serves.\n\nShows discharge volume, market share %, and competitive position for each ZIP\nin the hospital's service area. Derived from CMS Hospital Service Area File.","operationId":"hospital_market_share_market_intelligence_hospitals__ccn__market_share_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year (e.g., 2024). Defaults to latest.","title":"Year"},"description":"Year (e.g., 2024). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/hospitals/{ccn}/service-area":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Service Area","description":"Hospital's service area summary with primary/secondary/tertiary ZIP tiers.\n\nPrimary = hospital has >50% market share in the ZIP.\nSecondary = 10-50%. Tertiary = <10%.\nIncludes weighted average market share across all ZIPs.","operationId":"hospital_service_area_market_intelligence_hospitals__ccn__service_area_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/hospitals/{ccn}/trends":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Market Trends","description":"Hospital's market share trends over all available years (2015-2024).\n\nShows year-over-year changes in discharge volume, market share, and\ntrend direction (gaining/losing/stable).","operationId":"hospital_market_trends_market_intelligence_hospitals__ccn__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/hospitals/{ccn}/competitors":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Competitors","description":"Top competitors for a hospital, ranked by geographic overlap.\n\nIdentifies hospitals competing for the same patient populations\nbased on shared ZIP codes. Includes overlap coefficient, shared\ndischarge volumes, and competitor quality ratings.","operationId":"hospital_competitors_market_intelligence_hospitals__ccn__competitors_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max competitors to return","default":20,"title":"Limit"},"description":"Max competitors to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/zip/{zip_code}":{"get":{"tags":["Market Intelligence"],"summary":"Zip Market","description":"All hospitals serving a ZIP code with market shares and quality ratings.\n\nIncludes HHI (Herfindahl-Hirschman Index) for market concentration:\n<1500 = competitive, 1500-2500 = moderately concentrated, >2500 = highly concentrated.","operationId":"zip_market_market_intelligence_zip__zip_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/zip/{zip_code}/trends":{"get":{"tags":["Market Intelligence"],"summary":"Zip Trends","description":"ZIP code market trends over all available years.\n\nShows how competition, volume, and concentration change over time.","operationId":"zip_trends_market_intelligence_zip__zip_code__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/enrollment/county/{fips_code}":{"get":{"tags":["Market Intelligence"],"summary":"County Enrollment","description":"County-level Medicare enrollment with demographics, dual eligibility, and trends.\n\nIncludes MA penetration rate, growth rate, and demographic breakdown.","operationId":"county_enrollment_market_intelligence_enrollment_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/enrollment/county/{fips_code}/history":{"get":{"tags":["Market Intelligence"],"summary":"County Enrollment History","description":"County enrollment trends across all available years (2013-present).\n\nShows year-over-year growth, MA penetration changes, and demographic shifts.","operationId":"county_enrollment_history_market_intelligence_enrollment_county__fips_code__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/enrollment/state/{state}":{"get":{"tags":["Market Intelligence"],"summary":"State Enrollment","description":"State-level Medicare enrollment summary.","operationId":"state_enrollment_market_intelligence_enrollment_state__state__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/enrollment/growth-leaders":{"get":{"tags":["Market Intelligence"],"summary":"Enrollment Growth Leaders","description":"Counties with fastest Medicare enrollment growth.\n\nIdentifies markets where the Medicare population is expanding —\ncritical signal for hospital strategic planning and PE investment analysis.","operationId":"enrollment_growth_leaders_market_intelligence_enrollment_growth_leaders_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"min_benes","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Minimum beneficiaries to include","default":1000,"title":"Min Benes"},"description":"Minimum beneficiaries to include"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":50,"title":"Limit"},"description":"Max results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/opportunity/search":{"get":{"tags":["Market Intelligence"],"summary":"Opportunity Search","description":"Search for hospitals with highest market opportunity.\n\nComposite scoring combines enrollment growth, market share headroom,\nvolume trends, and MA penetration. Useful for identifying expansion\ntargets, acquisition candidates, or underserved markets.","operationId":"opportunity_search_market_intelligence_opportunity_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum opportunity score","title":"Min Score"},"description":"Minimum opportunity score"},{"name":"min_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum bed count","title":"Min Beds"},"description":"Minimum bed count"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":50,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/opportunity/{ccn}":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Opportunity","description":"Combined market opportunity score for a hospital.\n\nIntegrates market share position, enrollment growth trends, MA penetration,\nand volume trajectory into a single opportunity score. Higher = more opportunity.\n\nFactors: enrollment growth (weighted 2x), room to grow (inverse of market share),\nvolume momentum, and MA penetration (revenue upside).","operationId":"hospital_opportunity_market_intelligence_opportunity__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/market-intelligence/cbsa/{cbsa_code}/population":{"get":{"tags":["Market Intelligence"],"summary":"Cbsa Population","description":"Census Bureau population estimate history for a CBSA (metro/micro area), with year-over-year growth.","operationId":"cbsa_population_market_intelligence_cbsa__cbsa_code__population_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"cbsa_code","in":"path","required":true,"schema":{"type":"string","title":"Cbsa Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/health/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Health Profile","description":"County health profile with key chronic disease, risk behavior, and preventive care measures.\n\nDerived from CDC PLACES: model-based estimates from BRFSS survey data.\nIncludes diabetes, obesity, smoking, physical inactivity, depression, and more.","operationId":"county_health_profile_community_health_health_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/health/rankings/{measure_id}":{"get":{"tags":["Community Health"],"summary":"Places Rankings","description":"Rank counties or ZCTAs by a specific health measure.\n\nExamples: highest diabetes rates, lowest preventive screening, worst mental health.\nUse MeasureId values like DIABETES, OBESITY, CSMOKING, BPHIGH, CHECKUP, etc.","operationId":"places_rankings_community_health_health_rankings__measure_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"measure_id","in":"path","required":true,"schema":{"type":"string","title":"Measure Id"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","description":"'county' or 'zcta'","default":"county","title":"Location Type"},"description":"'county' or 'zcta'"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"'desc' (highest first) or 'asc'","default":"desc","title":"Sort"},"description":"'desc' (highest first) or 'asc'"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/health/{location_type}/{location_id}":{"get":{"tags":["Community Health"],"summary":"Places Measures","description":"All 40 CDC PLACES measures for a county or ZCTA, grouped by category.\n\nCategories: health outcomes, preventive services, risk behaviors,\ndisabilities, health status, health-related social needs.","operationId":"places_measures_community_health_health__location_type___location_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"location_type","in":"path","required":true,"schema":{"type":"string","title":"Location Type"}},{"name":"location_id","in":"path","required":true,"schema":{"type":"string","title":"Location Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/spending/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Spending","description":"County-level Medicare FFS spending and utilization.\n\nIncludes per-capita spending (actual and price-standardized), inpatient stays,\nER visits, readmission rates, and service-specific breakdowns.\nStandardized amounts remove geographic price differences for fair comparison.","operationId":"county_spending_community_health_spending_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/spending/state/{state}":{"get":{"tags":["Community Health"],"summary":"State Spending","description":"State-level Medicare FFS spending and utilization.","operationId":"state_spending_community_health_spending_state__state__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/spending/rankings":{"get":{"tags":["Community Health"],"summary":"Spending Rankings","description":"Counties ranked by per-capita standardized Medicare spending.\n\nIdentifies high-cost and low-cost markets. Standardized spending removes\ngeographic wage/price adjustments for apples-to-apples comparison.","operationId":"spending_rankings_community_health_spending_rankings_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/geography/zip/{zip_code}":{"get":{"tags":["Community Health"],"summary":"Zip Geography","description":"Full geographic context for a ZIP code.\n\nReturns HRR (Hospital Referral Region), HSA (Hospital Service Area),\nCBSA (metro/micro area), county FIPS, and state.","operationId":"zip_geography_community_health_geography_zip__zip_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/geography/hrr/{hrr_number}":{"get":{"tags":["Community Health"],"summary":"Hrr Info","description":"HRR (Hospital Referral Region) details — ZIP count, HSA count.","operationId":"hrr_info_community_health_geography_hrr__hrr_number__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hrr_number","in":"path","required":true,"schema":{"type":"integer","title":"Hrr Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/geography/hrr/{hrr_number}/hospitals":{"get":{"tags":["Community Health"],"summary":"Hrr Hospitals","description":"All hospitals in a Hospital Referral Region with star ratings.\n\nHRRs represent regional healthcare markets defined by where Medicare\npatients are referred for major cardiovascular and neurosurgical procedures.","operationId":"hrr_hospitals_community_health_geography_hrr__hrr_number__hospitals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hrr_number","in":"path","required":true,"schema":{"type":"integer","title":"Hrr Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/context/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Context","description":"Unified county market context combining enrollment, health, spending, and SDOH.\n\nSingle endpoint for the complete market picture: Medicare enrollment trends,\nchronic disease burden, spending patterns, social determinants, and\ngeographic classification (CBSA, HRR).","operationId":"county_context_community_health_context_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/community-health/sdoh/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Sdoh","description":"AHRQ Social Determinants of Health for a county.\n\nIncludes poverty, income, unemployment, insurance, education, disability,\nfood access, family structure, and language indicators.","operationId":"county_sdoh_community_health_sdoh_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/summary":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Vbc Summary","description":"High-level VBC/ACO data summary and statistics.","operationId":"vbc_summary_vbc_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/vbc/acos":{"get":{"tags":["Value-Based Care / ACO"],"summary":"List Acos","description":"Search and list MSSP ACOs.","operationId":"list_acos_vbc_acos_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by ACO name or ID","title":"Q"},"description":"Search by ACO name or ID"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (in service area)","title":"State"},"description":"Filter by state (in service area)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year (default: latest)","title":"Year"},"description":"Performance year (default: latest)"},{"name":"track","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by track: basic or enhanced","title":"Track"},"description":"Filter by track: basic or enhanced"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/acos/{aco_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Detail","description":"Full ACO profile: org info, participants, SNF affiliates, beneficiary geography.","operationId":"aco_detail_vbc_acos__aco_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year (default: latest)","title":"Year"},"description":"Performance year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/acos/{aco_id}/history":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco History","description":"ACO performance trend across all available years.","operationId":"aco_history_vbc_acos__aco_id__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/acos/{aco_id}/beneficiaries":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Beneficiaries","description":"ACO beneficiary distribution by state.","operationId":"aco_beneficiaries_vbc_acos__aco_id__beneficiaries_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year (default: latest)","title":"Year"},"description":"Year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/acos/{aco_id}/clinicians":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Clinicians","description":"The clinicians Verzi links to this ACO, one row per NPI.\n\n`aco_id` is the CMS ACO ID, such as `A1234`, as published from PY2018. The older `ACO_Num` form of PY2013 to PY2017 is not accepted.\n\nThe rows are the reverse of `/provider/{npi}/acos`. Each row gives the\nNPI's best link `confidence` to this ACO and every `match_methods` entry\nthat linked it. A name match is never presented as exact: treat `medium`\nand `low` rows as leads to verify. `min_confidence` keeps rows at that\nlevel or better (default `low`, so every linked NPI). `total` counts every\nNPI that matches the filters, across all pages.","operationId":"aco_clinicians_vbc_acos__aco_id__clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"min_confidence","in":"query","required":false,"schema":{"type":"string","pattern":"^(high|medium|low)$","description":"high, medium or low","default":"low","title":"Min Confidence"},"description":"high, medium or low"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year of the link","title":"Year"},"description":"Performance year of the link"},{"name":"match_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(cms_qpp_participation|organization_name_match|individual_name_match)$"},{"type":"null"}],"description":"Only links made by this method","title":"Match Method"},"description":"Only links made by this method"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/provider-lookup":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Provider Aco Lookup","description":"Find which ACO(s) a provider belongs to, by NPI or by participant name.\n\n`npi` returns the NPI's links from `provider_aco_links`, each with a match\nmethod and confidence (the same rows as `/provider/{npi}/acos`). A name\nmatch is never presented as exact.\n\n`name` searches the MSSP participant list by legal business name. Each row\ncarries `match.method` `participant_lbn_search` with confidence `none`: it\nis a name search, not a provider match.\n\nOne of `npi` or `name` is required. When both are given, `npi` wins and\n`name` is ignored.","operationId":"provider_aco_lookup_vbc_provider_lookup_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Participant legal business name (partial match)","title":"Name"},"description":"Participant legal business name (partial match)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":10,"maxLength":10},{"type":"null"}],"description":"10-digit NPI: the provider's ACO links by NPI","title":"Npi"},"description":"10-digit NPI: the provider's ACO links by NPI"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year for a name search (default: latest)","title":"Year"},"description":"Performance year for a name search (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/facility/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Facility Aco","description":"Get ACO affiliation and HAC scores for a hospital by CCN.","operationId":"facility_aco_vbc_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/financials":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Financials Search","description":"Search and rank MSSP ACOs by financial performance.\n\nCovers PY2013 to PY2024. Rates (savings rate, share rate, quality score)\nare normalized to percent across every year: CMS switches between a 0-1\nfraction and a 0-100 percentage from file to file, so the published\nnumbers are not comparable as-is. `sort=losses` ranks worst-first.","operationId":"mssp_financials_search_vbc_financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2013-2024","title":"Year"},"description":"Performance year, 2013-2024"},{"name":"track","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Track filter, e.g. ENHANCED, BASIC, Track 1","title":"Track"},"description":"Track filter, e.g. ENHANCED, BASIC, Track 1"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACO state","title":"State"},"description":"ACO state"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACO name or ID","title":"Q"},"description":"ACO name or ID"},{"name":"min_savings","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum earned shared savings","title":"Min Savings"},"description":"Minimum earned shared savings"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"earn_save_loss | gen_save_loss | sav_rate | qual_score | n_ab | losses","default":"earn_save_loss","title":"Sort"},"description":"earn_save_loss | gen_save_loss | sav_rate | qual_score | n_ab | losses"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/financials/summary":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Financials Summary","description":"Program-level MSSP rollup: benchmark, expenditure, savings, track mix.\n\nReports how many ACOs earned shared savings against how many owed losses,\nwith the totals behind both.","operationId":"mssp_financials_summary_vbc_financials_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, defaults to the latest","title":"Year"},"description":"Performance year, defaults to the latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/acos/{aco_id}/financials":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Aco Financials","description":"Every published performance period for one MSSP ACO.\n\nReturns benchmark, expenditure, shared savings or losses, quality score,\nprovider counts, beneficiary demographics, and utilization per year, plus\ncumulative earned savings across all periods. `source_row` on each period\ncarries the CMS row exactly as published.\n\nAccepts an ACO_ID or, for ACOs that left before PY2018, an ACO_Num.","operationId":"mssp_aco_financials_vbc_acos__aco_id__financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"include_measures","in":"query","required":false,"schema":{"type":"boolean","description":"Include per-year quality measures","default":true,"title":"Include Measures"},"description":"Include per-year quality measures"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/reach":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Orgs","description":"List ACO REACH entities, one row per entity per performance year, paged.\n\nCovers PY2021 (the Direct Contracting year the model grew out of) through\nPY2026. Omit `year` to get every year. The answer carries `total`, so a\ncaller pages with `offset` until it has `total` rows.","operationId":"reach_orgs_vbc_reach_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2021-2026","title":"Year"},"description":"Performance year, 2021-2026"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Rows per page","default":50,"title":"Limit"},"description":"Rows per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip","default":0,"title":"Offset"},"description":"Rows to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/reach/{entity_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Detail","description":"ACO REACH entity detail with financials and participant list.\n\nFinancials are returned for every performance year. The participant list is\npaged and covers one year at a time: use `provider_total` to page through\nit. Without `year` the entity row and participants come from the most\nrecent year available.\n\nParticipants carry no NPI. CMS publishes only `par_lbn`, a free-text legal\nbusiness name that for REACH is usually an individual clinician's name.","operationId":"reach_detail_vbc_reach__entity_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2021-2026","title":"Year"},"description":"Performance year, 2021-2026"},{"name":"provider_limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"Participants per page","default":500,"title":"Provider Limit"},"description":"Participants per page"},{"name":"provider_offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Participant page offset","default":0,"title":"Provider Offset"},"description":"Participant page offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/reach/{entity_id}/clinicians":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Clinicians","description":"The clinicians Verzi links to this ACO, one row per NPI.\n\n`entity_id` is the ACO REACH entity ID, such as `D0211`.\n\nThe rows are the reverse of `/provider/{npi}/acos`. Each row gives the\nNPI's best link `confidence` to this ACO and every `match_methods` entry\nthat linked it. A name match is never presented as exact: treat `medium`\nand `low` rows as leads to verify. `min_confidence` keeps rows at that\nlevel or better (default `low`, so every linked NPI). `total` counts every\nNPI that matches the filters, across all pages.","operationId":"reach_clinicians_vbc_reach__entity_id__clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}},{"name":"min_confidence","in":"query","required":false,"schema":{"type":"string","pattern":"^(high|medium|low)$","description":"high, medium or low","default":"low","title":"Min Confidence"},"description":"high, medium or low"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year of the link","title":"Year"},"description":"Performance year of the link"},{"name":"match_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(cms_qpp_participation|organization_name_match|individual_name_match)$"},{"type":"null"}],"description":"Only links made by this method","title":"Match Method"},"description":"Only links made by this method"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/ngaco":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Ngaco List","description":"Next Generation ACO financial performance records, paged.\n\nOne row per ACO per performance year (6 years, about 225 rows). The answer\ncarries `total`, so a caller pages with `offset` until it has `total` rows.","operationId":"ngaco_list_vbc_ngaco_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Rows per page","default":50,"title":"Limit"},"description":"Rows per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip","default":0,"title":"Offset"},"description":"Rows to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/ngaco/{aco_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Ngaco Detail","description":"NGACO financial performance for a specific ACO.","operationId":"ngaco_detail_vbc_ngaco__aco_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/hac/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hac Measures","description":"HAC Reduction Program measures for a hospital.","operationId":"hac_measures_vbc_hac__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Year"},"description":"Fiscal year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/hac-worst":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hac Worst","description":"Hospitals with worst HAC scores (highest risk of payment reduction).","operationId":"hac_worst_vbc_hac_worst_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/hrrp":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp Search","description":"Search hospitals by HRRP payment reduction, worst penalties first.","operationId":"hrrp_search_vbc_hrrp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Fiscal Year"},"description":"Fiscal year (default: latest)"},{"name":"min_reduction_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum payment reduction percentage","title":"Min Reduction Pct"},"description":"Minimum payment reduction percentage"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/hrrp/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp History","description":"HRRP payment adjustment factor history for a hospital, all fiscal years.","operationId":"hrrp_history_vbc_hrrp__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/hrrp/{ccn}/measures":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp Measures","description":"Per-condition HRRP detail (excess readmission ratios) for a hospital.","operationId":"hrrp_measures_vbc_hrrp__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Fiscal Year"},"description":"Fiscal year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/models":{"get":{"tags":["Value-Based Care / ACO"],"summary":"List Models","description":"The Innovation Center models we load, with CMS's stage for each,\nwhat CMS publishes, and the rows and periods we hold.","operationId":"list_models_vbc_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/vbc/models/by-npi/{npi}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Models By Npi","description":"The model participations CMS states for an NPI.\n\nToday only BPCI Advanced publishes NPIs: the attending and operating\nanchor providers of each episode initiator, from the model's data\ncrosswalk. Every row carries `match_method` `cms_crosswalk_npi` and\n`confidence` `high`; none is a name match. An NPI with no stated\nparticipation gets an empty list, not a 404.","operationId":"models_by_npi_vbc_models_by_npi__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{10}$","description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/models/{model_id}/participants":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Model Participants","description":"One model's participants, newest period first. `source_row` carries\nthe CMS row as published.","operationId":"model_participants_vbc_models__model_id__participants_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team","title":"Model Id"},"description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state","title":"State"},"description":"Two-letter state"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Legal or DBA name (partial match)","title":"Q"},"description":"Legal or DBA name (partial match)"},{"name":"ccn","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital CCN (CJR, BPCI Advanced anchors)","title":"Ccn"},"description":"Hospital CCN (CJR, BPCI Advanced anchors)"},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A model year (MY8), performance year (PY2024) or list date","title":"Period"},"description":"A model year (MY8), performance year (PY2024) or list date"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/vbc/models/{model_id}/results":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Model Results","description":"One model's financial and quality results in long form: one row per\nparticipant, period and metric. `value_num` holds a number; `value_text`\nholds a category such as \"Decile 9\" or \"PASS\". A model whose results CMS\ndoes not publish returns an empty list.","operationId":"model_results_vbc_models__model_id__results_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team","title":"Model Id"},"description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team"},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Performance year, e.g. PY2024 or PY5.1","title":"Period"},"description":"Performance year, e.g. PY2024 or PY5.1"},{"name":"participant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CMS participant id (CCN, KCC_ID, BPID)","title":"Participant Id"},"description":"CMS participant id (CCN, KCC_ID, BPID)"},{"name":"ccn","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital CCN (CJR)","title":"Ccn"},"description":"Hospital CCN (CJR)"},{"name":"metric","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Metric key, e.g. final_reconciliation_amount","title":"Metric"},"description":"Metric key, e.g. final_reconciliation_amount"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Participant name (partial match)","title":"Q"},"description":"Participant name (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/portfolio":{"get":{"tags":["Portfolios & Analytics"],"summary":"List Portfolios Endpoint","description":"List all portfolios for your organization.","operationId":"list_portfolios_endpoint_portfolio_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true},"post":{"tags":["Portfolios & Analytics"],"summary":"Create Portfolio Endpoint","description":"Create a new portfolio of hospitals.","operationId":"create_portfolio_endpoint_portfolio_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/portfolio/{portfolio_id}":{"get":{"tags":["Portfolios & Analytics"],"summary":"Get Portfolio Endpoint","description":"Get portfolio details.","operationId":"get_portfolio_endpoint_portfolio__portfolio_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true},"put":{"tags":["Portfolios & Analytics"],"summary":"Update Portfolio Endpoint","description":"Update a portfolio.","operationId":"update_portfolio_endpoint_portfolio__portfolio_id__put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true},"delete":{"tags":["Portfolios & Analytics"],"summary":"Delete Portfolio Endpoint","description":"Delete a portfolio.","operationId":"delete_portfolio_endpoint_portfolio__portfolio_id__delete","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/portfolio/{portfolio_id}/hcahps/summary":{"get":{"tags":["Portfolios & Analytics"],"summary":"Portfolio Hcahps Summary","description":"HCAHPS dimension summaries for all hospitals in a portfolio.","operationId":"portfolio_hcahps_summary_portfolio__portfolio_id__hcahps_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/portfolio/{portfolio_id}/hcahps/outliers":{"get":{"tags":["Portfolios & Analytics"],"summary":"Portfolio Outliers","description":"Find hospitals in portfolio below a national percentile threshold.","operationId":"portfolio_outliers_portfolio__portfolio_id__hcahps_outliers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"threshold","in":"query","required":false,"schema":{"type":"integer","maximum":99,"minimum":1,"description":"Percentile threshold (hospitals below this)","default":25,"title":"Threshold"},"description":"Percentile threshold (hospitals below this)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/watchlists":{"get":{"tags":["Portfolios & Analytics"],"summary":"List Watchlists Endpoint","description":"List your organization's watchlists.","operationId":"list_watchlists_endpoint_watchlists_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true},"post":{"tags":["Portfolios & Analytics"],"summary":"Create Watchlist Endpoint","description":"Create a watchlist to monitor portfolio hospitals.","operationId":"create_watchlist_endpoint_watchlists_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchlistCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/alerts":{"get":{"tags":["Portfolios & Analytics"],"summary":"Get Alerts Endpoint","description":"Get alerts triggered by your watchlists.","operationId":"get_alerts_endpoint_alerts_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"unread_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only show unread alerts","default":true,"title":"Unread Only"},"description":"Only show unread alerts"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/alerts/{alert_id}/read":{"put":{"tags":["Portfolios & Analytics"],"summary":"Mark Alert Read Endpoint","description":"Mark an alert as read.","operationId":"mark_alert_read_endpoint_alerts__alert_id__read_put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"integer","title":"Alert Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/export/hcahps/facility/{ccn}":{"get":{"tags":["Export"],"summary":"Export Facility Hcahps","description":"Export full HCAHPS history for a facility with benchmarks and percentiles.","operationId":"export_facility_hcahps_export_hcahps_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"Export format: csv or json","default":"csv","title":"Format"},"description":"Export format: csv or json"},{"name":"quarters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated quarters, or 'all'","title":"Quarters"},"description":"Comma-separated quarters, or 'all'"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/export/hcahps/portfolio/{portfolio_id}":{"get":{"tags":["Export"],"summary":"Export Portfolio Hcahps","description":"Export HCAHPS data for all hospitals in a portfolio.","operationId":"export_portfolio_hcahps_export_hcahps_portfolio__portfolio_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"Export format: csv or json","default":"csv","title":"Format"},"description":"Export format: csv or json"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinical-trials":{"get":{"tags":["Clinical Trials"],"summary":"Clinical Trials Search","description":"Search ClinicalTrials.gov studies with at least one US-located site.","operationId":"clinical_trials_search_clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by trial title (partial match)","title":"Q"},"description":"Search by trial title (partial match)"},{"name":"condition","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by condition (partial match)","title":"Condition"},"description":"Filter by condition (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by site state (2-letter code)","title":"State"},"description":"Filter by site state (2-letter code)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by overall status (e.g. RECRUITING, COMPLETED)","title":"Status"},"description":"Filter by overall status (e.g. RECRUITING, COMPLETED)"},{"name":"sponsor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by lead sponsor (partial match)","title":"Sponsor"},"description":"Filter by lead sponsor (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinical-trials/{nct_id}":{"get":{"tags":["Clinical Trials"],"summary":"Clinical Trial Detail","description":"Full trial detail including matched facility sites and investigators.","operationId":"clinical_trial_detail_clinical_trials__nct_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"nct_id","in":"path","required":true,"schema":{"type":"string","title":"Nct Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/clinical-trials/provider/{npi}":{"get":{"tags":["Clinical Trials"],"summary":"Provider Clinical Trials","description":"Clinical trials where this provider (by NPI) is listed as an investigator.","operationId":"provider_clinical_trials_clinical_trials_provider__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/summary":{"get":{"tags":["Drug Economics"],"summary":"Row counts and freshness across the drug economics layer","description":"Counts and latest dates for every rx dataset: NDC packages, RxNorm links,\ningredients, NADAC rows and as-of date, CMS spending, SDUD, current\nshortages, Cost Plus products captured, and employer health plans.","operationId":"rx_summary_rx_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/rx/ingredients":{"get":{"tags":["Drug Economics"],"summary":"Search active ingredients with NDC counts and median generic NADAC","description":"One row per RxNorm ingredient: how many NDCs carry it, how many are\nbranded, how many have a NADAC price, and the median generic NADAC per\nunit at the latest effective date.","operationId":"rx_ingredients_rx_ingredients_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient name (partial match), e.g. atorvastatin","title":"Q"},"description":"Ingredient name (partial match), e.g. atorvastatin"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/ingredients/{rxcui}":{"get":{"tags":["Drug Economics"],"summary":"Ingredient detail: NDCs with NADAC, CMS spending, Cost Plus, shortages","description":"Every NDC that resolves to the ingredient with its latest NADAC, the\nCMS Part D, Part B, and Medicaid spending rows for matching generic\nnames, Cost Plus products matched to the ingredient's clinical drugs,\nand openFDA shortage records.","operationId":"rx_ingredient_rx_ingredients__rxcui__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"rxcui","in":"path","required":true,"schema":{"type":"string","description":"RxNorm RXCUI of the ingredient, e.g. 83367","title":"Rxcui"},"description":"RxNorm RXCUI of the ingredient, e.g. 83367"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/ndcs/{ndc11}":{"get":{"tags":["Drug Economics"],"summary":"NDC package profile with RxNorm, NADAC, and national Medicaid utilization","operationId":"rx_ndc_rx_ndcs__ndc11__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/ndcs/{ndc11}/nadac":{"get":{"tags":["Drug Economics"],"summary":"NADAC price history for one NDC (change-only series)","operationId":"rx_ndc_nadac_rx_ndcs__ndc11__nadac_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/nadac/movers":{"get":{"tags":["Drug Economics"],"summary":"Largest NADAC price moves in the last N weeks","description":"Percent change between an NDC's latest effective price and the one\nbefore it, for NDCs whose price changed inside the window.","operationId":"rx_nadac_movers_rx_nadac_movers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"weeks","in":"query","required":false,"schema":{"type":"integer","maximum":104,"minimum":1,"default":4,"title":"Weeks"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"up or down","default":"up","title":"Direction"},"description":"up or down"},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"G (generic) or B (brand)","title":"Classification"},"description":"G (generic) or B (brand)"},{"name":"min_per_unit","in":"query","required":false,"schema":{"type":"number","minimum":0,"description":"Ignore NDCs priced below this per unit","default":0.0,"title":"Min Per Unit"},"description":"Ignore NDCs priced below this per unit"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/spending":{"get":{"tags":["Drug Economics"],"summary":"CMS Spending by Drug (Part D, Part B, Medicaid), one row per drug and year","operationId":"rx_spending_rx_spending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"program","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: partd, partb, medicaid","title":"Program"},"description":"One of: partd, partb, medicaid"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Generic or brand name (partial match)","title":"Q"},"description":"Generic or brand name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2013},{"type":"null"}],"title":"Year"}},{"name":"manufacturer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"'Overall' for the program total, a labeler name, or empty for all","default":"Overall","title":"Manufacturer"},"description":"'Overall' for the program total, a labeler name, or empty for all"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/spending/top":{"get":{"tags":["Drug Economics"],"summary":"Top drugs by total spending for a program and year","operationId":"rx_spending_top_rx_spending_top_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"program","in":"query","required":false,"schema":{"type":"string","description":"One of: partd, partb, medicaid","default":"partd","title":"Program"},"description":"One of: partd, partb, medicaid"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2013},{"type":"null"}],"description":"Defaults to the latest loaded year","title":"Year"},"description":"Defaults to the latest loaded year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/shortages":{"get":{"tags":["Drug Economics"],"summary":"FDA drug shortages (openFDA)","operationId":"rx_shortages_rx_shortages_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current or Resolved (prefix match)","title":"Status"},"description":"Current or Resolved (prefix match)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Generic name or company (partial match)","title":"Q"},"description":"Generic name or company (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/cost-plus":{"get":{"tags":["Drug Economics"],"summary":"Cost Plus Drugs public prices beside median NADAC","operationId":"rx_costplus_rx_cost_plus_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Product, brand, or slug (partial match)","title":"Q"},"description":"Product, brand, or slug (partial match)"},{"name":"matched_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only products matched to an RxNorm clinical drug","default":false,"title":"Matched Only"},"description":"Only products matched to an RxNorm clinical drug"},{"name":"in_stock","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Stock"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/cost-plus/catalog/timeline":{"get":{"tags":["Drug Economics"],"summary":"Cost Plus catalog size by month since 2022 and products first seen each month","description":"One row per month with a usable Internet Archive sitemap capture (or\nthe live catalog for the current month): how many medication slugs the\ncatalog listed, and how many products are first seen in that month.","operationId":"rx_costplus_timeline_rx_cost_plus_catalog_timeline_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/rx/cost-plus/{slug}":{"get":{"tags":["Drug Economics"],"summary":"One Cost Plus product with its dated price history and catalog entry month","operationId":"rx_costplus_product_rx_cost_plus__slug__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"URL slug, e.g. atorvastatin-10mg-tablet","title":"Slug"},"description":"URL slug, e.g. atorvastatin-10mg-tablet"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/meps/mix":{"get":{"tags":["Drug Economics"],"summary":"Weighted drug mix by ingredient for a MEPS payer segment (the commercial population)","description":"Ingredient shares of fills and spend for one payer segment, with the\nmedian generic NADAC per unit beside what MEPS respondents' payers paid\nper unit. Answers \"what does a commercially insured population actually\nfill, and what is it paying against acquisition cost.","operationId":"rx_meps_mix_rx_meps_mix_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2018},{"type":"null"}],"description":"Survey year; defaults to the latest loaded","title":"Year"},"description":"Survey year; defaults to the latest loaded"},{"name":"segment","in":"query","required":false,"schema":{"type":"string","description":"One of: private_under_65, private_65_plus, public_only, uninsured","default":"private_under_65","title":"Segment"},"description":"One of: private_under_65, private_65_plus, public_only, uninsured"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient name (partial match)","title":"Q"},"description":"Ingredient name (partial match)"},{"name":"min_sample","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Minimum unweighted fills in the sample","default":20,"title":"Min Sample"},"description":"Minimum unweighted fills in the sample"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"spend, fills, or paid_per_unit","default":"spend","title":"Sort"},"description":"spend, fills, or paid_per_unit"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/pharmacies":{"get":{"tags":["Drug Economics"],"summary":"Pharmacies from NPPES with type, chain flag, metro, and county","operationId":"rx_pharmacies_rx_pharmacies_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pharmacy name (partial match)","title":"Q"},"description":"Pharmacy name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"zip5","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":5,"maxLength":5},{"type":"null"}],"title":"Zip5"}},{"name":"county_fips","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":5,"maxLength":5},{"type":"null"}],"title":"County Fips"}},{"name":"cbsa","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cbsa"}},{"name":"pharmacy_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: community_retail, clinic, compounding, home_infusion, institutional, long_term_care, mail_order, managed_care, nuclear, specialty, pharmacy","title":"Pharmacy Type"},"description":"One of: community_retail, clinic, compounding, home_infusion, institutional, long_term_care, mail_order, managed_care, nuclear, specialty, pharmacy"},{"name":"chain","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for chains, false for independents","title":"Chain"},"description":"true for chains, false for independents"},{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Active"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/pharmacies/access":{"get":{"tags":["Drug Economics"],"summary":"Pharmacy access by county: retail pharmacies per 10K residents beside SVI","description":"The pharmacy-desert table: every county with its active retail pharmacy\nstorefronts, independents versus chains, and the CDC Social Vulnerability\nIndex, uninsured rate, and no-vehicle rate. min_population defaults to\n10,000; pass 0 for all 3,144 counties.","operationId":"rx_pharmacy_access_rx_pharmacies_access_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"min_population","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":10000,"title":"Min Population"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"retail_per_10k (fewest first), svi, independents","default":"retail_per_10k","title":"Sort"},"description":"retail_per_10k (fewest first), svi, independents"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/demand":{"get":{"tags":["Drug Economics"],"summary":"Part D prescribing volume for a generic by state, metro, or county","operationId":"rx_demand_rx_demand_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"generic","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"Generic name (partial match), e.g. atorvastatin","title":"Generic"},"description":"Generic name (partial match), e.g. atorvastatin"},{"name":"level","in":"query","required":false,"schema":{"type":"string","description":"state, cbsa, or county","default":"cbsa","title":"Level"},"description":"state, cbsa, or county"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Restrict county rows to one state","title":"State"},"description":"Restrict county rows to one state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/asp":{"get":{"tags":["Drug Economics"],"summary":"Medicare Part B ASP payment limits by HCPCS code (quarterly)","operationId":"rx_asp_rx_asp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Short description (partial match), e.g. ustekinumab. Public HCPCS Level II rows only: a CPT descriptor is not served or searched","title":"Q"},"description":"Short description (partial match), e.g. ustekinumab. Public HCPCS Level II rows only: a CPT descriptor is not served or searched"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HCPCS code, e.g. J3357","title":"Hcpcs"},"description":"HCPCS code, e.g. J3357"},{"name":"ndc","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit NDC; resolves to its HCPCS through the crosswalk","title":"Ndc"},"description":"11-digit NDC; resolves to its HCPCS through the crosswalk"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter start date YYYY-MM-DD; defaults to the latest final quarter","title":"Quarter"},"description":"Quarter start date YYYY-MM-DD; defaults to the latest final quarter"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/biosimilars":{"get":{"tags":["Drug Economics"],"summary":"Purple Book biosimilars beside the reference product's ASP and Cost Plus price","operationId":"rx_biosimilars_rx_biosimilars_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"molecule","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proper name (partial match), e.g. ustekinumab","title":"Molecule"},"description":"Proper name (partial match), e.g. ustekinumab"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":200,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/employers":{"get":{"tags":["Drug Economics"],"summary":"Employer health plans (DOL 5500) with funding class, PBM, and drug-coverage carriers","description":"One row per health-plan filing. The default sort is active participants,\nlargest first, which makes the unfiltered call a ranked target list.","operationId":"rx_employers_rx_employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor or plan name (partial match)","title":"Q"},"description":"Sponsor or plan name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"funding_class","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: self_funded_only, self_funded_plus_insurance, insured_only, unspecified","title":"Funding Class"},"description":"One of: self_funded_only, self_funded_plus_insurance, insured_only, unspecified"},{"name":"pbm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"PBM family (partial match), e.g. Optum","title":"Pbm"},"description":"PBM family (partial match), e.g. Optum"},{"name":"min_participants","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum active participants","title":"Min Participants"},"description":"Minimum active participants"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year (tax_period_end year)","title":"Year"},"description":"Plan year (tax_period_end year)"},{"name":"with_pbm_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only plans that name a PBM on Schedule C","default":false,"title":"With Pbm Only"},"description":"Only plans that name a PBM on Schedule C"},{"name":"cbsa","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code of the sponsor's ZIP, e.g. 34980 (Nashville)","title":"Cbsa"},"description":"CBSA code of the sponsor's ZIP, e.g. 34980 (Nashville)"},{"name":"metro","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA title (partial match), e.g. Nashville","title":"Metro"},"description":"CBSA title (partial match), e.g. Nashville"},{"name":"integration","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"same_parent, blues_affiliated, or different","title":"Integration"},"description":"same_parent, blues_affiliated, or different"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/employers/metros":{"get":{"tags":["Drug Economics"],"summary":"Self-funded health plans by metro: plans, covered employees, PBM share","description":"The employer channel on a map: every Core-Based Statistical Area ranked by\nself-funded covered employees, with the PBMs most often named there.","operationId":"rx_employer_metros_rx_employers_metros_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the fullest loaded","title":"Year"},"description":"Plan year; defaults to the fullest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"min_participants","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Only plans with at least this many active participants","default":0,"title":"Min Participants"},"description":"Only plans with at least this many active participants"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/employers/integration":{"get":{"tags":["Drug Economics"],"summary":"Self-funded plans that buy pharmacy and medical from one conglomerate","description":"Counts, covered employees, and disclosed PBM fees by integration class\n(same_parent, blues_affiliated, different, unclassified), the same by\nparent company, and the 25 largest same-parent plans.","operationId":"rx_employer_integration_rx_employers_integration_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the fullest loaded","title":"Year"},"description":"Plan year; defaults to the fullest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/employers/{ein}":{"get":{"tags":["Drug Economics"],"summary":"One employer: health-plan filings, every paid service provider, insurance contracts","operationId":"rx_employer_rx_employers__ein__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ein","in":"path","required":true,"schema":{"type":"string","description":"Plan sponsor EIN, digits only","title":"Ein"},"description":"Plan sponsor EIN, digits only"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/pbms":{"get":{"tags":["Drug Economics"],"summary":"PBM market rollup from Schedule C: plans, covered participants, disclosed fees","operationId":"rx_pbms_rx_pbms_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the latest loaded","title":"Year"},"description":"Plan year; defaults to the latest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/orange-book":{"get":{"tags":["Drug Economics"],"summary":"FDA Orange Book approved products with therapeutic equivalence codes","description":"Every product in the FDA Orange Book: brand and generic applications, their\napplicant, strength, therapeutic equivalence code, and approval date.","operationId":"rx_orange_book_rx_orange_book_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trade name or ingredient (partial match)","title":"Q"},"description":"Trade name or ingredient (partial match)"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient (partial match), e.g. semaglutide","title":"Ingredient"},"description":"Ingredient (partial match), e.g. semaglutide"},{"name":"appl_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"N for brand (NDA), A for generic (ANDA)","title":"Appl Type"},"description":"N for brand (NDA), A for generic (ANDA)"},{"name":"product_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"RX, OTC, or DISCN (discontinued)","title":"Product Type"},"description":"RX, OTC, or DISCN (discontinued)"},{"name":"te_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Therapeutic equivalence code, e.g. AB","title":"Te Code"},"description":"Therapeutic equivalence code, e.g. AB"},{"name":"applicant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Applicant name (partial match)","title":"Applicant"},"description":"Applicant name (partial match)"},{"name":"rld","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for reference listed drugs only","title":"Rld"},"description":"true for reference listed drugs only"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/orange-book/launch-radar":{"get":{"tags":["Drug Economics"],"summary":"Brand drugs with no approved generic, by the date protection ends","description":"Brand prescription products with no approved generic of the same ingredient,\ndosage form, and strength, ordered by the earliest date a generic could launch on\npaper. Products with nothing listed sort first: no barrier is on record.","operationId":"rx_generic_launch_radar_rx_orange_book_launch_radar_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient (partial match)","title":"Ingredient"},"description":"Ingredient (partial match)"},{"name":"applicant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Applicant name (partial match)","title":"Applicant"},"description":"Applicant name (partial match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Protection ends before this date (YYYY-MM-DD)","title":"Before"},"description":"Protection ends before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Protection ends on or after this date (YYYY-MM-DD)","title":"After"},"description":"Protection ends on or after this date (YYYY-MM-DD)"},{"name":"unprotected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for products with no listed patent or exclusivity","title":"Unprotected"},"description":"true for products with no listed patent or exclusivity"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/establishments":{"get":{"tags":["Drug Economics"],"summary":"FDA-registered drug establishments worldwide, filterable by operation, country, and firm","description":"Every drug establishment registered with the FDA (DECRS), with its FEI number,\nfirm name, country, and registered operations. operation=API MANUFACTURE isolates the\nplants that make an active ingredient, the supply-side view behind a drug shortage.","operationId":"rx_establishments_rx_establishments_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"operation","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered operation, e.g. API MANUFACTURE, MANUFACTURE, ANALYSIS, PACK, LABEL, STERILIZE","title":"Operation"},"description":"Registered operation, e.g. API MANUFACTURE, MANUFACTURE, ANALYSIS, PACK, LABEL, STERILIZE"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}],"description":"ISO-3 country code, e.g. USA, CHN, IND","title":"Country"},"description":"ISO-3 country code, e.g. USA, CHN, IND"},{"name":"firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Firm or registrant name (partial match)","title":"Firm"},"description":"Firm or registrant name (partial match)"},{"name":"exclusion","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for establishments flagged excluded from registration","title":"Exclusion"},"description":"true for establishments flagged excluded from registration"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/establishments/operations":{"get":{"tags":["Drug Economics"],"summary":"Distinct establishment operations with counts (the operation filter values)","description":"The 15 registered operation types with how many establishments hold each,\nmost common first. Use these exact values for the operation filter.","operationId":"rx_establishment_operations_rx_establishments_operations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/rx/recalls":{"get":{"tags":["Drug Economics"],"summary":"FDA drug recalls (openFDA enforcement), NDC-matched","description":"Drug recall enforcement reports with classification, status, recalling firm, reason,\ndistribution pattern, and dates. NDCs are extracted from the openFDA block and the\nfree-text product description and code info, then matched to the current NDC directory;\nthe response's match_stats and methodology_note report the match rate.","operationId":"rx_recalls_rx_recalls_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit NDC (5-4-2, no dashes); matches recalls that cite it","title":"Ndc"},"description":"11-digit NDC (5-4-2, no dashes); matches recalls that cite it"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient, generic, or substance name (partial match)","title":"Ingredient"},"description":"Ingredient, generic, or substance name (partial match)"},{"name":"firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Recalling firm (partial match)","title":"Firm"},"description":"Recalling firm (partial match)"},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: Class I, Class II, Class III (or I, II, III)","title":"Classification"},"description":"One of: Class I, Class II, Class III (or I, II, III)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: Ongoing, Completed, Terminated (prefix match)","title":"Status"},"description":"One of: Ongoing, Completed, Terminated (prefix match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Report date before this date (YYYY-MM-DD)","title":"Before"},"description":"Report date before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Report date on or after this date (YYYY-MM-DD)","title":"After"},"description":"Report date on or after this date (YYYY-MM-DD)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/drugsfda":{"get":{"tags":["Drug Economics"],"summary":"Drugs@FDA approved applications with first approval dates","description":"FDA-approved drug applications (NDA, ANDA, BLA) with their sponsor, products,\ningredients, first and latest approval dates, and submission and product counts.\nOrdered by first approval date, most recent first. Use GET /rx/drugsfda/{appl_no}\nfor the full product list and submission history.","operationId":"rx_drugsfda_rx_drugsfda_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor, drug name, or active ingredient (partial match)","title":"Q"},"description":"Sponsor, drug name, or active ingredient (partial match)"},{"name":"appl_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: NDA, ANDA, BLA (NDA brand, ANDA generic, BLA biologic)","title":"Appl Type"},"description":"One of: NDA, ANDA, BLA (NDA brand, ANDA generic, BLA biologic)"},{"name":"sponsor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor name (partial match)","title":"Sponsor"},"description":"Sponsor name (partial match)"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Active ingredient (partial match)","title":"Ingredient"},"description":"Active ingredient (partial match)"},{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Drug (brand) name (partial match)","title":"Drug"},"description":"Drug (brand) name (partial match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First approval before this date (YYYY-MM-DD)","title":"Before"},"description":"First approval before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First approval on or after this date (YYYY-MM-DD)","title":"After"},"description":"First approval on or after this date (YYYY-MM-DD)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/drugsfda/{appl_no}":{"get":{"tags":["Drug Economics"],"summary":"One Drugs@FDA application with products and full submission history","description":"One application's products (form, strength, ingredient, TE code, marketing status)\nand its complete submission history, original plus every supplement, with approval dates.","operationId":"rx_drugsfda_application_rx_drugsfda__appl_no__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"appl_no","in":"path","required":true,"schema":{"type":"string","description":"Application number, digits (e.g. 021688 or 21688)","title":"Appl No"},"description":"Application number, digits (e.g. 021688 or 21688)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/labels":{"get":{"tags":["Drug Economics"],"summary":"DailyMed drug labels (official SPL), version-pinned","description":"Human prescription labels from DailyMed with set_id, version, effective date, title,\nlabeler, and which of the four key sections are present. The dailymed_url is pinned to the\nstored version. Many SPL titles are the standard highlights preamble, so search also\nmatches the labeler and the RxNorm drug name.","operationId":"rx_labels_rx_labels_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title, labeler, or RxNorm drug name (partial match)","title":"Q"},"description":"Title, labeler, or RxNorm drug name (partial match)"},{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"RxNorm drug name (partial match)","title":"Drug"},"description":"RxNorm drug name (partial match)"},{"name":"labeler","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Labeler name (partial match)","title":"Labeler"},"description":"Labeler name (partial match)"},{"name":"section","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only labels with this section: boxed_warning, indications, dosage_administration, contraindications","title":"Section"},"description":"Only labels with this section: boxed_warning, indications, dosage_administration, contraindications"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/labels/{set_id}":{"get":{"tags":["Drug Economics"],"summary":"One DailyMed label with its key sections, RxNorm, and pharmacologic classes","description":"One label's boxed warning, indications, dosage and administration, and contraindications\nsection text, its RxNorm concepts, and its pharmacologic classes. The dailymed_url is pinned\nto the version we hold, so the citation never shows newer text than we stored.","operationId":"rx_label_rx_labels__set_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"set_id","in":"path","required":true,"schema":{"type":"string","description":"DailyMed SPL set_id (GUID)","title":"Set Id"},"description":"DailyMed SPL set_id (GUID)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/drug-classes":{"get":{"tags":["Drug Economics"],"summary":"Pharmacologic classes from DailyMed with label counts","description":"Pharmacologic classes from DailyMed's official class mapping, with the number of\nhuman prescription labels in each, filterable by name and FDA class type (EPC, MoA, PE, CS).","operationId":"rx_drug_classes_rx_drug_classes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Class name (partial match), e.g. HMG-CoA","title":"Q"},"description":"Class name (partial match), e.g. HMG-CoA"},{"name":"class_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: EPC, MoA, PE, CS, Chemical/Ingredient, EXT","title":"Class Type"},"description":"One of: EPC, MoA, PE, CS, Chemical/Ingredient, EXT"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/partd/plans/{contract_id}/{plan_id}/{segment_id}":{"get":{"tags":["Drug Economics"],"summary":"One Part D plan: premium, deductible, service area, and cost share by tier","description":"A Medicare Part D plan from CMS's monthly formulary public use file: premium,\ndeductible, SNP type, service area, the beneficiary cost share by tier, coverage\nlevel, days supply and pharmacy channel, and insulin cost.","operationId":"rx_partd_plan_rx_partd_plans__contract_id___plan_id___segment_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","description":"CMS contract ID, e.g. H0028 or S1030","title":"Contract Id"},"description":"CMS contract ID, e.g. H0028 or S1030"},{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","description":"Plan ID, e.g. 007","title":"Plan Id"},"description":"Plan ID, e.g. 007"},{"name":"segment_id","in":"path","required":true,"schema":{"type":"string","description":"Segment ID, 000 for R and S contracts","title":"Segment Id"},"description":"Segment ID, 000 for R and S contracts"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/partd/plans/{contract_id}/{plan_id}/{segment_id}/drugs/{ndc11}":{"get":{"tags":["Drug Economics"],"summary":"One NDC on one Part D plan: tier, utilization rules, cost share, and unit cost","description":"Whether the plan's formulary lists the NDC, with its tier, quantity limit, prior\nauthorization and step therapy; the cost share for that tier; indication-based coverage;\nand the plan's average unit cost for a 30, 60 and 90 day supply from CMS's quarterly\npricing file.","operationId":"rx_partd_plan_drug_rx_partd_plans__contract_id___plan_id___segment_id__drugs__ndc11__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","description":"CMS contract ID, e.g. H0028","title":"Contract Id"},"description":"CMS contract ID, e.g. H0028"},{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","description":"Plan ID, e.g. 007","title":"Plan Id"},"description":"Plan ID, e.g. 007"},{"name":"segment_id","in":"path","required":true,"schema":{"type":"string","description":"Segment ID, e.g. 000","title":"Segment Id"},"description":"Segment ID, e.g. 000"},{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rx/partd/drugs/{ndc11}/plans":{"get":{"tags":["Drug Economics"],"summary":"Part D plans whose formulary lists an NDC","description":"Every Part D plan whose formulary lists the NDC, lowest tier first, with prior\nauthorization, step therapy, quantity limit and the 30-day unit cost. county_code keeps\nthe plans that serve that county (local plans by county, PDPs and regional plans by region).","operationId":"rx_partd_drug_plans_rx_partd_drugs__ndc11__plans_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."},{"name":"county_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SSA county code (5 digits), e.g. 28100","title":"County Code"},"description":"SSA county code (5 digits), e.g. 28100"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/fee-schedules/opps/{hcpcs}":{"get":{"tags":["Medicare Fee Schedules"],"summary":"OPPS Addendum B payment rate for a HCPCS code, by quarter","description":"Hospital outpatient national payment rate for one code, per quarter:\nstatus indicator, APC, relative weight, payment rate and copayments, from\nCMS's quarterly Addendum B. National unadjusted amounts; no wage index is applied.","operationId":"opps_rates_fee_schedules_opps__hcpcs__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015","title":"Hcpcs"},"description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first.","title":"Quarter"},"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/fee-schedules/asc/{hcpcs}":{"get":{"tags":["Medicare Fee Schedules"],"summary":"ASC Addendum AA payment rate for a HCPCS code, by quarter","description":"Ambulatory surgical center national payment rate for one covered\nsurgical procedure, per quarter: payment indicator, multiple procedure\ndiscount, payment weight and rate, from CMS's quarterly Addendum AA.\n`office_based` is true for indicators P2 and P3; a P3 rate is based on\nMPFS nonfacility PE RVUs (Addendum DD1). National unadjusted amounts; no\nwage index is applied.","operationId":"asc_rates_fee_schedules_asc__hcpcs__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015","title":"Hcpcs"},"description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first.","title":"Quarter"},"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/state-regulations/md/comar/{section}":{"get":{"tags":["State Regulations"],"summary":"One Maryland COMAR section, in Verzi's plain structure, with its receipt","description":"The section's citation, heading, regulation text and stated effective\ndate (NULL when the archived page states none), parsed from the archived\npage. The receipt names the COMAR section, links its official page on\nregs.maryland.gov and carries the archived file's sha256. Covered today:\nCOMAR 10.09.12 (Disposable Medical Supplies and Durable Medical Equipment).","operationId":"comar_section_state_regulations_md_comar__section__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"section","in":"path","required":true,"schema":{"type":"string","description":"COMAR section number, e.g. 10.09.12.04","title":"Section"},"description":"COMAR section number, e.g. 10.09.12.04"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The date the section must be in force on (YYYY-MM-DD). Default today.","title":"As Of"},"description":"The date the section must be in force on (YYYY-MM-DD). Default today."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/signals":{"get":{"tags":["Construction Signals"],"summary":"Signals Search","description":"Search healthcare construction signals, newest first.\n\nA signal is a building permit, Certificate of Need / Determination of\nNeed filing, or statewide project registration classified as healthcare\nconstruction. Resolved signals carry the matched facility, health\nsystem, and an organizational contact from public NPPES data.","operationId":"signals_search_signals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search entity name and project description (partial match)","title":"Q"},"description":"Search entity name and project description (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state code","title":"State"},"description":"2-letter state code"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City or county (partial match)","title":"City"},"description":"City or county (partial match)"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: hospital, asc, clinic, imaging, dental, senior_care, behavioral, pharmacy_lab, other_healthcare","title":"Category"},"description":"One of: hospital, asc, clinic, imaging, dental, senior_care, behavioral, pharmacy_lab, other_healthcare"},{"name":"signal_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: permit, con_filing, project_registration","title":"Signal Type"},"description":"One of: permit, con_filing, project_registration"},{"name":"system","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved health system name (partial match)","title":"System"},"description":"Resolved health system name (partial match)"},{"name":"min_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Minimum estimated project value in USD","title":"Min Value"},"description":"Minimum estimated project value in USD"},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":1},{"type":"null"}],"description":"Only signals from the last N days","title":"Days"},"description":"Only signals from the last N days"},{"name":"resolved_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only signals resolved to a facility/system/NPI","default":false,"title":"Resolved Only"},"description":"Only signals resolved to a facility/system/NPI"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/signals/summary":{"get":{"tags":["Construction Signals"],"summary":"Signals Summary","description":"Signal counts and estimated dollar volume by state and category.","operationId":"signals_summary_signals_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":3650,"minimum":1,"description":"Aggregation window in days","default":365,"title":"Days"},"description":"Aggregation window in days"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/signals/systems":{"get":{"tags":["Construction Signals"],"summary":"Signals By System","description":"Resolved signals rolled up per health system, ranked by dollar volume.","operationId":"signals_by_system_signals_systems_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":3650,"minimum":1,"description":"Aggregation window in days","default":365,"title":"Days"},"description":"Aggregation window in days"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/ncci/ptp":{"get":{"tags":["Coding Rules"],"summary":"Is a code pair PTP-edited for a setting on a date of service","description":"The PTP edit for the pair and setting on the date, with its modifier\nindicator (0 not allowed, 1 allowed, 9 not applicable), or `edited:\nfalse` when none applies. The answer comes from CMS's PTP file in force\non the date: the complete quarter file for the date's quarter, named in\n`checked`. When Verzi holds no complete file for that quarter, the pair\nanswers `edited: null` with a `reason`; no other quarter's file answers\nfor it. For a date before 2022-01-01, a pair with a code that is not\npublic HCPCS Level II (such as a CPT or CDT code) also answers `edited: null`,\nwith `checked.rule` license_scope. The row's own effective and deletion\ndates gate the edit (half-open: the deletion date is the first day out\nof force). Codes are upper-cased; a value that is not five characters of\ndigits or letters, or a code paired with itself, is a 422. Cites the\narchive version, member file, and its sha256.","operationId":"ncci_ptp_rules_ncci_ptp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"setting","in":"query","required":true,"schema":{"type":"string","description":"practitioner | hospital","title":"Setting"},"description":"practitioner | hospital"},{"name":"code_a","in":"query","required":true,"schema":{"type":"string","description":"Column 1 (comprehensive) code","title":"Code A"},"description":"Column 1 (comprehensive) code"},{"name":"code_b","in":"query","required":true,"schema":{"type":"string","description":"Column 2 (component) code","title":"Code B"},"description":"Column 2 (component) code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtpResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/ncci/mue":{"get":{"tags":["Coding Rules"],"summary":"The MUE value and MAI for a code and setting on a date of service","description":"The per-code maximum units of service and the MUE Adjudication\nIndicator (1 line, 2 date-of-service policy, 3 date-of-service clinical)\nfrom the quarter snapshot in force on the date. When the setting's table\nfor the quarter is missing or not parsed, it answers `mue_value: null` with\na `reason` instead of 404. For a date before 2022-01-01, a code that is\nnot public HCPCS Level II (such as a CPT or CDT code) also answers\n`mue_value: null` with a `reason`. Cites the version, member\nfile, and its sha256.","operationId":"ncci_mue_rules_ncci_mue_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"setting","in":"query","required":true,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier"},{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MueResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/dmepos/fee":{"get":{"tags":["Coding Rules"],"summary":"The DMEPOS allowed amount, ceiling, and floor for a fee cell on a date of service","description":"The allowed amount for the fee cell keyed by HCPCS, both modifiers, and\narea, from the quarter snapshot in force on the date. Pass `state` (with\nan optional `rural` flag) for a state cell, or `cba` for a former\ncompetitive-bidding area. The code, the modifiers, and the state are\nupper-cased; a code that is not five characters of digits or letters is\na 422. An area string the fee schedule does not carry is a 422 that lists\nthe valid strings (and the nearest ones). Ceiling and floor are the file's\nown national values: CMS fills\nthem with zeros for codes adjusted using competitive bidding information\n(its README, fields 6 and 7), so 0.0 is CMS's value; they are null when\nthe file leaves them blank, for the non-continental areas, and for CBA\ncells. Cites the version, member file, and its sha256.","operationId":"dmepos_fee_rules_dmepos_fee_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS code","title":"Hcpcs"},"description":"HCPCS code"},{"name":"state","in":"query","required":false,"schema":{"type":"string","description":"Two-letter state or territory, e.g. AL (state cells)","title":"State"},"description":"Two-letter state or territory, e.g. AL (state cells)"},{"name":"cba","in":"query","required":false,"schema":{"type":"string","description":"Competitive-bidding area name (CBA cells); alternative to state","title":"Cba"},"description":"Competitive-bidding area name (CBA cells); alternative to state"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column; '' when absent","default":"","title":"Modifier"},"description":"'Mod' column; '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column; '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column; '' when absent"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural cell (state cells only)","default":false,"title":"Rural"},"description":"Rural cell (state cells only)"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/provider/{npi}/standing":{"get":{"tags":["Provider Standing"],"summary":"Provider standing on a date of service (exclusion, enrollment, supplier directory), with receipts","description":"Per-fact standing for the NPI on the date of service. Each present\nanswer cites the archived version, member file, and its sha256, so the\nanswer is auditable and reproducible. The bytes are fetched through the\nexisting /archive/files/{sha256}.","operationId":"provider_standing_provider__npi__standing_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","description":"10-digit NPI","title":"Npi"},"description":"10-digit NPI"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/receipt":{"get":{"tags":["Coding Rules"],"summary":"The receipt join: standing, fee cell, and edits for one code, provider, and date, each with its receipt","description":"One object per receipt, each with its fact and its receipt, or an honest\ngap state. R0 is the supplier standing; r0_ordering is the ordering\nphysician's standing, present only when ordering_npi is passed. R1 is the\nDMEPOS fee cell. R2 is the MUE (always) plus the PTP pair edit (when a\ncompanion is supplied). R3 is the served documentation-requirement set for\nthe code as of the DOS, or not_yet_available when nothing is served (spec\n§2.4). For a document with no approved coder label, R3 carries CMS's\nsections as published (section_text, marked unlabeled): an LCD's\ncoverage indications and Associated Information (where CMS states\ndocumentation requirements), and a Policy Article's text. An approved\ncoder label carries its quote as passage_text for a key with the receipt\ncapability; without it (DISABLE_AUTH dev) only one item does, marked\nsample. The payer slot defaults to medicare. payer=medicare_advantage\n(alias ma) returns the same Medicare envelope plus\nreceipts.medicare_advantage: 42 CFR 422.101(b) (the lead-in, (b)(1) to\n(b)(3), and (b)(6) with its applicability as CMS-4201-F states it) and the\nSubpart M appeal path, each quoted from the version in force on the DOS\nwith a receipt per quote, or an honest gap with a reason. beneficiary_state\nadds receipts.dme_mac (the DME MAC for the state on the DOS and that MAC's\nplace-of-service lines, quoted; which codes are valid stays a pending\ncoder label). r0.ptan_on_dos states that no held source gives the\nsupplier's PTAN dates. receipts.icd10_lists carries the covered and non-covered ICD-10-CM codes,\nCMS's descriptions and group paragraphs, of each Policy Article mapped to\nthe code, from the Article version in force on the DOS, paged by\nicd10_offset and icd10_limit; the Article's HCPCS tables are not served.\nNever a CPT descriptor.\n\nEvery block carries `crosswalk`, a Verzi Health label beside CMS's\ntext: {initial_claim, claim_denial, claim_items, denials, priority}, the\nclaim items and the Verzi denial ids (each with its outcome: returned,\ndenied, or check) the block answers. r0, r0_ordering and r2 carry the\nunion of their sub-blocks' labels; each sub-block carries its own. The\nfilters use, claim_item and denial keep only the blocks whose label\nmatches all of them; meta.filtered_out names every block left out\n(empty when none was). An unknown claim item or denial id is a 422.\n\nclaim_type (default dmepos) or claim_format names the claim type the\nreceipt is for; meta.claim_type, meta.claim_format and\nmeta.claim_type_status say which and how far it is filled. Only dmepos\nis served: any other claim type answers not_started with a reason and\nno receipts (never DME rules in its place), and claim_format=professional\nserves the dmepos blocks with status partial and the other professional\nclaim types marked not_started in meta.claim_types. An unknown value, or\na claim_type and claim_format that disagree, is a 422.","operationId":"receipt_rules_receipt_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias). Drives every receipt's as-of.","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias). Drives every receipt's as-of."},{"name":"npi","in":"query","required":true,"schema":{"type":"string","description":"10-digit billing or supplier NPI (R0 standing)","title":"Npi"},"description":"10-digit billing or supplier NPI (R0 standing)"},{"name":"ordering_npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"10-digit ordering physician NPI; adds a second R0 standing block","title":"Ordering Npi"},"description":"10-digit ordering physician NPI; adds a second R0 standing block"},{"name":"payer","in":"query","required":false,"schema":{"type":"string","description":"medicare (default) | medicare_advantage (alias ma): the same Medicare receipts plus receipts.medicare_advantage, 42 CFR 422.101(b) and the Subpart M appeal path as of the DOS. Other values return the payer block as not_yet_available","default":"medicare","title":"Payer"},"description":"medicare (default) | medicare_advantage (alias ma): the same Medicare receipts plus receipts.medicare_advantage, 42 CFR 422.101(b) and the Subpart M appeal path as of the DOS. Other values return the payer block as not_yet_available"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized).","title":"State"},"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)."},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to R2","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to R2"},{"name":"beneficiary_state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state or territory where the beneficiary lives (no other beneficiary data). Adds receipts.dme_mac: the DME MAC jurisdiction and contractor CMS's Who are the MACs page names for the state, from the version in force on the DOS, and the place-of-service lines that MAC publishes, quoted from the versions in force on the DOS. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)","title":"Beneficiary State"},"description":"Two-letter state or territory where the beneficiary lives (no other beneficiary data). Adds receipts.dme_mac: the DME MAC jurisdiction and contractor CMS's Who are the MACs page names for the state, from the version in force on the DOS, and the place-of-service lines that MAC publishes, quoted from the versions in force on the DOS. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)"},{"name":"use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"initial_claim (needed to fill the claim before it is sent) | claim_denial (needed to answer a denial). Keeps the blocks whose crosswalk label has the flag; meta.filtered_out names the rest","title":"Use"},"description":"initial_claim (needed to fill the claim before it is sent) | claim_denial (needed to answer a denial). Keeps the blocks whose crosswalk label has the flag; meta.filtered_out names the rest"},{"name":"claim_item","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A CMS-1500 item (such as 24B), attachment id (att_abn) or electronic data id (e_utn): keeps the blocks whose crosswalk label names it","title":"Claim Item"},"description":"A CMS-1500 item (such as 24B), attachment id (att_abn) or electronic data id (e_utn): keeps the blocks whose crosswalk label names it"},{"name":"denial","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A Verzi denial id, D1 to D47 (such as D25): keeps the blocks whose crosswalk label names it; meta.denial gives the row and its outcome (returned or denied)","title":"Denial"},"description":"A Verzi denial id, D1 to D47 (such as D25): keeps the blocks whose crosswalk label names it; meta.denial gives the row and its outcome (returned or denied)"},{"name":"icd10_offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"receipts.icd10_lists: the first ICD-10-CM code row to serve in each Article code list (paging; each list states codes_total and next_offset)","default":0,"title":"Icd10 Offset"},"description":"receipts.icd10_lists: the first ICD-10-CM code row to serve in each Article code list (paging; each list states codes_total and next_offset)"},{"name":"icd10_limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"receipts.icd10_lists: the most ICD-10-CM code rows to serve per Article code list; the list says so when more remain (next_offset)","default":500,"title":"Icd10 Limit"},"description":"receipts.icd10_lists: the most ICD-10-CM code rows to serve per Article code list; the list says so when more remain (next_offset)"},{"name":"claim_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format","title":"Claim Type"},"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format"},{"name":"claim_format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree","title":"Claim Format"},"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/claim-fields":{"get":{"tags":["Coding Rules"],"summary":"The claim field map on a date of service: every CMS-1500 item, attachment and electronic datum, who fills it, and the rule that decides it","description":"Every row of the claim field map in force on the DOS: the CMS-1500\nitems 1 to 33, then the claim attachments and the electronic claim data\nwhose DOS range holds the DOS (CMNs and DIFs only before 2023-01-01; an\nattachment names the form edition in force, such as the ABN's). Each row\nhas item, field, filled_by, the initial_claim and claim_denial flags,\npriority, status, the Verzi denial ids it triggers (with outcome), and\nrule: the crosswalk's source pointer and status, and the receipt blocks\nthat serve the rule. The blocks the rows name that need only the code\nand the DOS (today R2 with its MUE, R3, code, prior_authorization read\nwith no state, timely_filing and rule_passages) are built by the\nreceipt's own readers and quoted under `receipts` with their own\nreceipts; blocks that need an NPI, a fee area, a modifier or a\nbeneficiary state are named in\nrule.served_by_receipt (from /rules/receipt).\nThe map, pointers, statuses and priorities are Verzi Health labels, not\nCMS text. It takes no field values: no beneficiary or claim data.\nclaim_type (default dmepos) or claim_format works as on /rules/receipt:\na claim type that is not started answers not_started with a reason and\nno fields, and meta names the claim type.","operationId":"claim_fields_rules_claim_fields_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS code; the receipt blocks that serve a field's rule are built for it","title":"Hcpcs"},"description":"HCPCS code; the receipt blocks that serve a field's rule are built for it"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"},{"name":"use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"initial_claim (needed to fill the claim) | claim_denial (needed to answer a denial); filtered_out names the rows left out","title":"Use"},"description":"initial_claim (needed to fill the claim) | claim_denial (needed to answer a denial); filtered_out names the rows left out"},{"name":"claim_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format","title":"Claim Type"},"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format"},{"name":"claim_format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree","title":"Claim Format"},"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimFieldsResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/receipt/appeal":{"get":{"tags":["Coding Rules"],"summary":"The appeal-ready export: a receipt answer plus its receipts, assembled into a Medicare redetermination exhibit (or a Medicare Advantage reconsideration exhibit)","description":"Assemble a redetermination exhibit from the receipt envelope. It reuses\nthe receipt join (no new authority logic) and renders the exhibit over it.\nReturns a structured appeal_exhibit plus a plain rendered text draft, or a\nno_exhibit status when nothing citable is present (fail closed, design §3).\ndenial_code, when supplied, is echoed into the exhibit as context; when\nabsent, its key is omitted. payer=medicare_advantage (alias ma) frames the\nexhibit as a request to the MA organization for reconsideration and adds\nthe 42 CFR 422.101(b) and Subpart M quotes from receipts.medicare_advantage\nbeside a code-specific exhibit (never alone). This is not legal advice: the\ndraft states the evidence and the filer completes and files it.","operationId":"receipt_appeal_rules_receipt_appeal_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of. The claim's date, argued against the policy in force then.","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of. The claim's date, argued against the policy in force then."},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias).","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)."},{"name":"npi","in":"query","required":true,"schema":{"type":"string","description":"10-digit billing or supplier NPI (R0 standing)","title":"Npi"},"description":"10-digit billing or supplier NPI (R0 standing)"},{"name":"ordering_npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"10-digit ordering physician NPI; adds a second R0 standing block","title":"Ordering Npi"},"description":"10-digit ordering physician NPI; adds a second R0 standing block"},{"name":"payer","in":"query","required":false,"schema":{"type":"string","description":"medicare (default): a Medicare redetermination exhibit | medicare_advantage (alias ma): a Medicare Advantage reconsideration exhibit that adds the 42 CFR 422.101(b) and Subpart M quotes beside the code's exhibit","default":"medicare","title":"Payer"},"description":"medicare (default): a Medicare redetermination exhibit | medicare_advantage (alias ma): a Medicare Advantage reconsideration exhibit that adds the 42 CFR 422.101(b) and Subpart M quotes beside the code's exhibit"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized).","title":"State"},"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)."},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to R2","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to R2"},{"name":"denial_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CARC/RARC denial code; optional passthrough echoed into the exhibit as context","title":"Denial Code"},"description":"CARC/RARC denial code; optional passthrough echoed into the exhibit as context"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppealResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/receipt/changes":{"get":{"tags":["Coding Rules"],"summary":"The change-timeline receipt: what moved in the policy for a code between two dates of service","description":"Diff the policy receipt for the code between two dates of service: per\nblock (R1 fee, R2 MUE and PTP, R3 requirements, refill applicability) the\nsnapshot at each date and whether it changed, plus R3's requirement-level\nadded/removed. Each side keeps its own receipt. `any_change` is the headline\nfor an appeal that turns on whether the policy moved since the claim's DOS.\nPass `state` or `cba` to include the fee-cell diff; `companion` to include\nthe PTP pair.","operationId":"receipt_changes_rules_receipt_changes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The earlier date of service, YYYY-MM-DD (e.g. the claim's DOS)","title":"From"},"description":"The earlier date of service, YYYY-MM-DD (e.g. the claim's DOS)"},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The later date of service, YYYY-MM-DD (e.g. today)","title":"To"},"description":"The later date of service, YYYY-MM-DD (e.g. today)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass state or cba to include the fee diff","title":"State"},"description":"Two-letter state for the R1 fee cell; pass state or cba to include the fee diff"},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to the diff","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to the diff"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/rules/receipt/signing-key":{"get":{"tags":["Coding Rules"],"summary":"The Ed25519 public key that signs receipt attestations, for offline verification","description":"Return the public key, key id, and verification recipe for the receipt\nattestations. Unauthenticated: a public key is public, and a payer or auditor\nverifying a filed receipt must reach it without an API key. Returns 404 when\nsigning is not enabled in this deployment (local dev).","operationId":"receipt_signing_key_rules_receipt_signing_key_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyResponse"}}}}},"security":[],"deprecated":true}},"/receipt/r3/pending":{"get":{"tags":["Coding Rules"],"summary":"R3 read seam: requirement rows awaiting an approval decision, each with its span and source citation","description":"The rows awaiting a decision: grounded and either pending, or approved\nonce and now re-review (the content moved, spec §3.4). Each item carries the\nrequirement content, the span, the source citation, and the current\ncontent_hash. The admin queue renders from this and echoes content_hash as\nseen_hash on a decision. Paged: the response carries `total` (the full\npending count for the filter), so the client pages with `offset` until it\nhas them all. A review queue must never silently cap. Pass `hcpcs` to work a\nsingle code (the queue is ordered by arrival, not code, so one code's rows\ncan otherwise sit past a page boundary).","operationId":"r3_pending_receipt_r3_pending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum rows to return per page","default":200,"title":"Limit"},"description":"Maximum rows to return per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip, for paging through the full queue","default":0,"title":"Offset"},"description":"Rows to skip, for paging through the full queue"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter the queue to one HCPCS code, so a reviewer can work it end to end","title":"Hcpcs"},"description":"Filter the queue to one HCPCS code, so a reviewer can work it end to end"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/{requirement_id}/decision":{"post":{"tags":["Coding Rules"],"summary":"R3 write seam: apply a named human's approve/reject/needs_changes decision (409 if the content moved)","description":"Write the approval columns for one requirement. status must be one of\napproved | rejected | needs_changes. On approve, approved_hash is set to\ncontent_hash. Returns 404 when there is no such requirement, and 409 when\nseen_hash != content_hash (the content moved under the reviewer, spec §6.1);\non a 409 nothing is written.","operationId":"r3_decision_receipt_r3__requirement_id__decision_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"requirement_id","in":"path","required":true,"schema":{"type":"integer","title":"Requirement Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3Decision"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/labels/pending":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label read seam: labels awaiting an approval decision, each with its verbatim quote and context","description":"The passage-layer labels awaiting a decision (migration 128,\ndocs/VERBATIM_DECISION.md): pending, or approved once and now re-review\n(the content moved). Each item carries the label, the VERBATIM quote\nwith surrounding context from the pinned rendering, the section\ncitation, and the content_hash the portal echoes back as seen_hash.\nBy default only labels on the version in force today are listed;\nin_force_total and superseded_total give both counts, and scope lists\nthe others. Same contract as /receipt/r3/pending. Ordered by the\nautomated cross-check's review bucket (disagree, then the double-checked\ntier, then the rest; migration 229); a double-checked label is still\npending and only a coder's decision approves it.","operationId":"r3_labels_pending_receipt_r3_labels_pending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum rows to return per page","default":200,"title":"Limit"},"description":"Maximum rows to return per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip, for paging through the full queue","default":0,"title":"Offset"},"description":"Rows to skip, for paging through the full queue"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter the queue to one HCPCS code","title":"Hcpcs"},"description":"Filter the queue to one HCPCS code"},{"name":"scope","in":"query","required":false,"schema":{"type":"string","pattern":"^(in_force|superseded|all)$","description":"in_force: labels on the version in force today (default); superseded: labels on a version not in force today (older or upcoming); all: both","default":"in_force","title":"Scope"},"description":"in_force: labels on the version in force today (default); superseded: labels on a version not in force today (older or upcoming); all: both"},{"name":"bucket","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(disagree|tier|rest)$"},{"type":"null"}],"description":"The automated cross-check's review bucket: disagree (reviews disagreed, unsure, or a rule flag), tier (double-checked, awaiting coder), rest. Omit for all","title":"Bucket"},"description":"The automated cross-check's review bucket: disagree (reviews disagreed, unsure, or a rule flag), tier (double-checked, awaiting coder), rest. Omit for all"},{"name":"run","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Only labels from this check run","title":"Run"},"description":"Only labels from this check run"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/labels/counts":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label counts per HCPCS code: pending, approved, rejected","description":"Per-code counts for the label review queue. pending uses the same rule\nas /receipt/r3/labels/pending (includes re-review); approved counts labels whose\napproval still pins the current content.","operationId":"r3_label_counts_receipt_r3_labels_counts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/receipt/r3/labels/{label_id}/decision":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: apply a named human's decision (409 if the content moved)","description":"Write the approval columns for one label. Same 409 rule as the\nrequirement seam: a seen_hash mismatch writes nothing.","operationId":"r3_label_decision_receipt_r3_labels__label_id__decision_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3Decision"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/labels/{label_id}/extend":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: extend an approved label on the same words to this pending label's codes (409 if either moved)","description":"One coder action: the pending label's codes join the approved label\n(w3_label_code) and the pending label is merged into it. The approved\nlabel's approval and content never change. Same 409 rules as the\ndecision seam; not_extendable when either label left the state the\nreviewer saw.","operationId":"r3_label_extend_receipt_r3_labels__label_id__extend_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3LabelExtend"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/labels/batch-pool":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label batch sign-off: one double-checked group's pool, the sample size the rule asks for, and the sample","description":"Every live double-checked label of the run in the group, the sample\nsize (zero defects in a random sample shows the group's defect rate is\nunder 5% with 95% confidence, hypergeometric), the sample (drawn the same\nway every time for the same pool), and each sampled label with its quote\nfor the certified coder's own decision. Reads only.","operationId":"r3_label_batch_pool_receipt_r3_labels_batch_pool_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"run","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The automated check run","title":"Run"},"description":"The automated check run"},{"name":"codes","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"Comma-separated codes; a pool label applies to one of them","title":"Codes"},"description":"Comma-separated codes; a pool label applies to one of them"},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"Comma-separated label kinds","title":"Kinds"},"description":"Comma-separated label kinds"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/receipt/r3/labels/batch-signoff":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: a coder signs off a sampled double-checked group (audit recorded)","description":"Records the audit and approves the un-sampled pool members only when\nevery sampled label was approved by the coder and the coder confirms\n(label_tier.batch_signoff). 422 when refused: nothing is written then.","operationId":"r3_label_batch_signoff_receipt_r3_labels_batch_signoff_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3BatchSignoff"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/receipt/r3/labels/{label_id}/claim-refs":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label claim refs: the denial ids and claim items one label answers","description":"The label's denial_ids and claim_items (migration 228), who set them\nand when, and its approval_status and content_hash.","operationId":"r3_label_claim_refs_receipt_r3_labels__label_id__claim_refs_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true},"put":{"tags":["Coding Rules"],"summary":"R3 passage-label claim refs write seam: set the denial ids and claim items one label answers (409 if the content moved)","description":"Set denial_ids and/or claim_items on one label. Metadata only: the\napproval columns are never written, so this never approves a label and\nnever drops one to pending. 422 for a bad id or item; 409 when seen_hash\ndiffers from content_hash or the label was merged; nothing is written\nthen.","operationId":"r3_label_set_claim_refs_receipt_r3_labels__label_id__claim_refs_put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3LabelClaimRefs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/source-proof":{"get":{"tags":["Coding Rules"],"summary":"Source proof: resolve a citation to the cited passage in the archived rendering","description":"Resolve a receipt citation to the exact passage in the archived\nrendering. Give render_sha256 (preferred), OR doc_id + version_id, plus the\nspan (start, end).\n\nWith Accept: text/html this returns a page that shows the passage\nhighlighted. Otherwise it returns the JSON receipt. An unknown citation\nanswers 404; a resolving citation whose span misses answers 200 with\nfound=false. The receipt shows the archived rendering identified by\nrender_sha256, not the live document.","operationId":"source_proof_source_proof_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"render_sha256","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rendering hash from the citation (preferred)","title":"Render Sha256"},"description":"The rendering hash from the citation (preferred)"},{"name":"doc_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The citation's document (use with version_id when render_sha256 is absent)","title":"Doc Id"},"description":"The citation's document (use with version_id when render_sha256 is absent)"},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The citation's version (use with doc_id)","title":"Version Id"},"description":"The citation's version (use with doc_id)"},{"name":"start","in":"query","required":true,"schema":{"type":"integer","description":"Span start offset into the rendering","title":"Start"},"description":"Span start offset into the rendering"},{"name":"end","in":"query","required":true,"schema":{"type":"integer","description":"Span end offset into the rendering","title":"End"},"description":"Span end offset into the rendering"},{"name":"accept","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accept"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/subscriptions":{"post":{"tags":["Change Subscriptions"],"summary":"Subscribe to the change feed (email digest or signed webhook)","description":"Email: public, double opt-in. The response is the same whether or\nnot the address already subscribes; the confirmation email carries the\nlink. Webhook: needs an API key; the response carries the HMAC secret\nonce, and never again.","operationId":"create_subscription_subscriptions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"deprecated":true}},"/v1/health":{"get":{"tags":["Stats & Measures"],"summary":"Health Check","description":"Shallow health check for CI/CD smoke tests.\n\nStatic response — no dependency checks — so CI probes stay fast and\ncan't fail on transient AWS/DB blips. For a real dependency audit see\n/health/deep.","operationId":"health_check_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/v1/health/deep":{"get":{"tags":["Stats & Measures"],"summary":"Health Check Deep","description":"Deep health check — runs live dependency probes against\nPostgreSQL, S3, SES, and the pipeline freshness window.\n\nSlower than /health (typically 100-500ms) because of network hops.\nNot appropriate for high-frequency CI polling; use /health for that.\n/status renders this same payload as HTML for browser visitors.","operationId":"health_check_deep_v1_health_deep_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/v1/stats":{"get":{"tags":["Stats & Measures"],"summary":"Get Stats","description":"Get API statistics — uses DB counts when in DB mode, in-memory data otherwise.","operationId":"get_stats_v1_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/measures/national":{"get":{"tags":["Stats & Measures"],"summary":"Get National Measures Endpoint","description":"Get national-level aggregate measures (DB mode only)","operationId":"get_national_measures_endpoint_v1_measures_national_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Measure category","title":"Category"},"description":"Measure category"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/measures/state":{"get":{"tags":["Stats & Measures"],"summary":"Get State Measures Endpoint","description":"Get state-level aggregate measures (DB mode only)","operationId":"get_state_measures_endpoint_v1_measures_state_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State code (e.g., CA)","title":"State"},"description":"State code (e.g., CA)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/quarters":{"get":{"tags":["Stats & Measures"],"summary":"Get Quarters Endpoint","description":"List all loaded data quarters (DB mode only)","operationId":"get_quarters_endpoint_v1_quarters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/hospitals/{ccn}":{"get":{"tags":["Hospitals"],"summary":"Get one hospital by CCN","description":"Get a specific hospital by its CMS Certification Number (CCN).\n\nA CCN is a 6-character identifier issued by CMS. Hospital CCNs typically\nstart with 0-4 (state region prefix). Response includes the latest star\nrating, address, bed count, system affiliation (if mapped), and\nlatitude/longitude.","operationId":"get_hospital_v1_hospitals__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","title":"Ccn"},"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","example":"460001"}],"responses":{"200":{"description":"Hospital record with star ratings, address, bed count, system affiliation, and coordinates.","content":{"application/json":{"schema":{},"example":{"ccn":"460001","name":"Intermountain Health Utah Valley Hospital","city":"Provo","state":"UT","zip_code":"84604","overall_rating":5,"type":"Acute Care","beds":395,"system_name":"Intermountain Health","latitude":40.2456,"longitude":-111.6547}}}},"404":{"description":"No hospital found with that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/history":{"get":{"tags":["Hospitals"],"summary":"Star rating history for a hospital","description":"Historical star ratings for a hospital, one row per quarter.\n\nHospitals typically have 30+ quarters of ratings history in our dataset.\nUse this to visualize rating trends or detect a facility that's improving\nor declining.","operationId":"get_hospital_history_v1_hospitals__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","title":"Ccn"},"description":"6-character CMS Certification Number (CCN). Example: `460001` (Intermountain Health Utah Valley).","example":"460001"}],"responses":{"200":{"description":"Time series of overall star ratings, oldest to newest.","content":{"application/json":{"schema":{}}}},"404":{"description":"No historical data found for that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/measures":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Measures Endpoint","description":"Get clinical measures for a hospital (DB mode only)","operationId":"get_hospital_measures_endpoint_v1_hospitals__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Measure category (e.g., infections, complications)","title":"Category"},"description":"Measure category (e.g., infections, complications)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/hcahps":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Hcahps Endpoint","description":"Get HCAHPS patient experience data for a hospital (DB mode only)","operationId":"get_hospital_hcahps_endpoint_v1_hospitals__ccn__hcahps_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HCAHPS dimension filter (e.g., nurse_communication, overall_rating)","title":"Dimension"},"description":"HCAHPS dimension filter (e.g., nurse_communication, overall_rating)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/hai":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Hai Endpoint","description":"Get Healthcare Associated Infections (HAI) detail for a hospital","operationId":"get_hospital_hai_endpoint_v1_hospitals__ccn__hai_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2026-02). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2026-02). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/leapfrog":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Leapfrog Endpoint","description":"Get Leapfrog Hospital Safety Grade for a hospital","operationId":"get_hospital_leapfrog_endpoint_v1_hospitals__ccn__leapfrog_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading period (e.g., spring_2025). Defaults to latest.","title":"Period"},"description":"Grading period (e.g., spring_2025). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/leapfrog/history":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Leapfrog History Endpoint","description":"Get all Leapfrog Hospital Safety Grade periods for a hospital","operationId":"get_hospital_leapfrog_history_endpoint_v1_hospitals__ccn__leapfrog_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/case-mix-index":{"get":{"tags":["Hospitals"],"summary":"Get Case Mix Index Endpoint","description":"Get CMS IPPS Impact File history for a hospital: case mix index, wage index, DSH percentage, by fiscal year (DB mode only)","operationId":"get_case_mix_index_endpoint_v1_hospitals__ccn__case_mix_index_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/services":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Services Endpoint","description":"Get service-line availability for a hospital from the CMS Provider of Services file (DB mode only)","operationId":"get_hospital_services_endpoint_v1_hospitals__ccn__services_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals/{ccn}/clinical-trials":{"get":{"tags":["Hospitals"],"summary":"Get Hospital Clinical Trials Endpoint","description":"Get clinical trials with a matched site at this hospital, from ClinicalTrials.gov (DB mode only)","operationId":"get_hospital_clinical_trials_endpoint_v1_hospitals__ccn__clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospitals":{"get":{"tags":["Hospitals"],"summary":"Search hospitals","description":"Search hospitals by state, city, name, rating, or proximity.\n\nCombine filters freely — all filters AND together. For proximity search,\nsupply `lat`, `lng`, and `radius_miles` together. Results include star\nrating, address, bed count, system affiliation (where mapped), and\ncoordinates.\n\nPro tip: for large data pulls, use `limit=1000` with `offset` pagination\nrather than tightening filters — pagination is cheaper than a wider\nfilter's server-side scan.","operationId":"search_hospitals_v1_hospitals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state code.","title":"State"},"description":"2-letter state code.","example":"CA"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City name (case-insensitive, partial match).","title":"City"},"description":"City name (case-insensitive, partial match).","example":"Los Angeles"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"County name (case-insensitive, partial match).","title":"County"},"description":"County name (case-insensitive, partial match).","example":"Los Angeles"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall star rating (1-5).","title":"Min Rating"},"description":"Minimum overall star rating (1-5).","example":4},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall star rating (1-5).","title":"Max Rating"},"description":"Maximum overall star rating (1-5)."},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital name (partial match, case-insensitive).","title":"Name"},"description":"Hospital name (partial match, case-insensitive).","example":"Cedars"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Center latitude for proximity search (decimal degrees).","title":"Lat"},"description":"Center latitude for proximity search (decimal degrees).","example":34.0522},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Center longitude for proximity search (decimal degrees).","title":"Lng"},"description":"Center longitude for proximity search (decimal degrees).","example":-118.2437},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius from (lat, lng) in miles.","title":"Radius Miles"},"description":"Search radius from (lat, lng) in miles.","example":25},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Core-Based Statistical Area code (Census / OMB). See /market-intelligence for CBSA lookups.","title":"Cbsa Code"},"description":"Core-Based Statistical Area code (Census / OMB). See /market-intelligence for CBSA lookups.","example":"19100"},{"name":"metro_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to metro (true) or micro (false) areas only.","title":"Metro Only"},"description":"Filter to metro (true) or micro (false) areas only."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results.","default":100,"title":"Limit"},"description":"Maximum number of results.","example":25},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Skip N results (pagination cursor).","default":0,"title":"Offset"},"description":"Skip N results (pagination cursor).","example":0}],"responses":{"200":{"description":"Paginated hospital results matching the filters.","content":{"application/json":{"schema":{},"example":{"count":5,"results":[{"ccn":"460001","name":"Intermountain Health Utah Valley Hospital","city":"Provo","state":"UT","zip_code":"84604","overall_rating":5,"type":"Acute Care","beds":395,"system_name":"Intermountain Health","latitude":40.2456,"longitude":-111.6547}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/nursing-homes/{ccn}":{"get":{"tags":["Nursing Homes"],"summary":"Get one nursing home by CCN","description":"Get a specific nursing home by its 6-character CCN.\n\nResponse includes the CMS 5-star Nursing Home Compare ratings across\nall four domains (overall, health inspection, quality measures,\nstaffing) plus bed count, penalties, and chain/system affiliation\nwhere mapped.","operationId":"get_nursing_home_v1_nursing_homes__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"description":"6-character Nursing Home CCN.","title":"Ccn"},"description":"6-character Nursing Home CCN.","example":"015009"}],"responses":{"200":{"description":"Nursing home record with 5-star ratings across overall, health inspection, staffing, and quality domains.","content":{"application/json":{"schema":{},"example":{"ccn":"015009","name":"Chapman Nursing & Rehab","state":"AL","overall_rating":3,"health_rating":2,"quality_rating":4,"staffing_rating":3,"beds":98}}}},"404":{"description":"No nursing home with that CCN."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/nursing-homes/{ccn}/history":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home History","description":"Get historical star ratings for a specific nursing home","operationId":"get_nursing_home_history_v1_nursing_homes__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/nursing-homes/{ccn}/measures":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home Measures","description":"Get quality measures for a nursing home (DB mode only)","operationId":"get_nursing_home_measures_v1_nursing_homes__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-09). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-09). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/nursing-homes/{ccn}/staffing":{"get":{"tags":["Nursing Homes"],"summary":"Get Nursing Home Staffing","description":"Get staffing data for a nursing home (DB mode only)","operationId":"get_nursing_home_staffing_v1_nursing_homes__ccn__staffing_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/nursing-homes":{"get":{"tags":["Nursing Homes"],"summary":"Search Nursing Homes","description":"Search and filter nursing homes","operationId":"search_nursing_homes_v1_nursing_homes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall rating","title":"Min Rating"},"description":"Minimum overall rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall rating","title":"Max Rating"},"description":"Maximum overall rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dialysis/{ccn}":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Facility","description":"Get a specific dialysis facility by CCN","operationId":"get_dialysis_facility_v1_dialysis__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dialysis/{ccn}/history":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis History","description":"Get historical star ratings for a specific dialysis facility","operationId":"get_dialysis_history_v1_dialysis__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dialysis/{ccn}/measures":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Measures","description":"Get quality measures for a dialysis facility (DB mode only)","operationId":"get_dialysis_measures_v1_dialysis__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-09). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-09). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dialysis/{ccn}/patient-experience":{"get":{"tags":["Dialysis"],"summary":"Get Dialysis Patient Experience","description":"Get patient experience data for a dialysis facility (DB mode only)","operationId":"get_dialysis_patient_experience_v1_dialysis__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dialysis":{"get":{"tags":["Dialysis"],"summary":"Search Dialysis","description":"Search and filter dialysis facilities","operationId":"search_dialysis_v1_dialysis_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum star rating","title":"Min Rating"},"description":"Minimum star rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum star rating","title":"Max Rating"},"description":"Maximum star rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/home-health/{ccn}":{"get":{"tags":["Home Health"],"summary":"Get Home Health Agency","description":"Get a specific home health agency by CCN","operationId":"get_home_health_agency_v1_home_health__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/home-health/{ccn}/history":{"get":{"tags":["Home Health"],"summary":"Get Home Health History","description":"Get historical star ratings for a specific home health agency","operationId":"get_home_health_history_v1_home_health__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/home-health/{ccn}/patient-experience":{"get":{"tags":["Home Health"],"summary":"Get Home Health Patient Experience","description":"Get patient experience data for a home health agency (DB mode only)","operationId":"get_home_health_patient_experience_v1_home_health__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/home-health":{"get":{"tags":["Home Health"],"summary":"Search Home Health","description":"Search and filter home health agencies","operationId":"search_home_health_v1_home_health_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"min_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum quality rating","title":"Min Rating"},"description":"Minimum quality rating"},{"name":"max_rating","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum quality rating","title":"Max Rating"},"description":"Maximum quality rating"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospice/{ccn}":{"get":{"tags":["Hospice"],"summary":"Get Hospice","description":"Get a specific hospice facility by CCN","operationId":"get_hospice_v1_hospice__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospice/{ccn}/history":{"get":{"tags":["Hospice"],"summary":"Get Hospice History","description":"Get historical quality data for a hospice facility (DB mode only)","operationId":"get_hospice_history_v1_hospice__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospice/{ccn}/measures":{"get":{"tags":["Hospice"],"summary":"Get Hospice Measures","description":"Get quality measures for a hospice facility (DB mode only)","operationId":"get_hospice_measures_v1_hospice__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospice/{ccn}/patient-experience":{"get":{"tags":["Hospice"],"summary":"Get Hospice Patient Experience","description":"Get patient experience data for a hospice facility (DB mode only)","operationId":"get_hospice_patient_experience_v1_hospice__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/hospice":{"get":{"tags":["Hospice"],"summary":"Search Hospice","description":"Search and filter hospice facilities","operationId":"search_hospice_v1_hospice_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by facility name (partial match)","title":"Name"},"description":"Search by facility name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/irf/{ccn}":{"get":{"tags":["IRF"],"summary":"Get Irf","description":"Get a specific IRF (Inpatient Rehabilitation Facility) by CCN","operationId":"get_irf_v1_irf__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/irf/{ccn}/history":{"get":{"tags":["IRF"],"summary":"Get Irf History","description":"Get historical data for an IRF facility (DB mode only)","operationId":"get_irf_history_v1_irf__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/irf/{ccn}/measures":{"get":{"tags":["IRF"],"summary":"Get Irf Measures","description":"Get quality measures for an IRF facility (DB mode only)","operationId":"get_irf_measures_v1_irf__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/irf":{"get":{"tags":["IRF"],"summary":"Search Irf","description":"Search and filter Inpatient Rehabilitation Facilities","operationId":"search_irf_v1_irf_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ltch/{ccn}":{"get":{"tags":["LTCH"],"summary":"Get Ltch","description":"Get a specific LTCH (Long-Term Care Hospital) by CCN","operationId":"get_ltch_v1_ltch__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ltch/{ccn}/history":{"get":{"tags":["LTCH"],"summary":"Get Ltch History","description":"Get historical data for an LTCH facility (DB mode only)","operationId":"get_ltch_history_v1_ltch__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ltch/{ccn}/measures":{"get":{"tags":["LTCH"],"summary":"Get Ltch Measures","description":"Get quality measures for an LTCH facility (DB mode only)","operationId":"get_ltch_measures_v1_ltch__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ltch":{"get":{"tags":["LTCH"],"summary":"Search Ltch","description":"Search and filter Long-Term Care Hospitals","operationId":"search_ltch_v1_ltch_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/groups/{org_pac_id}/measures":{"get":{"tags":["Clinicians"],"summary":"Get Group Measures","description":"Get group-level measure detail for an organization","operationId":"get_group_measures_v1_clinicians_groups__org_pac_id__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific quarter (defaults to latest)","title":"Quarter"},"description":"Specific quarter (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/qpp-cohorts/{cohort}":{"get":{"tags":["Clinicians"],"summary":"Get Qpp Cohort","description":"The clinicians of one inferred practice cohort in one performance year.\n\nA cohort is inferred, not stated: CMS's QPP Experience file names no\npractice, but it repeats state, practice size, Medicare patients and\nallowed charges on every Group row of one practice. Treat a small cohort\nas low confidence. Find a cohort from `/clinicians/{npi}/qpp-history`.","operationId":"get_qpp_cohort_v1_clinicians_qpp_cohorts__cohort__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"cohort","in":"path","required":true,"schema":{"type":"string","title":"Cohort"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/{npi}":{"get":{"tags":["Clinicians"],"summary":"Get Clinician","description":"Get a specific clinician by NPI with latest MIPS scores","operationId":"get_clinician_v1_clinicians__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/{npi}/history":{"get":{"tags":["Clinicians"],"summary":"Get Clinician History","description":"MIPS score history for a clinician, one row per CMS release month.\n\n`quarter` is the month CMS published the release, not the MIPS\nperformance year: the 2026-09 release carries PY2024 scores. For scores\nkeyed by performance year, use `/clinicians/{npi}/performance-years`.","operationId":"get_clinician_history_v1_clinicians__npi__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/{npi}/qpp-history":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Qpp History","description":"CMS QPP Experience rows for a clinician, PY2017 onward.\n\nOne row per practice the clinician reported with, per performance year:\nthe participation path, practice size and state, special statuses, final\nand category scores, and the payment adjustment. `medicare_patients`,\n`allowed_charges` and `services` are the practice's totals. Group rows\ncarry an inferred `practice_cohort` and its size.","operationId":"get_clinician_qpp_history_v1_clinicians__npi__qpp_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/{npi}/performance-years":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Performance Years","description":"MIPS scores per performance year, PY2017 onward.\n\nEach entry is one performance year, from the CMS release that states\nthat year. CMS publishes one score per group the clinician reported with,\nplus any individual or APM score, so `scores` lists each with its group\n(`org_pac_id`) and category scores. `highest_final_mips_score` is the\nhighest final score CMS published for the clinician that year, across all\nits scores. CMS applies the payment adjustment per TIN/NPI, using the\nhighest final score for that TIN/NPI, so a clinician who bills under\nseveral groups can have a different adjustment in each. `apm_programs`\nare the programs CMS states for the clinician that year, such as SSP or\nREACH.\nPY2017 names no group.","operationId":"get_clinician_performance_years_v1_clinicians__npi__performance_years_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians/{npi}/measures":{"get":{"tags":["Clinicians"],"summary":"Get Clinician Measures","description":"Get measure-level detail for a clinician","operationId":"get_clinician_measures_v1_clinicians__npi__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific quarter (defaults to latest)","title":"Quarter"},"description":"Specific quarter (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinicians":{"get":{"tags":["Clinicians"],"summary":"Search Clinicians","description":"Search and filter clinicians by name, organization, state, specialty, or MIPS score.\nName, org_pac_id, or specialty is required — unfiltered queries on 1M+ clinicians are too expensive.","operationId":"search_clinicians_v1_clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by clinician name (partial match)","title":"Name"},"description":"Search by clinician name (partial match)"},{"name":"org_pac_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by organization PAC ID","title":"Org Pac Id"},"description":"Filter by organization PAC ID"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., AL, CA, TX)","title":"State"},"description":"Filter by state (e.g., AL, CA, TX)"},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by specialty (partial match, e.g., 'Cardiology', 'Orthopedic')","title":"Specialty"},"description":"Filter by specialty (partial match, e.g., 'Cardiology', 'Orthopedic')"},{"name":"gender","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by gender (M or F)","title":"Gender"},"description":"Filter by gender (M or F)"},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"description":"Minimum final MIPS score","title":"Min Score"},"description":"Minimum final MIPS score"},{"name":"max_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"description":"Maximum final MIPS score","title":"Max Score"},"description":"Maximum final MIPS score"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/asc/{ccn}":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc","description":"Get a specific ASC facility by CCN","operationId":"get_asc_v1_asc__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/asc/{ccn}/history":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc History","description":"Get historical quality data for an ASC facility","operationId":"get_asc_history_v1_asc__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/asc/{ccn}/measures":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc Measures","description":"Get quality measures for an ASC facility","operationId":"get_asc_measures_v1_asc__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/asc/{ccn}/patient-experience":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Get Asc Patient Experience","description":"Get OAS CAHPS patient experience data for an ASC facility","operationId":"get_asc_patient_experience_v1_asc__ccn__patient_experience_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/asc":{"get":{"tags":["Ambulatory Surgical Centers"],"summary":"Search Ascs","description":"Search and filter ASC facilities","operationId":"search_ascs_v1_asc_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by city","title":"City"},"description":"Filter by city"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by county (case-insensitive, partial match)","title":"County"},"description":"Filter by county (case-insensitive, partial match)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by facility name (partial match)","title":"Name"},"description":"Search by facility name (partial match)"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for proximity search","title":"Lat"},"description":"Latitude for proximity search"},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for proximity search","title":"Lng"},"description":"Longitude for proximity search"},{"name":"radius_miles","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":500,"exclusiveMinimum":0},{"type":"null"}],"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"cbsa_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)","title":"Cbsa Code"},"description":"CBSA code for metro/micro area (e.g., 19100 for Dallas)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of results","default":100,"title":"Limit"},"description":"Maximum number of results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of results to skip (for pagination)","default":0,"title":"Offset"},"description":"Number of results to skip (for pagination)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/distressed":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Find Distressed Hospitals","description":"Find hospitals with negative operating margins (financial distress indicators).","operationId":"find_distressed_hospitals_v1_cost_reports_distressed_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":100,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/compare":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Compare Cost Reports Endpoint","description":"Compare cost reports for multiple hospitals side by side.","operationId":"compare_cost_reports_endpoint_v1_cost_reports_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccns","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated CCNs to compare","title":"Ccns"},"description":"Comma-separated CCNs to compare"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}/financial-health":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Financial Health","description":"Financial health analysis: margin trends, YoY changes, distress indicators.","operationId":"get_financial_health_v1_cost_reports__ccn__financial_health_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Report Endpoint","description":"Get the latest hospital cost report by CCN.","operationId":"get_cost_report_endpoint_v1_cost_reports__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}/history":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Report History Endpoint","description":"Get all historical cost reports for a hospital.","operationId":"get_cost_report_history_endpoint_v1_cost_reports__ccn__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}/balance-sheet":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Balance Sheet Endpoint","description":"HCRIS Worksheet G (balance sheet) history for a hospital, with derived liquidity ratios.","operationId":"get_balance_sheet_endpoint_v1_cost_reports__ccn__balance_sheet_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}/charity-care":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Charity Care Endpoint","description":"HCRIS Worksheet S-10 (uncompensated/indigent care) history for a hospital.","operationId":"get_charity_care_endpoint_v1_cost_reports__ccn__charity_care_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports/{ccn}/cost-centers":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Get Cost Centers Endpoint","description":"Cost-center detail (charges, total costs, salary/non-salary split) for a hospital.","operationId":"get_cost_centers_endpoint_v1_cost_reports__ccn__cost_centers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year_end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fiscal year end date (YYYY-MM-DD). Defaults to latest.","title":"Fiscal Year End"},"description":"Fiscal year end date (YYYY-MM-DD). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/cost-reports":{"get":{"tags":["Cost Reports (HCRIS)"],"summary":"Search Cost Reports Endpoint","description":"Search hospital cost reports with filters.","operationId":"search_cost_reports_endpoint_v1_cost_reports_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., AL, TX)","title":"State"},"description":"Filter by state (e.g., AL, TX)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital name (partial match)","title":"Name"},"description":"Hospital name (partial match)"},{"name":"min_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum bed count","title":"Min Beds"},"description":"Minimum bed count"},{"name":"max_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Maximum bed count","title":"Max Beds"},"description":"Maximum bed count"},{"name":"min_revenue","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum total revenue","title":"Min Revenue"},"description":"Minimum total revenue"},{"name":"max_revenue","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Maximum total revenue","title":"Max Revenue"},"description":"Maximum total revenue"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (e.g., 2023)","title":"Year"},"description":"Fiscal year (e.g., 2023)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Max results","default":100,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/check/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Federal exclusion check by NPI","description":"Check whether an NPI is currently on the HHS OIG exclusion list.\n\nFederal law (42 CFR 1001.1901) requires any entity that receives\nfederal healthcare payments to screen its providers against the OIG\nLEIE monthly. This endpoint is the machine-readable path for that\ncompliance requirement.\n\nResponse includes the check timestamp and the source list version so\nyou have an audit trail. For batch screening of many NPIs at once,\nuse `POST /exclusions/batch-screen`.","operationId":"check_exclusion_v1_exclusions_check__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1234567890"}],"responses":{"200":{"description":"Whether the NPI appears on the HHS OIG List of Excluded Individuals/Entities.","content":{"application/json":{"schema":{},"example":{"npi":"1234567890","excluded":false,"checked_against":"OIG_LEIE","as_of":"2026-06-15"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/comprehensive/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Combined federal + state exclusion check by NPI","description":"Check an NPI against the federal OIG LEIE AND every loaded state\nMedicaid exclusion list in one call.\n\nState lists are additive coverage: about 70% of state-excluded NPIs\nnever appear in LEIE, so a federal-only check misses them. The\ntop-level `excluded` flag is true when any list — federal or state —\ncurrently excludes the NPI. See `GET /exclusions/state/coverage` for\nwhich states are loaded and how fresh each list is.","operationId":"comprehensive_check_v1_exclusions_comprehensive__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/state/coverage":{"get":{"tags":["OIG Exclusions"],"summary":"State exclusion list coverage","description":"Which state Medicaid exclusion lists are loaded, with per-state\nrecord counts, NPI coverage, LEIE overlap, and last-load timestamps.\nLists sync monthly from each state's primary public source.","operationId":"state_exclusion_coverage_v1_exclusions_state_coverage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/exclusions/state/search":{"get":{"tags":["OIG Exclusions"],"summary":"Search state exclusion lists","description":"Search the state Medicaid exclusion lists. Most state records\ncarry a name only (no NPI) — name search is the primary path here.","operationId":"search_state_exclusions_v1_exclusions_state_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Program state, e.g. CA","title":"State"},"description":"Program state, e.g. CA"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or business name (partial match)","title":"Name"},"description":"Name or business name (partial match)"},{"name":"entity_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"individual | business | unknown","title":"Entity Type"},"description":"individual | business | unknown"},{"name":"active_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only currently-excluded records","default":false,"title":"Active Only"},"description":"Only currently-excluded records"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/state/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"State exclusion check by NPI","description":"Check an NPI against every loaded state Medicaid exclusion list.\nRecords the state published without an NPI cannot match here — use\n`GET /exclusions/state/search` for name-based screening.","operationId":"check_state_exclusions_v1_exclusions_state__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/search":{"get":{"tags":["OIG Exclusions"],"summary":"Search Exclusions","description":"Search OIG exclusions by state, name, or exclusion type","operationId":"search_exclusions_v1_exclusions_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by name (partial match)","title":"Name"},"description":"Search by name (partial match)"},{"name":"excltype","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by exclusion type code","title":"Excltype"},"description":"Filter by exclusion type code"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/crossref/{npi}":{"get":{"tags":["OIG Exclusions"],"summary":"Cross Reference Npi","description":"Cross-reference an NPI across all datasets: exclusions, utilization, prescribing, clinicians.\nFlags excluded NPIs that still appear in active Medicare data.","operationId":"cross_reference_npi_v1_exclusions_crossref__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exclusions/screen":{"post":{"tags":["OIG Exclusions"],"summary":"Batch Screen","description":"Screen a batch of NPIs against the federal OIG LEIE and every\nloaded state Medicaid exclusion list. Returns hits only — federal\nhits under `excluded`, state-list hits under `state_excluded`.\nMax 500 NPIs per request.","operationId":"batch_screen_v1_exclusions_screen_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","maxItems":500,"title":"Npis","description":"List of NPIs to screen"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/exclusions/recent":{"get":{"tags":["OIG Exclusions"],"summary":"Get Recent Exclusions","description":"Get recently excluded providers within the last N days","operationId":"get_recent_exclusions_v1_exclusions_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"description":"Number of days to look back","default":30,"title":"Days"},"description":"Number of days to look back"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ma-plans/search":{"get":{"tags":["MA Plans"],"summary":"Search Plans","description":"Search Medicare Advantage and Part D plans","operationId":"search_plans_v1_ma_plans_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by contract state","title":"State"},"description":"Filter by contract state"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by organization name (partial match)","title":"Name"},"description":"Search by organization name (partial match)"},{"name":"org_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by organization type (e.g., 'Local CCP', 'PDP')","title":"Org Type"},"description":"Filter by organization type (e.g., 'Local CCP', 'PDP')"},{"name":"parent","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by parent organization (partial match)","title":"Parent"},"description":"Search by parent organization (partial match)"},{"name":"min_stars","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":5,"minimum":1},{"type":"null"}],"description":"Minimum overall star rating","title":"Min Stars"},"description":"Minimum overall star rating"},{"name":"max_stars","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":5,"minimum":1},{"type":"null"}],"description":"Maximum overall star rating","title":"Max Stars"},"description":"Maximum overall star rating"},{"name":"bonus_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only return plans qualifying for QBP (4+ stars)","default":false,"title":"Bonus Only"},"description":"Only return plans qualifying for QBP (4+ stars)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ma-plans/compare":{"get":{"tags":["MA Plans"],"summary":"Compare Plans","description":"Compare multiple MA plans side by side","operationId":"compare_plans_v1_ma_plans_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contracts","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated contract IDs (e.g., H0028,H1036)","title":"Contracts"},"description":"Comma-separated contract IDs (e.g., H0028,H1036)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ma-plans/{contract_id}":{"get":{"tags":["MA Plans"],"summary":"Get Plan","description":"Get a specific MA plan by contract ID (e.g., H0028)","operationId":"get_plan_v1_ma_plans__contract_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ma-plans/{contract_id}/history":{"get":{"tags":["MA Plans"],"summary":"Get Plan History","description":"Get historical star ratings for an MA plan","operationId":"get_plan_history_v1_ma_plans__contract_id__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/open-payments/by-physician/{npi}":{"get":{"tags":["Open Payments"],"summary":"Open Payments By Physician","description":"Get all Open Payments records for a physician by NPI.","operationId":"open_payments_by_physician_v1_open_payments_by_physician__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year (e.g., 2023)","title":"Year"},"description":"Filter by year (e.g., 2023)"},{"name":"payment_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: general, research, or ownership","title":"Payment Type"},"description":"Filter: general, research, or ownership"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/open-payments/by-physician/{npi}/summary":{"get":{"tags":["Open Payments"],"summary":"Open Payments Physician Summary","description":"Get aggregated payment summary for a physician — totals, top companies, yearly breakdown.","operationId":"open_payments_physician_summary_v1_open_payments_by_physician__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/open-payments/by-company":{"get":{"tags":["Open Payments"],"summary":"Open Payments By Company","description":"Get payments made by a specific pharmaceutical/device company.","operationId":"open_payments_by_company_v1_open_payments_by_company_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"company","in":"query","required":true,"schema":{"type":"string","description":"Company name (partial match)","title":"Company"},"description":"Company name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/open-payments/search":{"get":{"tags":["Open Payments"],"summary":"Open Payments Search","description":"Search Open Payments with multiple filters. At least one filter is required.","operationId":"open_payments_search_v1_open_payments_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"physician_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Physician name (partial match)","title":"Physician Name"},"description":"Physician name (partial match)"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company name (partial match)","title":"Company"},"description":"Company name (partial match)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by NPI","title":"Npi"},"description":"Filter by NPI"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., CA, TX)","title":"State"},"description":"Filter by state (e.g., CA, TX)"},{"name":"nature_of_payment","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Payment nature (e.g., Food and Beverage)","title":"Nature Of Payment"},"description":"Payment nature (e.g., Food and Beverage)"},{"name":"min_amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Minimum payment amount","title":"Min Amount"},"description":"Minimum payment amount"},{"name":"max_amount","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Maximum payment amount","title":"Max Amount"},"description":"Maximum payment amount"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"payment_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: general, research, or ownership","title":"Payment Type"},"description":"Filter: general, research, or ownership"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/physician-utilization/search":{"get":{"tags":["Physician Utilization"],"summary":"Search Utilization","description":"Search physician utilization records by specialty, state, procedure, or name.\nAt least one filter is required.","operationId":"search_utilization_v1_physician_utilization_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by provider specialty (partial match)","title":"Specialty"},"description":"Filter by provider specialty (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TX, CA)","title":"State"},"description":"Filter by state (e.g., TX, CA)"},{"name":"hcpcs_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by HCPCS procedure code","title":"Hcpcs Code"},"description":"Filter by HCPCS procedure code"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name (partial match)","title":"Name"},"description":"Search by provider name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year (e.g., 2022)","title":"Year"},"description":"Filter by year (e.g., 2022)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/physician-utilization/by-procedure/{hcpcs_code}":{"get":{"tags":["Physician Utilization"],"summary":"Get By Procedure","description":"Find top physicians performing a specific HCPCS procedure code.","operationId":"get_by_procedure_v1_physician_utilization_by_procedure__hcpcs_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs_code","in":"path","required":true,"schema":{"type":"string","title":"Hcpcs Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/physician-utilization/{npi}/benchmarks":{"get":{"tags":["Physician Utilization"],"summary":"Get Benchmarks","description":"Compare a physician's utilization against specialty/state peers with percentile ranks.","operationId":"get_benchmarks_v1_physician_utilization__npi__benchmarks_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year for benchmarks (defaults to latest)","title":"Year"},"description":"Year for benchmarks (defaults to latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/physician-utilization/{npi}/summary":{"get":{"tags":["Physician Utilization"],"summary":"Get Utilization Summary","description":"Get utilization summary for a physician: top procedures, total volumes, payments.","operationId":"get_utilization_summary_v1_physician_utilization__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/physician-utilization/{npi}":{"get":{"tags":["Physician Utilization"],"summary":"Get Utilization","description":"Get all procedures for a physician by NPI (paginated).","operationId":"get_utilization_v1_physician_utilization__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prescriber/search":{"get":{"tags":["Part D Prescriber"],"summary":"Search Prescriber","description":"Search prescriber records by drug, state, or NPI.\nAt least one filter is required.","operationId":"search_prescriber_v1_prescriber_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by drug brand name (partial match)","title":"Drug"},"description":"Search by drug brand name (partial match)"},{"name":"generic","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by generic drug name (partial match)","title":"Generic"},"description":"Search by generic drug name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., CA)","title":"State"},"description":"Filter by state (e.g., CA)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by NPI","title":"Npi"},"description":"Filter by NPI"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year (e.g., 2022)","title":"Year"},"description":"Filter by year (e.g., 2022)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prescriber/by-drug/{drug_name}":{"get":{"tags":["Part D Prescriber"],"summary":"Get By Drug","description":"Find top prescribers of a specific drug (brand name, partial match).","operationId":"get_by_drug_v1_prescriber_by_drug__drug_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"drug_name","in":"path","required":true,"schema":{"type":"string","title":"Drug Name"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prescriber/{npi}/analytics":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber Analytics","description":"Prescriber analytics: generic vs brand prescribing rate and opioid profile.","operationId":"get_prescriber_analytics_v1_prescriber__npi__analytics_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prescriber/{npi}/summary":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber Summary","description":"Get prescriber summary: top drugs, total cost, total claims.","operationId":"get_prescriber_summary_v1_prescriber__npi__summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prescriber/{npi}":{"get":{"tags":["Part D Prescriber"],"summary":"Get Prescriber","description":"Get all drugs prescribed by a physician (paginated).","operationId":"get_prescriber_v1_prescriber__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by year","title":"Year"},"description":"Filter by year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/shortage-areas":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Search Shortage Areas","description":"Search HPSA shortage areas with filters","operationId":"search_shortage_areas_v1_shortage_areas_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"discipline","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by discipline (Primary Care, Dental Health, Mental Health)","title":"Discipline"},"description":"Filter by discipline (Primary Care, Dental Health, Mental Health)"},{"name":"hpsa_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by HPSA type (Geographic, Population, Facility)","title":"Hpsa Type"},"description":"Filter by HPSA type (Geographic, Population, Facility)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by designation status (Designated, Withdrawn)","title":"Status"},"description":"Filter by designation status (Designated, Withdrawn)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/shortage-areas/summary":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Get Shortage Area Summary","description":"Get summary of HPSA shortage areas by state and discipline","operationId":"get_shortage_area_summary_v1_shortage_areas_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/shortage-areas/by-county/{fips_code}":{"get":{"tags":["HPSA Shortage Areas"],"summary":"Get Shortage Areas By County","description":"Get all shortage area designations for a county by FIPS code","operationId":"get_shortage_areas_by_county_v1_shortage_areas_by_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/enrollments/by-ccn/{ccn}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get Enrollment By Ccn","description":"Get enrollment records for a hospital by CCN","operationId":"get_enrollment_by_ccn_v1_enrollments_by_ccn__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/enrollments/by-npi/{npi}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get Enrollment By Npi","description":"Get enrollment records for a hospital by NPI","operationId":"get_enrollment_by_npi_v1_enrollments_by_npi__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/enrollments/search":{"get":{"tags":["Hospital Enrollments"],"summary":"Search Enrollments","description":"Search hospital enrollment records","operationId":"search_enrollments_v1_enrollments_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TN, FL)","title":"State"},"description":"Filter by state (e.g., TN, FL)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by hospital or organization name","title":"Name"},"description":"Search by hospital or organization name"},{"name":"organization","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by organization name only","title":"Organization"},"description":"Search by organization name only"},{"name":"ownership","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"P=Proprietary, N=Non-profit","title":"Ownership"},"description":"P=Proprietary, N=Non-profit"},{"name":"subgroup","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by subgroup: acute_care, childrens, psychiatric, rehabilitation, long_term, swing_bed","title":"Subgroup"},"description":"Filter by subgroup: acute_care, childrens, psychiatric, rehabilitation, long_term, swing_bed"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/enrollments/systems":{"get":{"tags":["Hospital Enrollments"],"summary":"List Systems","description":"List all known health systems with hospital counts","operationId":"list_systems_v1_enrollments_systems_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/enrollments/systems/{system_name}":{"get":{"tags":["Hospital Enrollments"],"summary":"Get System Hospitals","description":"Get all hospitals in a health system by system name","operationId":"get_system_hospitals_v1_enrollments_systems__system_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_name","in":"path","required":true,"schema":{"type":"string","title":"System Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":500,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dac/search":{"get":{"tags":["DAC Provider Directory"],"summary":"Search Providers","description":"Search the DAC provider directory with filters.","operationId":"search_providers_v1_dac_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (e.g., TX, CA)","title":"State"},"description":"Filter by state (e.g., TX, CA)"},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by primary specialty","title":"Specialty"},"description":"Search by primary specialty"},{"name":"org_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by group practice name","title":"Org Name"},"description":"Search by group practice name"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by provider name","title":"Name"},"description":"Search by provider name"},{"name":"telehealth","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter telehealth providers only","title":"Telehealth"},"description":"Filter telehealth providers only"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dac/group/{org_pac_id}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Group Members","description":"Get all providers in a group practice by organization PAC ID.","operationId":"get_group_members_v1_dac_group__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dac/hospital/{ccn}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Hospital Affiliates","description":"Get providers affiliated with a hospital by CCN.","operationId":"get_hospital_affiliates_v1_dac_hospital__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dac/{npi}":{"get":{"tags":["DAC Provider Directory"],"summary":"Get Provider","description":"Get DAC record for a single NPI with group and hospital affiliations.","operationId":"get_provider_v1_dac__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pecos/enrollment/org/{org_name}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Org Enrollees","description":"Get providers enrolled under an organization.","operationId":"get_org_enrollees_v1_pecos_enrollment_org__org_name__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_name","in":"path","required":true,"schema":{"type":"string","title":"Org Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pecos/enrollment/{npi}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Enrollment","description":"Get PECOS enrollment records for an individual NPI.","operationId":"get_enrollment_v1_pecos_enrollment__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pecos/reassignment/org/{org_pac_id}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Org Reassignees","description":"Get individuals who bill through an organization (by org PAC ID).","operationId":"get_org_reassignees_v1_pecos_reassignment_org__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset for pagination","default":0,"title":"Offset"},"description":"Offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pecos/reassignment/{npi}":{"get":{"tags":["PECOS Enrollment"],"summary":"Get Reassignments","description":"Get organizations this provider bills through (reassignment/855R).","operationId":"get_reassignments_v1_pecos_reassignment__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}":{"get":{"tags":["Providers — Profile"],"summary":"Full provider dossier by NPI","description":"Unified provider dossier — the marquee cross-source lookup.\n\nJoins these datasets on the NPI, on one database connection:\n- **NPPES**: provider identity, specialty, address\n- **Open Payments**: industry payments, totals and one row per program year (`open_payments.by_year`)\n- **Physician Utilization**: Medicare billing patterns, totals and by year; `cms_summary` carries\n  CMS's by-provider totals, which include the services CMS suppresses from the per-service rows\n- **Part D Prescriber**: drug prescribing profile, totals and by year; `cms_summary` carries\n  CMS's by-provider totals, which include the drugs CMS suppresses from the per-drug rows\n- In both blocks, `years_covered` gives the years of the detail rows. When CMS suppressed every\n  detail row, it gives the years of `cms_summary`, and the other detail fields are null.\n- **OIG Exclusions**: federal exclusion status\n- **DAC and PECOS**: group practice, facility affiliations, billing organizations\n- **License, quality, financial and clinical-trial** summary cards with deep links\n\nUse this for due diligence, compliance screening, or building\nprovider-comparison tools. For domain-specific detail, see the\nsub-resources: `/provider/{npi}/quality`, `/provider/{npi}/licenses`,\n`/provider/{npi}/employment`, `/provider/{npi}/financial-affiliation`.","operationId":"get_provider_profile_v1_provider__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1245319599"}],"responses":{"200":{"description":"Cross-source dossier for the provider. Includes NPPES identity, Open Payments, Physician Utilization, Part D Prescriber, OIG exclusion status, and attribution signals.","content":{"application/json":{"schema":{},"example":{"npi":"1245319599","entity_type":"individual","identity":{"name":"JANE DOE","credential":"M.D.","specialty":"Internal Medicine Physician","taxonomy_code":"207R00000X","deactivated":false},"location":{"city":"SALT LAKE CITY","state":"UT","zip_code":"841320000"},"quality":{"data_period":"2026-09","final_mips_score":82.9},"prescribing":{"unique_drugs":16,"total_claims":504,"total_drug_cost":49545.98,"years_covered":"2020-2024","opioid_claim_rate_pct":0.0,"high_opioid_prescriber":false,"by_year":[{"year":2024,"unique_drugs":14,"total_claims":387,"total_drug_cost":41460.24}],"cms_summary":{"source":"CMS Medicare Part D Prescribers - by Provider","note":"CMS's own per-prescriber totals. They include the drugs CMS suppresses from the per-drug rows (fewer than 11 claims), so they can be higher than the per-drug figures in this block.","by_year":[{"year":2024,"total_claims":488,"total_drug_cost":70415.29,"total_beneficiaries":118}]}},"utilization":{"unique_procedures":17,"total_services":985.0,"total_beneficiaries":841,"total_medicare_payments":81689.21,"years_covered":"2020-2024","by_year":[{"year":2024,"unique_procedures":17,"total_services":773.0,"total_beneficiaries":649,"total_medicare_payments":52524.51}],"cms_summary":{"source":"CMS Medicare Physician & Other Practitioners - by Provider","note":"CMS's own per-provider totals. They include the services CMS suppresses from the per-service rows (fewer than 11 beneficiaries), so they can be higher than the per-service figures in this block.","by_year":[{"year":2024,"total_services":901.0,"total_beneficiaries":447,"total_medicare_payments":70587.8}]}},"open_payments":{"data_available":true,"record_count":36,"payment_count":36,"total_amount":9373.5,"ownership_interest_value":0.0,"manufacturer_count":6,"years_covered":"2025-2025","by_payment_type":{"general":{"record_count":30,"payment_count":30,"total_amount":9000.0},"research":{"record_count":6,"payment_count":6,"total_amount":373.5}},"by_year":[{"program_year":2025,"record_count":36,"payment_count":36,"total_amount":9373.5,"ownership_interest_value":0.0,"manufacturer_count":6,"by_payment_type":{"general":{"record_count":30,"payment_count":30,"total_amount":9000.0},"research":{"record_count":6,"payment_count":6,"total_amount":373.5}}}],"deep_link":"/open-payments/by-physician/1245319599/summary"},"compliance":{"oig_excluded":false,"exclusion_count":0,"exclusion_history":[]},"data_available":{"nppes":true,"mips_quality":true,"partd_prescribing":true,"physician_utilization":true,"open_payments":true,"oig_exclusions":false,"dac_directory":true,"pecos_reassignment":true,"clinical_trials":false},"risk_flags":[]}}}},"404":{"description":"No provider found for that NPI."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/quality":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Quality","description":"MIPS score history + ACO/affiliation context for a provider.\n\nReturns the 20 most-recent quarters of CMS MIPS scoring (quality / cost /\nIA / PI subscores plus final score), plus this NPI's clinicians-affiliation\n(org_pac_id, facility, system attribution from v2 crosswalk including EIN\nwhere org_eins has it).\n\nLives under /provider/{npi}/quality (canonical NPI dossier sub-resource).\nFor specialty leaderboards and system-level MIPS rollups, see /mips/*.","operationId":"get_provider_quality_v1_provider__npi__quality_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/licenses":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Licenses","description":"All state-issued licenses for a provider + disciplinary action summary.\n\nLives under /provider/{npi}/licenses (canonical NPI dossier sub-resource).\nFor state-level overviews and cross-state alert feeds, see /licenses/*.","operationId":"get_provider_licenses_v1_provider__npi__licenses_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/licenses/disciplinary":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Disciplinary","description":"Full disciplinary action history for a provider across all loaded states.","operationId":"get_provider_disciplinary_v1_provider__npi__licenses_disciplinary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/financial-affiliation":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Financial Affiliation","description":"Links a physician's PECOS billing employer to its financial profile.\n\nSurfaces the employer's EIN + system_id + most-recent revenue +\nworkforce headcount, plus any exec-comp match when the physician is\nthemselves a top-compensated executive (rare but happens for academic\nmedical center deans, hospital CEOs who are MDs, etc.).","operationId":"get_provider_financial_affiliation_v1_provider__npi__financial_affiliation_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/clinical-trials":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Clinical Trials","description":"Clinical trials where this provider is listed as an investigator (ClinicalTrials.gov).","operationId":"get_provider_clinical_trials_v1_provider__npi__clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/employment":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Employment","description":"Resolve all current billing-org employers for an NPI, with parent-system attribution.\n\nSource: PECOS Medicare billing reassignment (NPI -> org PAC ID) joined to\nNPPES, DAC, hospital_enrollments, the physician_employer_systems\ncrosswalk, and the employer_facts aggregate. Each employer entry includes\nconfidence + attribution method, employer_type (hospital_system /\npe_platform / payer_vertical / staffing / academic_faculty / safety_net /\ngovernment / physician_partnership / independent_group), solo-PC flag,\nand pre-aggregated scale (distinct NPIs, primary state, specialty mix).\n\nThe summary block tells callers how concentrated the panel is and which\nemployer-type buckets the physician sits in — the consolidation-trend\nquestion is \"is this MD employed by a PE platform or a payer?\" not \"who's\ntheir hospital.\"","operationId":"get_provider_employment_v1_provider__npi__employment_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208). Excludes PAs, APRNs, nurses, dentists, optometrists, podiatrists.","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208). Excludes PAs, APRNs, nurses, dentists, optometrists, podiatrists."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/employment/history":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Employment History","description":"Temporal employment history for an NPI from pecos_reassignment_history snapshots.\n\nEach snapshot is a point-in-time capture taken when the PECOS loader runs\n(currently monthly). History entries bracket employment windows with\neffective_from / effective_to. The `data_quality.is_meaningful` flag\nindicates whether the history table has accumulated enough snapshots to\nshow change — meaningful from the second snapshot onward.\n\nUse this for: tracking when a physician changed employers, supporting\n\"who left System X in the past 6 months\" queries, and feeding\nconsolidation-trend analysis. Per-event date granularity is bounded by\nsnapshot cadence — we know an employer relationship existed at snapshot\nT, not the exact day it started.","operationId":"get_provider_employment_history_v1_provider__npi__employment_history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/employment/primary":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Primary Employer","description":"Best-guess primary employer for an NPI.\n\nSelects the single most-likely current employer from the physician's PECOS\nreassignments using a deterministic ranking: (1) sole employer; (2) DAC\npractice-location corroboration; (3) state match against NPPES; (4) largest\nby distinct-NPI count; (5) alphabetical tiebreaker. The response includes\n`ranking_signals[]` with the methods that fired and their confidence, plus\nannual Medicare allowed-amount totals for the NPI as context.\n\nNote on claims attribution: Medicare claims data is keyed to the rendering\nNPI, not the billing org. We do NOT compute \"% of claims at this employer\"\nbecause that data doesn't exist publicly. Use the signal trail to judge\nwhether the primary-employer pick is reliable for your use case.","operationId":"get_provider_primary_employer_v1_provider__npi__employment_primary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/acos":{"get":{"tags":["Providers — Profile"],"summary":"Get Provider Acos","description":"ACO membership links for an NPI, each with its match method and confidence.\n\nCMS publishes MSSP participants and ACO REACH providers by legal business\nname only. This resource serves the NPI-keyed links Verzi derives, and says\nfor every row how it was made:\n\n- `cms_qpp_participation` (confidence `high`, or `stated_unresolved`): CMS's\n  QPP participation status names the APM entity for the NPI; the entity\n  name is resolved to an ACO ID by name.\n- `organization_name_match` (`medium`): the NPI's PECOS billing organization\n  carries the same legal business name as an MSSP participant.\n- `individual_name_match` (`low`): an ACO REACH participant name equal to the\n  NPI's NPPES name and unique nationally.\n\nA name match is never presented as exact. Treat `medium` and `low` rows as\nleads to verify. `deep_link` opens the ACO's own resource.","operationId":"get_provider_acos_v1_provider__npi__acos_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier.","example":"1245319599"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/employers":{"get":{"tags":["Physician Employment Intelligence"],"summary":"By Specialty","description":"Groups ranked by how many members have the given primary specialties.\n\nAnswers \"every anesthesia group in the US and how many anesthesiologists\nand CRNAs each one has\". Counts come from the CMS Doctors and Clinicians\nfile (one row per clinician per group, so a clinician in two groups\ncounts in both). Parent system and employer_type come from the curated\ncrosswalk; a null employer_type means we hold no label, not that the\ngroup is independent.","operationId":"by_specialty_v1_employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"DAC primary specialty, exact CMS wording, case-insensitive. Repeat for more than one. At most 10. Example: specialty=ANESTHESIOLOGY&specialty=CERTIFIED REGISTERED NURSE ANESTHETIST (CRNA).","title":"Specialty"},"description":"DAC primary specialty, exact CMS wording, case-insensitive. Repeat for more than one. At most 10. Example: specialty=ANESTHESIOLOGY&specialty=CERTIFIED REGISTERED NURSE ANESTHETIST (CRNA)."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Count only members in this state.","title":"State"},"description":"Count only members in this state."},{"name":"min_providers","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Leave out groups with fewer matching members.","default":1,"title":"Min Providers"},"description":"Leave out groups with fewer matching members."},{"name":"employer_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["hospital_system","academic_faculty","pe_platform","payer_vertical","physician_partnership","staffing","safety_net","government","independent_group"],"type":"string"},{"type":"null"}],"description":"Only groups with this curated employer type.","title":"Employer Type"},"description":"Only groups with this curated employer type."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/employers/search":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Search","description":"Autocomplete by employer name.\n\nSearches DAC's org_name (GIN trigram index) then joins to employer_facts so\nevery match includes scale (distinct NPIs), geography (primary state), and\nparent-system attribution when available. Use for typeahead UI or to\nresolve a free-text employer to a stable org_pac_id.","operationId":"search_v1_employers_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"description":"Substring of org name (case-insensitive).","title":"Q"},"description":"Substring of org name (case-insensitive)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/employers/{org_pac_id}":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Detail","description":"Employer detail: scale, parent system, geography, specialty mix, hospital affiliations.\n\nBacked by employer_facts MV + physician_employer_systems crosswalk +\non-demand DAC aggregation for the specialty / state breakdowns. Returns\n404 if the org_pac_id has no PECOS reassignments (i.e., no NPIs bill\nunder it).","operationId":"detail_v1_employers__org_pac_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/employers/{org_pac_id}/physicians":{"get":{"tags":["Physician Employment Intelligence"],"summary":"Physicians","description":"Paginated list of physicians currently billing under this employer's PAC ID.\n\nResolves NPIs from PECOS reassignment, enriches with DAC specialty/state\nand NPPES identity, and applies optional filters. The total_count reflects\nthe full filtered set; use limit/offset to page.","operationId":"physicians_v1_employers__org_pac_id__physicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"org_pac_id","in":"path","required":true,"schema":{"type":"string","title":"Org Pac Id"}},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring match on DAC pri_spec (case-insensitive).","title":"Specialty"},"description":"Substring match on DAC pri_spec (case-insensitive)."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state filter.","title":"State"},"description":"2-letter state filter."},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208).","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC taxonomy 207/208)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Detail","description":"System rollup: scale, state mix, specialty mix, top captive employers, hospital CCN count.\n\nA system is identified by the same system_id used in hospital_systems where\none exists (Kaiser, Northwell, Mayo, etc.) and by synthetic IDs for\nnon-hospital systems (USAP, OPTUM, ENVISION, etc.). Returns 404 if no\ncaptive employer is mapped to the system_id.","operationId":"detail_v1_systems__system_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/divisions":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Divisions","description":"Child systems under a parent system.\n\nFor hierarchical for-profits (Tenet → USPI + regional divisions) and nonprofit parents\nwith related operating subsidiaries (Sutter Health → PAMF/EBMF/SMG/...),\nthis returns the direct children with per-child scale aggregates.\nReturns 404 if the system_id has no children in system_hierarchy.\n\nThe parent rollup at /systems/{system_id} aggregates automatically\nacross all transitive descendants — use this endpoint to enumerate\nthem explicitly.","operationId":"divisions_v1_systems__system_id__divisions_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/employers":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Employers","description":"All captive billing PAC IDs (medical groups) under a system.\n\nReturns the dimension-table list of every classified employer with its\nemployer_type, attribution method, and scale. Use this to enumerate the\ncaptive medical groups that bill under a single parent system.","operationId":"employers_v1_systems__system_id__employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/physicians":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"Physicians","description":"Reverse lookup: every physician employed by any captive group of this system.\n\nFilterable by specialty/state/role. Pagination via limit + offset. The\nbilling_org_pac_id and billing_org_name on each row indicate which\ncaptive group within the system actually employs the physician.","operationId":"physicians_v1_systems__system_id__physicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"specialty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring match on DAC pri_spec.","title":"Specialty"},"description":"Substring match on DAC pri_spec."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state filter.","title":"State"},"description":"2-letter state filter."},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"const":"physician","type":"string"},{"type":"null"}],"description":"Filter to MD/DO physicians only (NUCC 207/208).","title":"Role"},"description":"Filter to MD/DO physicians only (NUCC 207/208)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/hcahps":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Hcahps","description":"HCAHPS patient experience rollup for all hospitals in a health system.\n\nAccepts a canonical system_id (preferred) or a system_name (case-insensitive)\nfor backward compatibility with legacy callers. Returns per-facility\nHCAHPS detail (overall star rating, beds, survey volume, state + national\npercentiles) plus system-level rollups.\n\nFor the clinician-level MIPS rollup of the same system, see\nGET /mips/systems/{system_id}.","operationId":"system_hcahps_v1_systems__system_id__hcahps_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Filter to a 2-letter state code.","title":"State"},"description":"Filter to a 2-letter state code."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/financials":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials","description":"Multi-source financial filings for all EINs in a system.\n\nRolls up across system_hierarchy descendants. Returns IRS 990 + DOL 5500\n+ SEC 10-K rows side by side per fiscal year so customers can see the\ncross-source picture. Each row cites its filing source URL.","operationId":"system_financials_v1_systems__system_id__financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/financials/executives":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials Executives","description":"Top compensated executives across all EINs in a system.\n\nSourced from IRS Form 990 Schedule J (nonprofit) + SEC 10-K named\nexecutive officers (public companies). Includes matched_npi where the\nexecutive has been linked to an NPI via fuzzy name+state matching.","operationId":"system_financials_executives_v1_systems__system_id__financials_executives_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/systems/{system_id}/financials/workforce":{"get":{"tags":["Systems — Physician Employment + Facility Analytics"],"summary":"System Financials Workforce","description":"DOL Form 5500 W-2 active-participant counts for all EINs in a system.\n\nEach EIN typically has multiple plans (welfare, retirement, etc.); the\nheadline_active_participants_latest is the MAX across plans for the most\nrecent year — usually the welfare/health plan, the cleanest \"total W-2\nemployees\" anchor available in public data.","operationId":"system_financials_workforce_v1_systems__system_id__financials_workforce_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","title":"System Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sources":{"get":{"tags":["Data Transparency"],"summary":"List All","description":"Public catalog of every external dataset we ingest.\n\nEach entry includes the source's license, update cadence, our accuracy\nclassification, and last-loaded state. Use this to validate the\nprovenance of any claim in our API — every employment attribution traces\nback to one or more registered sources via /provider/{npi}/employment's\nattribution_signals[] array.\n\nContent-negotiated: browsers get a styled HTML catalog, API clients get\nJSON. Force a format with ?format=json or ?format=html. Unauthenticated\nby design (it's a transparency feature).","operationId":"list_all_v1_sources_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/sources/{source_id}":{"get":{"tags":["Data Transparency"],"summary":"Detail","description":"Detail for a single registered source. Content-negotiated.","operationId":"detail_v1_sources__source_id__get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/sources/{source_id}/history":{"get":{"tags":["Data Transparency"],"summary":"History","description":"Recent load sessions for a single source — auditable refresh history.\n\nEvery loader run (pipeline or manual) is recorded: when it started,\nhow long it took, whether it succeeded, how many rows it loaded, and\non failure the error message. This is the trust-by-transparency layer\nunderneath /sources — customers can audit not just *what* we serve\nbut *how often we refresh* and *whether our last refresh worked*.\n\nContent-negotiated: browsers get a timeline page, API clients get\nJSON. Unauthenticated by design.","operationId":"history_v1_sources__source_id__history_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Maximum sessions to return (default 20, max 200)","default":20,"title":"Limit"},"description":"Maximum sessions to return (default 20, max 200)"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/sources":{"get":{"tags":["Source Archive"],"summary":"Archived sources with their receipt levels, last fetch, last change, and file counts","description":"Every public source the archive holds. `receipts` says which claims\nthe source can back (R0 provider standing, R1 fee-schedule cell, R2\nNCCI/MUE edit, R3 LCD/Article clause). `last_change_at` is the last run\nthat stored at least one new file.","operationId":"archive_sources_v1_archive_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/v1/archive/runs":{"get":{"tags":["Source Archive"],"summary":"Archive run ledger","description":"One row per run: candidates discovered, files new and unchanged,\nbytes stored, and the status (ok, no_change, partial, failed). `notes`\nlists files stored without a version and containers that could not be\nopened. Zero candidates after a good run is a failed run: the page moved.","operationId":"archive_runs_v1_archive_runs_get","parameters":[{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one source","title":"Source Id"},"description":"Limit to one source"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/changes":{"get":{"tags":["Source Archive"],"summary":"New document versions observed in the last N days (the updates feed)","description":"The change feed behind updates.verzi.health. One row per new version\nthe archive observed: the document title, the publisher version, the\neffective window, when we observed it, the sha256 of the stored bytes,\nand `affected_codes` (the HCPCS codes the coverage layer maps to the\ndocument; empty when no mapping exists). Nobody writes these entries;\nthe pipeline observes them. `truncated` is true when the window holds\nmore rows than `limit`. Every row carries `news` and `newly_archived`.\nA revision note that quotes licensed code text, or comes from a document\nthat does, is null, with `revision_note_withheld` set to `licensed_text`.\nPublic, no key.","operationId":"archive_changes_v1_archive_changes_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":30,"title":"Days"}},{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one source","title":"Source Id"},"description":"Limit to one source"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"origin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(live|historical)$"},{"type":"null"}],"description":"live = versions a scheduled run observed; historical = versions pulled from the past (backfill or Wayback copies). Omit for both.","title":"Origin"},"description":"live = versions a scheduled run observed; historical = versions pulled from the past (backfill or Wayback copies). Omit for both."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(claim_policy|fee_schedule|code_set|regulatory|other)$"},{"type":"null"}],"description":"One source category (the feed's chips), filtered before the row cap.","title":"Category"},"description":"One source category (the feed's chips), filtered before the row cap."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(news|newly_archived)$"},{"type":"null"}],"description":"news = a live version of a document already held that is newer than every version held before it (publisher order: effective date, then version number, then observed), or a first capture whose effective date is in the window or later; newly_archived = every other live capture (first captures, older versions filled in later). Omit for both. Filtered before the cap.","title":"Kind"},"description":"news = a live version of a document already held that is newer than every version held before it (publisher order: effective date, then version number, then observed), or a first capture whose effective date is in the window or later; newly_archived = every other live capture (first captures, older versions filled in later). Omit for both. Filtered before the cap."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/upcoming":{"get":{"tags":["Source Archive"],"summary":"Future-effective document versions, soonest first (the upcoming-changes calendar)","description":"Versions whose publisher effective date is in the future: new fee\nschedule quarters, dated LCD revisions, transmittal batches. Soonest\nfirst, grouped client-side by effective date. The publisher's dates\nonly; a version with no stated effective date never appears here.\nEach row carries `affected_codes`: the codes a coverage mapping links to\nthe document, and for a version of the Required Face-to-Face Encounter\nand Written Order Prior to Delivery List, the codes that version names.\n`kind` is `document_version`, or `code_list_phase` for a future phase\nthat the Required Prior Authorization List in force today prints for\nsome codes: one row per printed phase date and scope\n(`phase_date_text`, `phase_scope_text`, verbatim), with the codes that\nphase covers and the list's own version and file.\nHorizon: only effective dates up to 2 years after today (US Eastern)\nare listed, and `horizon_through` names the last date listed. A\npublisher's text can state a typo year (CMS R499PI states 2104). That\nversion and its as-of answer stay as stated; the calendar does not\nlist it.\nPublic, no key. The page: updates.verzi.health/calendar.","operationId":"archive_upcoming_v1_archive_upcoming_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/docs/{doc_id}/versions":{"get":{"tags":["Source Archive"],"summary":"Every version of a document with its publisher and observed windows","description":"Versions in window order. `observed_to` and `superseded_by` are\nderived, never written into a row. `observed_to` is set only for undated\nlive versions (the next live capture's observed_from) and is null for\ndated versions and for wayback and backfill copies.\n`origin` says how the file reached the archive: live (a scheduled run),\nbackfill (a manual historical pull), wayback (a Wayback Machine copy).","operationId":"doc_versions_v1_archive_docs__doc_id__versions_get","parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED","title":"Doc Id"},"description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/docs/{doc_id}/as-of":{"get":{"tags":["Source Archive"],"summary":"The version of a document in force on a date","description":"Which version was in force on the date, and which rule decided it.\n`publisher_effective`: the publisher's stated window, both ends\ninclusive. `observed`: when the archive first saw the version and its\nsuccessor, half-open, live rows only. This rule applies only to versions\nwith no publisher start date. A dated version is never in force outside\nits stated window. `none`: no version qualifies, and `reason` says why\n(before_first_stated_start, after_last_stated_end,\ngap_between_stated_windows, not_observed_on_date, no_versions, or\nonly_defective_versions: every held version is excluded, either its\nfile is recorded as cut short or the version itself as defective).\n`effective_from_source` says where the start date came from. For a\nmanual chapter it is `transmittal_effective` (the Effective date of the\ntransmittal the revision names) or `transmittal` (its Implementation\ndate, kept when the Effective date is missing, ambiguous or more than\n365 days before the transmittal's issue date). `transmittal_issue_date`\nis set when the Effective date used precedes the issue date.\nFor a manual chapter the highest Rev in force answers (a lower Rev is\ncapped once a higher Rev has started). `inverted_window` is set when a\nlower Rev of the chapter starts AFTER the date of service: it names the\nanswering Rev and each such lower Rev with its transmittal's issue,\neffective and implementation dates and the transmittal's own wording\n(`effective_text`, `implementation_text`, quoted from the parsed\ntransmittal); its `note` is a Verzi label, not CMS text. Null otherwise.\nIncludes the file's sha256 and, with a key, a one-hour link to the\noriginal bytes. Bytes that any source under CPT-licensed terms holds\nget no link (`url_withheld` says why), and so do the bytes of a document\nthat quotes licensed code text CMS cites. Never guesses.","operationId":"doc_as_of_v1_archive_docs__doc_id__as_of_get","security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED","title":"Doc Id"},"description":"Document id, e.g. dmepos_fs:2025Q1, ncci_mue:dme-supplier:2024Q2, leie:UPDATED"},{"name":"date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Date of service, YYYY-MM-DD","title":"Date"},"description":"Date of service, YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/archive/docs/{doc_id}/section":{"get":{"tags":["Source Archive"],"summary":"One section of a manual chapter on a date, from the chapter or the transmittal that changed it","description":"The section's own words on the date, verbatim, never a paraphrase. `status`: `served`\n(with `text`, and a `citation` to the stored file and the character span: a held chapter\nversion, or the transmittal that changed the section), `deleted` (a transmittal deleted it;\n`text` is null; the citation is that transmittal) or `unknown` (the archive cannot prove the\ntext on that date; `unknown_reason` says why, for example `chain_incomplete`, which names the\nrevision whose transmittal is missing). A transmittal serves a section only when every revision\nof the chapter after the latest held chapter version has a held transmittal whose change table\nwas read; `basis` states the revision set (the chapter's own table plus the held transmittals\nthat name the chapter; a revision in neither is not known). Dates are the chapter windows' own\n(`in_force_from`: the transmittal's Effective date, or its Implementation date when the Effective date\nis missing or more than 365 days before its issue date; `date_source` says which). Manuals and\ntransmittals are public domain; a source\nor a cited file whose license keeps its text off the API answers `license_held`. A section whose\ncited file's stored rendering is not verified to keep the publisher's word order answers\n`unknown` with `rendering_not_in_document_order`: `text` is null, and the citation (file,\n`render_sha256`, span), `chain` and `basis` are kept. Today that is every manual and transmittal\nPDF, so the route serves no section text until the PDF order check lands; `deleted` and every\nother answer are unchanged. Needs a key, like the stored text renderings.","operationId":"manual_section_v1_archive_docs__doc_id__section_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","description":"A manual chapter document, e.g. manual:clm104c20 (Claims Processing ch.20) or manual:pim83c05 (Program Integrity ch.5)","title":"Doc Id"},"description":"A manual chapter document, e.g. manual:clm104c20 (Claims Processing ch.20) or manual:pim83c05 (Program Integrity ch.5)"},{"name":"section","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d{1,3}(\\.\\d{1,3}){0,6}$","description":"Section number as the manual prints it, e.g. 181 or 30.9.1","title":"Section"},"description":"Section number as the manual prints it, e.g. 181 or 30.9.1"},{"name":"date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Date of service, YYYY-MM-DD","title":"Date"},"description":"Date of service, YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/archive/files/{sha256}":{"get":{"tags":["Source Archive"],"summary":"Archived file metadata and a one-hour link to the original bytes","description":"Provenance for one byte-stream: the URL it was fetched from, when,\nthe publisher's ETag and Last-Modified, the size, the container it came\nfrom (for zip members), the versions it backs, and how many later runs\nsaw the same bytes again. Public. `url` (the presigned link to the original\nbytes) needs a key, so it is null on a keyless response; the sha256 and the\npublisher's resolved_url are always present. Bytes that any source under\nCPT-licensed terms holds get no link even with a key, and neither do\nthe bytes of a document that quotes licensed code text CMS cites;\n`url_withheld` says why.","operationId":"file_meta_v1_archive_files__sha256__get","security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"sha256","in":"path","required":true,"schema":{"type":"string","description":"sha256 of the original bytes, 64 hex characters","title":"Sha256"},"description":"sha256 of the original bytes, 64 hex characters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/archive/files/{sha256}/text":{"get":{"tags":["Source Archive"],"summary":"The stored deterministic text rendering of an archived file, where it keeps the publisher's word order","description":"The rendering that span-level citations point into, with the renderer\nversion that produced it. Text of bytes that any source holds under\nterms that do not allow its whole text is not served: the response says\nso and carries `contains_licensed_descriptors: true` and\n`text_withheld: licensed_text`. A rendering that is not verified to keep\nthe publisher's word order is not served either: `text_withheld` is\n`rendering_not_in_document_order`, and the response\ncarries the file's receipt and `url`, the one-hour link to the original\nbytes. Today only CFR XML renderings serve whole. A rendering that\nquotes licensed code text that CMS cites (such as the ADA's CDT\ndescriptors) is not served: `text_withheld` is `licensed_text`.","operationId":"file_text_v1_archive_files__sha256__text_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"sha256","in":"path","required":true,"schema":{"type":"string","description":"sha256 of the original bytes, 64 hex characters","title":"Sha256"},"description":"sha256 of the original bytes, 64 hex characters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/archive/{source_id}/files":{"get":{"tags":["Source Archive"],"summary":"Archived files of one source, newest first","description":"Metadata only: sha256, resolved URL, fetch time, size, publisher\nversion, and whether a rendering exists. Bytes are behind\n/archive/files/{sha256}.","operationId":"source_files_v1_archive__source_id__files_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","description":"Catalog source id, e.g. dmepos_fee_schedule","title":"Source Id"},"description":"Catalog source id, e.g. dmepos_fee_schedule"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only files fetched at or after this time (ISO-8601)","title":"Since"},"description":"Only files fetched at or after this time (ISO-8601)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"members","in":"query","required":false,"schema":{"type":"boolean","description":"Include zip members (default: top-level files only)","default":false,"title":"Members"},"description":"Include zip members (default: top-level files only)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/archive/{source_id}/docs":{"get":{"tags":["Source Archive"],"summary":"Documents of one source with version counts","description":"A document is the logical thing that has versions over time: a fee\nschedule quarter, an NCCI table for a quarter, the LEIE full file.\nFiles whose names fit no versioning rule are stored but belong to no\ndocument; they appear under /archive/{source_id}/files and in the run\nnotes.","operationId":"source_docs_v1_archive__source_id__docs_get","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","description":"Catalog source id, e.g. dmepos_fee_schedule","title":"Source Id"},"description":"Catalog source id, e.g. dmepos_fee_schedule"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":2000,"minimum":1,"default":200,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/platform/stats":{"get":{"tags":["Data Transparency"],"summary":"Stats","description":"Live platform stats — total rows, source counts, facility / clinician\ncounts, and the timestamp + status of the most recent pipeline run.\n\nContent-negotiated: browsers get a styled HTML dashboard, API clients\nget JSON. Force with ?format=json or ?format=html.\n\nRow counts are PostgreSQL planner estimates (pg_class.reltuples).\nThey're updated by autovacuum, accurate to within single-digit percent,\nand orders of magnitude faster than COUNT(*) on 327M-row tables —\nthe right tradeoff for an unauthenticated endpoint that customers and\nbots can both hit.\n\nUnauthenticated by design — trust-by-transparency.","operationId":"stats_v1_platform_stats_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/accuracy":{"get":{"tags":["Data Transparency"],"summary":"Latest Results","description":"Latest benchmark run: per-system accuracy with public source URLs.\n\nEach entry shows our number, the publicly-reported number, the\nvariance, and the source URL for ground truth. Use this as the\nreceipts to validate any claim our API makes about a system. We\nre-run the benchmark on every release. The major enterprise data\nplatforms do not publish per-system accuracy benchmarks.\n\nContent-negotiated: browsers get a styled HTML page with the\nvariance table and summary tiles; API clients get JSON.\n\nUnauthenticated by design (transparency feature).","operationId":"latest_results_v1_accuracy_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"description":"Force a response format","title":"Format"},"description":"Force a response format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/accuracy/discipline-coverage":{"get":{"tags":["Data Transparency"],"summary":"Discipline Coverage","description":"How much of the nation's practitioner discipline we hold, per state.\n\nBenchmarks our disciplinary-action coverage against the NPDB Public\nUse File — the only national count of state licensure actions and\nexclusions. Two classes are reported separately because they are\ndifferent populations: `exclusion` (federal LEIE + state Medicaid\nexclusion lists) and `licensure_action` (state medical board feeds).\nMixing them would overstate one and understate the other.\n\nWe publish the gaps, not just the wins: a state near zero in the\nlicensure_action class means we have no board feed for it yet.\n\nThe benchmark file is de-identified by statute and carries no names\nor NPIs. Only aggregate counts are published, per its Data Use\nAgreement; counts below the small-cell threshold are withheld.\n\nUnauthenticated by design (transparency feature).","operationId":"discipline_coverage_v1_accuracy_discipline_coverage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/v1/licenses/state/{state_code}":{"get":{"tags":["License Intelligence"],"summary":"License overview for a state","description":"State-level license intelligence overview.\n\nReturns aggregate licensed-provider counts broken out by license\ntype (medical_md, medical_do, advanced_practice, nursing, dental,\npodiatric, optometric) and current status (active, expired), plus\nthe 25 most-recent currently-active disciplinary actions in the\nstate.\n\nSold to credentialing platforms, staffing agencies, and compliance\nteams. For an individual NPI's licenses across all states, see\n`/licenses/{npi}`.","operationId":"state_view_v1_licenses_state__state_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state_code","in":"path","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"description":"2-letter US state code (uppercase). Example: `CA` for California.","title":"State Code"},"description":"2-letter US state code (uppercase). Example: `CA` for California.","example":"CA"}],"responses":{"200":{"description":"Licensed provider counts by type + recent disciplinary actions in the state.","content":{"application/json":{"schema":{},"example":{"state":"CA","count":2,"results":[{"npi":"1245319599","license_number":"A12345","license_type":"medical_md","status":"active","practice_city":"Los Angeles"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/licenses/{npi}":{"get":{"tags":["License Intelligence"],"summary":"Npi Summary","description":"All licenses for an NPI (across states) + disciplinary action summary.","operationId":"npi_summary_v1_licenses__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/licenses/{npi}/disciplinary":{"get":{"tags":["License Intelligence"],"summary":"Npi Disciplinary","description":"Full disciplinary action history for an NPI.","operationId":"npi_disciplinary_v1_licenses__npi__disciplinary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/licenses/alerts/recent":{"get":{"tags":["License Intelligence"],"summary":"Alerts Recent","description":"Recent disciplinary action feed across all states.\n\nReturns recent currently-active actions at or above the severity_floor.\nDefault: high+critical actions in the last 90 days. Use this as the\ndaily monitoring feed for compliance / credentialing workflows.","operationId":"alerts_recent_v1_licenses_alerts_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":730,"minimum":1,"description":"Lookback window in days.","default":90,"title":"Days"},"description":"Lookback window in days."},{"name":"severity_floor","in":"query","required":false,"schema":{"enum":["low","medium","high","critical"],"type":"string","description":"Minimum severity to include.","default":"high","title":"Severity Floor"},"description":"Minimum severity to include."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/mips/leaderboards/{specialty_substring}":{"get":{"tags":["MIPS — Cross-NPI Analytics"],"summary":"MIPS leaderboard by specialty","description":"Top MIPS performers in a specialty, latest reporting year.\n\n`specialty_substring` is matched case-insensitive against the DAC\n(Doctors and Clinicians) primary specialty taxonomy. Returns the top\nN NPIs by final MIPS score descending. Useful for building\n\"top-doctors\" lists, peer benchmarking, or spot-checking outlier\nphysicians.","operationId":"leaderboard_v1_mips_leaderboards__specialty_substring__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"specialty_substring","in":"path","required":true,"schema":{"type":"string","description":"Case-insensitive substring match against DAC primary specialty (e.g., 'Internal', 'Cardiology').","title":"Specialty Substring"},"description":"Case-insensitive substring match against DAC primary specialty (e.g., 'Internal', 'Cardiology').","example":"Internal Medicine"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max results to return.","default":50,"title":"Limit"},"description":"Max results to return.","example":20}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/mips/systems/{system_id}":{"get":{"tags":["MIPS — Cross-NPI Analytics"],"summary":"System-level MIPS rollup","description":"System-level MIPS rollup — mean, median, quartiles across every NPI\nbilling under any descendant of the system.\n\nWalks the `system_hierarchy` tree (e.g., `TENET` → USPI + regional\ndivisions, `SUTTER` → 8 foundations, `KAISER` → 9 Permanente medical groups)\nand aggregates the latest-year MIPS scores for every NPI attributed\nto any descendant.\n\nPair with `/systems/{system_id}/divisions` for the structural\nbreakdown. Answers questions like \"Are physicians at PE platforms\nscoring differently on MIPS than at hospital systems in the same\nmarket?\"","operationId":"system_rollup_v1_mips_systems__system_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"system_id","in":"path","required":true,"schema":{"type":"string","description":"Verzi canonical system ID (e.g., `INTERMOUNTAIN`, `KAISER`, `TENET`).","title":"System Id"},"description":"Verzi canonical system ID (e.g., `INTERMOUNTAIN`, `KAISER`, `TENET`).","example":"INTERMOUNTAIN"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/search":{"get":{"tags":["Financial Intelligence"],"summary":"Companies Search","description":"Search public healthcare companies by ticker or name substring.","operationId":"companies_search_v1_companies_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"description":"Ticker or company name substring.","title":"Q"},"description":"Ticker or company name substring."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{ticker}":{"get":{"tags":["Financial Intelligence"],"summary":"Company Detail","description":"Public company financial profile + filings inventory.\n\nReturns ticker / CIK / system_id linkage plus 5 years of 10-K income\nstatement + balance sheet data, and counts of ingested filings. Data\nis sourced from SEC EDGAR via Financial Modeling Prep.","operationId":"company_detail_v1_companies__ticker__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ma-events/recent":{"get":{"tags":["Financial Intelligence"],"summary":"Recent Ma Events","description":"Recent healthcare M&A activity derived from SEC 8-K filings.\n\nDefinitive Healthcare publishes some M&A data behind their paid tier;\nwe surface SEC-disclosed M&A events with source URLs to the original\n8-K filing. Empty array means no 8-K-derived events have been parsed\nyet for the lookback window — the data populates as the SEC ingestion\nextracts Item 1.01 + 2.01 content.","operationId":"recent_ma_events_v1_ma_events_recent_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":730,"minimum":1,"description":"Lookback window in days.","default":180,"title":"Days"},"description":"Lookback window in days."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/resources":{"get":{"tags":["Data Transparency"],"summary":"List Resources","description":"List all published methodology + sales artifacts. Content-negotiated.","operationId":"list_resources_v1_resources_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html)$"},{"type":"null"}],"title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/resources/{slug}":{"get":{"tags":["Data Transparency"],"summary":"Render Resource","description":"Render a single resource.\n\nContent negotiation:\n  - Browsers (Accept: text/html) → styled HTML page with brand chrome\n  - curl (Accept: */*) → raw markdown text\n  - ?format=markdown → raw markdown (curl-friendly explicit override)\n  - ?format=html → HTML even from curl\n  - ?format=json → JSON envelope with metadata + markdown body","operationId":"render_resource_v1_resources__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(json|html|markdown)$"},{"type":"null"}],"title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/benchmarks/hcahps/national":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"National Benchmarks","description":"National HCAHPS benchmarks with mean, median, percentiles, and std dev.","operationId":"national_benchmarks_v1_benchmarks_hcahps_national_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter (e.g., 2025-11). Defaults to latest.","title":"Quarter"},"description":"Quarter (e.g., 2025-11). Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension (e.g., nurse_communication)","title":"Dimension"},"description":"Filter by dimension (e.g., nurse_communication)"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/national/trends":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"National Benchmark Trends","description":"National benchmark trends over time — see how the industry average moves.","operationId":"national_benchmark_trends_v1_benchmarks_hcahps_national_trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"type":"string","description":"Measure type to trend","default":"top_box","title":"Measure Type"},"description":"Measure type to trend"},{"name":"quarters","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of quarters of history","default":12,"title":"Quarters"},"description":"Number of quarters of history"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/state":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"State Benchmarks","description":"State-level HCAHPS benchmarks.","operationId":"state_benchmarks_v1_benchmarks_hcahps_state_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"State code (e.g., TN, FL, CA)","title":"State"},"description":"State code (e.g., TN, FL, CA)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/peer":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Peer Benchmarks","description":"Peer group HCAHPS benchmarks — by ownership type, hospital type, or bed size.","operationId":"peer_benchmarks_v1_benchmarks_hcahps_peer_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"peer_type","in":"query","required":true,"schema":{"type":"string","description":"Peer group type: ownership, type, bed_size","title":"Peer Type"},"description":"Peer group type: ownership, type, bed_size"},{"name":"peer_value","in":"query","required":true,"schema":{"type":"string","description":"Peer group value (e.g., Proprietary, Acute Care Hospitals, large)","title":"Peer Value"},"description":"Peer group value (e.g., Proprietary, Acute Care Hospitals, large)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter: top_box, linear_score, star_rating","title":"Measure Type"},"description":"Filter: top_box, linear_score, star_rating"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/peer/values":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Peer Group Values","description":"List available values for a peer group type (e.g., all ownership types with hospital counts).","operationId":"peer_group_values_v1_benchmarks_hcahps_peer_values_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"peer_type","in":"query","required":true,"schema":{"type":"string","description":"Peer group type: ownership, type, bed_size","title":"Peer Type"},"description":"Peer group type: ownership, type, bed_size"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/facility/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Benchmarks","description":"Facility-level HCAHPS values with national/state/peer percentile rankings.","operationId":"facility_benchmarks_v1_benchmarks_hcahps_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/facility/{ccn}/dimensions":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Dimensions","description":"Dimension-level HCAHPS summary with top-box, bottom-box, linear score, star rating, and percentiles.","operationId":"facility_dimensions_v1_benchmarks_hcahps_facility__ccn__dimensions_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/facility/{ccn}/trends":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Facility Trends","description":"HCAHPS trend analysis — QoQ/YoY changes, direction, streaks, significance.","operationId":"facility_trends_v1_benchmarks_hcahps_facility__ccn__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"quarters","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of quarters of history","default":8,"title":"Quarters"},"description":"Number of quarters of history"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/compare":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Compare","description":"Side-by-side HCAHPS comparison of multiple facilities.","operationId":"compare_v1_benchmarks_hcahps_compare_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"facilities","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated CCNs (max 50)","title":"Facilities"},"description":"Comma-separated CCNs (max 50)"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/movers":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Top Movers","description":"Biggest HCAHPS movers — hospitals with largest QoQ changes.","operationId":"top_movers_v1_benchmarks_hcahps_movers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Direction: improving or declining","default":"declining","title":"Direction"},"description":"Direction: improving or declining"},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"min_change","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Minimum absolute change (percentage points)","default":3,"title":"Min Change"},"description":"Minimum absolute change (percentage points)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum results","default":50,"title":"Limit"},"description":"Maximum results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hcahps/market":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Market Benchmarks","description":"HCAHPS benchmarks for all hospitals within a geographic radius.","operationId":"market_benchmarks_v1_benchmarks_hcahps_market_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","description":"Latitude of center point","title":"Lat"},"description":"Latitude of center point"},{"name":"lng","in":"query","required":true,"schema":{"type":"number","description":"Longitude of center point","title":"Lng"},"description":"Longitude of center point"},{"name":"radius_miles","in":"query","required":true,"schema":{"type":"number","maximum":500,"exclusiveMinimum":0,"description":"Search radius in miles","title":"Radius Miles"},"description":"Search radius in miles"},{"name":"dimension","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by dimension","title":"Dimension"},"description":"Filter by dimension"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/scorecard/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Hospital Scorecard","description":"Comprehensive hospital scorecard — HCAHPS + HVBP + HAC + HCRIS + Star Ratings in one call.","operationId":"hospital_scorecard_v1_benchmarks_scorecard__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/benchmarks/hvbp/revenue-impact/{ccn}":{"get":{"tags":["HCAHPS Benchmarks"],"summary":"Hvbp Revenue Impact","description":"Estimate HVBP payment adjustment and revenue impact.\n\nCombines HVBP Total Performance Score with HCRIS financial data to estimate\nthe Medicare payment adjustment (±2%) and dollar impact. Includes TPS percentile\nranking and domain-level breakdown.","operationId":"hvbp_revenue_impact_v1_benchmarks_hvbp_revenue_impact__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"HVBP fiscal year. Defaults to latest.","title":"Fiscal Year"},"description":"HVBP fiscal year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/hospitals/{ccn}/market-share":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Market Share","description":"Hospital's market share across all ZIP codes it serves.\n\nShows discharge volume, market share %, and competitive position for each ZIP\nin the hospital's service area. Derived from CMS Hospital Service Area File.","operationId":"hospital_market_share_v1_market_intelligence_hospitals__ccn__market_share_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year (e.g., 2024). Defaults to latest.","title":"Year"},"description":"Year (e.g., 2024). Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/hospitals/{ccn}/service-area":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Service Area","description":"Hospital's service area summary with primary/secondary/tertiary ZIP tiers.\n\nPrimary = hospital has >50% market share in the ZIP.\nSecondary = 10-50%. Tertiary = <10%.\nIncludes weighted average market share across all ZIPs.","operationId":"hospital_service_area_v1_market_intelligence_hospitals__ccn__service_area_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/hospitals/{ccn}/trends":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Market Trends","description":"Hospital's market share trends over all available years (2015-2024).\n\nShows year-over-year changes in discharge volume, market share, and\ntrend direction (gaining/losing/stable).","operationId":"hospital_market_trends_v1_market_intelligence_hospitals__ccn__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/hospitals/{ccn}/competitors":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Competitors","description":"Top competitors for a hospital, ranked by geographic overlap.\n\nIdentifies hospitals competing for the same patient populations\nbased on shared ZIP codes. Includes overlap coefficient, shared\ndischarge volumes, and competitor quality ratings.","operationId":"hospital_competitors_v1_market_intelligence_hospitals__ccn__competitors_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max competitors to return","default":20,"title":"Limit"},"description":"Max competitors to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/zip/{zip_code}":{"get":{"tags":["Market Intelligence"],"summary":"Zip Market","description":"All hospitals serving a ZIP code with market shares and quality ratings.\n\nIncludes HHI (Herfindahl-Hirschman Index) for market concentration:\n<1500 = competitive, 1500-2500 = moderately concentrated, >2500 = highly concentrated.","operationId":"zip_market_v1_market_intelligence_zip__zip_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/zip/{zip_code}/trends":{"get":{"tags":["Market Intelligence"],"summary":"Zip Trends","description":"ZIP code market trends over all available years.\n\nShows how competition, volume, and concentration change over time.","operationId":"zip_trends_v1_market_intelligence_zip__zip_code__trends_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/enrollment/county/{fips_code}":{"get":{"tags":["Market Intelligence"],"summary":"County Enrollment","description":"County-level Medicare enrollment with demographics, dual eligibility, and trends.\n\nIncludes MA penetration rate, growth rate, and demographic breakdown.","operationId":"county_enrollment_v1_market_intelligence_enrollment_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/enrollment/county/{fips_code}/history":{"get":{"tags":["Market Intelligence"],"summary":"County Enrollment History","description":"County enrollment trends across all available years (2013-present).\n\nShows year-over-year growth, MA penetration changes, and demographic shifts.","operationId":"county_enrollment_history_v1_market_intelligence_enrollment_county__fips_code__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/enrollment/state/{state}":{"get":{"tags":["Market Intelligence"],"summary":"State Enrollment","description":"State-level Medicare enrollment summary.","operationId":"state_enrollment_v1_market_intelligence_enrollment_state__state__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/enrollment/growth-leaders":{"get":{"tags":["Market Intelligence"],"summary":"Enrollment Growth Leaders","description":"Counties with fastest Medicare enrollment growth.\n\nIdentifies markets where the Medicare population is expanding —\ncritical signal for hospital strategic planning and PE investment analysis.","operationId":"enrollment_growth_leaders_v1_market_intelligence_enrollment_growth_leaders_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"min_benes","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Minimum beneficiaries to include","default":1000,"title":"Min Benes"},"description":"Minimum beneficiaries to include"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":50,"title":"Limit"},"description":"Max results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/opportunity/search":{"get":{"tags":["Market Intelligence"],"summary":"Opportunity Search","description":"Search for hospitals with highest market opportunity.\n\nComposite scoring combines enrollment growth, market share headroom,\nvolume trends, and MA penetration. Useful for identifying expansion\ntargets, acquisition candidates, or underserved markets.","operationId":"opportunity_search_v1_market_intelligence_opportunity_search_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum opportunity score","title":"Min Score"},"description":"Minimum opportunity score"},{"name":"min_beds","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum bed count","title":"Min Beds"},"description":"Minimum bed count"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Max results","default":50,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/opportunity/{ccn}":{"get":{"tags":["Market Intelligence"],"summary":"Hospital Opportunity","description":"Combined market opportunity score for a hospital.\n\nIntegrates market share position, enrollment growth trends, MA penetration,\nand volume trajectory into a single opportunity score. Higher = more opportunity.\n\nFactors: enrollment growth (weighted 2x), room to grow (inverse of market share),\nvolume momentum, and MA penetration (revenue upside).","operationId":"hospital_opportunity_v1_market_intelligence_opportunity__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/market-intelligence/cbsa/{cbsa_code}/population":{"get":{"tags":["Market Intelligence"],"summary":"Cbsa Population","description":"Census Bureau population estimate history for a CBSA (metro/micro area), with year-over-year growth.","operationId":"cbsa_population_v1_market_intelligence_cbsa__cbsa_code__population_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"cbsa_code","in":"path","required":true,"schema":{"type":"string","title":"Cbsa Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/health/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Health Profile","description":"County health profile with key chronic disease, risk behavior, and preventive care measures.\n\nDerived from CDC PLACES: model-based estimates from BRFSS survey data.\nIncludes diabetes, obesity, smoking, physical inactivity, depression, and more.","operationId":"county_health_profile_v1_community_health_health_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/health/rankings/{measure_id}":{"get":{"tags":["Community Health"],"summary":"Places Rankings","description":"Rank counties or ZCTAs by a specific health measure.\n\nExamples: highest diabetes rates, lowest preventive screening, worst mental health.\nUse MeasureId values like DIABETES, OBESITY, CSMOKING, BPHIGH, CHECKUP, etc.","operationId":"places_rankings_v1_community_health_health_rankings__measure_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"measure_id","in":"path","required":true,"schema":{"type":"string","title":"Measure Id"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","description":"'county' or 'zcta'","default":"county","title":"Location Type"},"description":"'county' or 'zcta'"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"'desc' (highest first) or 'asc'","default":"desc","title":"Sort"},"description":"'desc' (highest first) or 'asc'"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/health/{location_type}/{location_id}":{"get":{"tags":["Community Health"],"summary":"Places Measures","description":"All 40 CDC PLACES measures for a county or ZCTA, grouped by category.\n\nCategories: health outcomes, preventive services, risk behaviors,\ndisabilities, health status, health-related social needs.","operationId":"places_measures_v1_community_health_health__location_type___location_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"location_type","in":"path","required":true,"schema":{"type":"string","title":"Location Type"}},{"name":"location_id","in":"path","required":true,"schema":{"type":"string","title":"Location Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/spending/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Spending","description":"County-level Medicare FFS spending and utilization.\n\nIncludes per-capita spending (actual and price-standardized), inpatient stays,\nER visits, readmission rates, and service-specific breakdowns.\nStandardized amounts remove geographic price differences for fair comparison.","operationId":"county_spending_v1_community_health_spending_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/spending/state/{state}":{"get":{"tags":["Community Health"],"summary":"State Spending","description":"State-level Medicare FFS spending and utilization.","operationId":"state_spending_v1_community_health_spending_state__state__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/spending/rankings":{"get":{"tags":["Community Health"],"summary":"Spending Rankings","description":"Counties ranked by per-capita standardized Medicare spending.\n\nIdentifies high-cost and low-cost markets. Standardized spending removes\ngeographic wage/price adjustments for apples-to-apples comparison.","operationId":"spending_rankings_v1_community_health_spending_rankings_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/geography/zip/{zip_code}":{"get":{"tags":["Community Health"],"summary":"Zip Geography","description":"Full geographic context for a ZIP code.\n\nReturns HRR (Hospital Referral Region), HSA (Hospital Service Area),\nCBSA (metro/micro area), county FIPS, and state.","operationId":"zip_geography_v1_community_health_geography_zip__zip_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"zip_code","in":"path","required":true,"schema":{"type":"string","title":"Zip Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/geography/hrr/{hrr_number}":{"get":{"tags":["Community Health"],"summary":"Hrr Info","description":"HRR (Hospital Referral Region) details — ZIP count, HSA count.","operationId":"hrr_info_v1_community_health_geography_hrr__hrr_number__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hrr_number","in":"path","required":true,"schema":{"type":"integer","title":"Hrr Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/geography/hrr/{hrr_number}/hospitals":{"get":{"tags":["Community Health"],"summary":"Hrr Hospitals","description":"All hospitals in a Hospital Referral Region with star ratings.\n\nHRRs represent regional healthcare markets defined by where Medicare\npatients are referred for major cardiovascular and neurosurgical procedures.","operationId":"hrr_hospitals_v1_community_health_geography_hrr__hrr_number__hospitals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hrr_number","in":"path","required":true,"schema":{"type":"integer","title":"Hrr Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/context/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Context","description":"Unified county market context combining enrollment, health, spending, and SDOH.\n\nSingle endpoint for the complete market picture: Medicare enrollment trends,\nchronic disease burden, spending patterns, social determinants, and\ngeographic classification (CBSA, HRR).","operationId":"county_context_v1_community_health_context_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/community-health/sdoh/county/{fips_code}":{"get":{"tags":["Community Health"],"summary":"County Sdoh","description":"AHRQ Social Determinants of Health for a county.\n\nIncludes poverty, income, unemployment, insurance, education, disability,\nfood access, family structure, and language indicators.","operationId":"county_sdoh_v1_community_health_sdoh_county__fips_code__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"fips_code","in":"path","required":true,"schema":{"type":"string","title":"Fips Code"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year. Defaults to latest.","title":"Year"},"description":"Year. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/summary":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Vbc Summary","description":"High-level VBC/ACO data summary and statistics.","operationId":"vbc_summary_v1_vbc_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/vbc/acos":{"get":{"tags":["Value-Based Care / ACO"],"summary":"List Acos","description":"Search and list MSSP ACOs.","operationId":"list_acos_v1_vbc_acos_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by ACO name or ID","title":"Q"},"description":"Search by ACO name or ID"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state (in service area)","title":"State"},"description":"Filter by state (in service area)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year (default: latest)","title":"Year"},"description":"Performance year (default: latest)"},{"name":"track","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by track: basic or enhanced","title":"Track"},"description":"Filter by track: basic or enhanced"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/acos/{aco_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Detail","description":"Full ACO profile: org info, participants, SNF affiliates, beneficiary geography.","operationId":"aco_detail_v1_vbc_acos__aco_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year (default: latest)","title":"Year"},"description":"Performance year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/acos/{aco_id}/history":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco History","description":"ACO performance trend across all available years.","operationId":"aco_history_v1_vbc_acos__aco_id__history_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/acos/{aco_id}/beneficiaries":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Beneficiaries","description":"ACO beneficiary distribution by state.","operationId":"aco_beneficiaries_v1_vbc_acos__aco_id__beneficiaries_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year (default: latest)","title":"Year"},"description":"Year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/acos/{aco_id}/clinicians":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Aco Clinicians","description":"The clinicians Verzi links to this ACO, one row per NPI.\n\n`aco_id` is the CMS ACO ID, such as `A1234`, as published from PY2018. The older `ACO_Num` form of PY2013 to PY2017 is not accepted.\n\nThe rows are the reverse of `/provider/{npi}/acos`. Each row gives the\nNPI's best link `confidence` to this ACO and every `match_methods` entry\nthat linked it. A name match is never presented as exact: treat `medium`\nand `low` rows as leads to verify. `min_confidence` keeps rows at that\nlevel or better (default `low`, so every linked NPI). `total` counts every\nNPI that matches the filters, across all pages.","operationId":"aco_clinicians_v1_vbc_acos__aco_id__clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"min_confidence","in":"query","required":false,"schema":{"type":"string","pattern":"^(high|medium|low)$","description":"high, medium or low","default":"low","title":"Min Confidence"},"description":"high, medium or low"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year of the link","title":"Year"},"description":"Performance year of the link"},{"name":"match_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(cms_qpp_participation|organization_name_match|individual_name_match)$"},{"type":"null"}],"description":"Only links made by this method","title":"Match Method"},"description":"Only links made by this method"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/provider-lookup":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Provider Aco Lookup","description":"Find which ACO(s) a provider belongs to, by NPI or by participant name.\n\n`npi` returns the NPI's links from `provider_aco_links`, each with a match\nmethod and confidence (the same rows as `/provider/{npi}/acos`). A name\nmatch is never presented as exact.\n\n`name` searches the MSSP participant list by legal business name. Each row\ncarries `match.method` `participant_lbn_search` with confidence `none`: it\nis a name search, not a provider match.\n\nOne of `npi` or `name` is required. When both are given, `npi` wins and\n`name` is ignored.","operationId":"provider_aco_lookup_v1_vbc_provider_lookup_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Participant legal business name (partial match)","title":"Name"},"description":"Participant legal business name (partial match)"},{"name":"npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":10,"maxLength":10},{"type":"null"}],"description":"10-digit NPI: the provider's ACO links by NPI","title":"Npi"},"description":"10-digit NPI: the provider's ACO links by NPI"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year for a name search (default: latest)","title":"Year"},"description":"Performance year for a name search (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/facility/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Facility Aco","description":"Get ACO affiliation and HAC scores for a hospital by CCN.","operationId":"facility_aco_v1_vbc_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/financials":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Financials Search","description":"Search and rank MSSP ACOs by financial performance.\n\nCovers PY2013 to PY2024. Rates (savings rate, share rate, quality score)\nare normalized to percent across every year: CMS switches between a 0-1\nfraction and a 0-100 percentage from file to file, so the published\nnumbers are not comparable as-is. `sort=losses` ranks worst-first.","operationId":"mssp_financials_search_v1_vbc_financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2013-2024","title":"Year"},"description":"Performance year, 2013-2024"},{"name":"track","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Track filter, e.g. ENHANCED, BASIC, Track 1","title":"Track"},"description":"Track filter, e.g. ENHANCED, BASIC, Track 1"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACO state","title":"State"},"description":"ACO state"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACO name or ID","title":"Q"},"description":"ACO name or ID"},{"name":"min_savings","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum earned shared savings","title":"Min Savings"},"description":"Minimum earned shared savings"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"earn_save_loss | gen_save_loss | sav_rate | qual_score | n_ab | losses","default":"earn_save_loss","title":"Sort"},"description":"earn_save_loss | gen_save_loss | sav_rate | qual_score | n_ab | losses"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/financials/summary":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Financials Summary","description":"Program-level MSSP rollup: benchmark, expenditure, savings, track mix.\n\nReports how many ACOs earned shared savings against how many owed losses,\nwith the totals behind both.","operationId":"mssp_financials_summary_v1_vbc_financials_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, defaults to the latest","title":"Year"},"description":"Performance year, defaults to the latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/acos/{aco_id}/financials":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Mssp Aco Financials","description":"Every published performance period for one MSSP ACO.\n\nReturns benchmark, expenditure, shared savings or losses, quality score,\nprovider counts, beneficiary demographics, and utilization per year, plus\ncumulative earned savings across all periods. `source_row` on each period\ncarries the CMS row exactly as published.\n\nAccepts an ACO_ID or, for ACOs that left before PY2018, an ACO_Num.","operationId":"mssp_aco_financials_v1_vbc_acos__aco_id__financials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}},{"name":"include_measures","in":"query","required":false,"schema":{"type":"boolean","description":"Include per-year quality measures","default":true,"title":"Include Measures"},"description":"Include per-year quality measures"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/reach":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Orgs","description":"List ACO REACH entities, one row per entity per performance year, paged.\n\nCovers PY2021 (the Direct Contracting year the model grew out of) through\nPY2026. Omit `year` to get every year. The answer carries `total`, so a\ncaller pages with `offset` until it has `total` rows.","operationId":"reach_orgs_v1_vbc_reach_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2021-2026","title":"Year"},"description":"Performance year, 2021-2026"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Rows per page","default":50,"title":"Limit"},"description":"Rows per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip","default":0,"title":"Offset"},"description":"Rows to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/reach/{entity_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Detail","description":"ACO REACH entity detail with financials and participant list.\n\nFinancials are returned for every performance year. The participant list is\npaged and covers one year at a time: use `provider_total` to page through\nit. Without `year` the entity row and participants come from the most\nrecent year available.\n\nParticipants carry no NPI. CMS publishes only `par_lbn`, a free-text legal\nbusiness name that for REACH is usually an individual clinician's name.","operationId":"reach_detail_v1_vbc_reach__entity_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year, 2021-2026","title":"Year"},"description":"Performance year, 2021-2026"},{"name":"provider_limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"Participants per page","default":500,"title":"Provider Limit"},"description":"Participants per page"},{"name":"provider_offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Participant page offset","default":0,"title":"Provider Offset"},"description":"Participant page offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/reach/{entity_id}/clinicians":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Reach Clinicians","description":"The clinicians Verzi links to this ACO, one row per NPI.\n\n`entity_id` is the ACO REACH entity ID, such as `D0211`.\n\nThe rows are the reverse of `/provider/{npi}/acos`. Each row gives the\nNPI's best link `confidence` to this ACO and every `match_methods` entry\nthat linked it. A name match is never presented as exact: treat `medium`\nand `low` rows as leads to verify. `min_confidence` keeps rows at that\nlevel or better (default `low`, so every linked NPI). `total` counts every\nNPI that matches the filters, across all pages.","operationId":"reach_clinicians_v1_vbc_reach__entity_id__clinicians_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}},{"name":"min_confidence","in":"query","required":false,"schema":{"type":"string","pattern":"^(high|medium|low)$","description":"high, medium or low","default":"low","title":"Min Confidence"},"description":"high, medium or low"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Performance year of the link","title":"Year"},"description":"Performance year of the link"},{"name":"match_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(cms_qpp_participation|organization_name_match|individual_name_match)$"},{"type":"null"}],"description":"Only links made by this method","title":"Match Method"},"description":"Only links made by this method"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Clinicians per page","default":100,"title":"Limit"},"description":"Clinicians per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Clinicians to skip","default":0,"title":"Offset"},"description":"Clinicians to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/ngaco":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Ngaco List","description":"Next Generation ACO financial performance records, paged.\n\nOne row per ACO per performance year (6 years, about 225 rows). The answer\ncarries `total`, so a caller pages with `offset` until it has `total` rows.","operationId":"ngaco_list_v1_vbc_ngaco_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Rows per page","default":50,"title":"Limit"},"description":"Rows per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip","default":0,"title":"Offset"},"description":"Rows to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/ngaco/{aco_id}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Ngaco Detail","description":"NGACO financial performance for a specific ACO.","operationId":"ngaco_detail_v1_vbc_ngaco__aco_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"aco_id","in":"path","required":true,"schema":{"type":"string","title":"Aco Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/hac/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hac Measures","description":"HAC Reduction Program measures for a hospital.","operationId":"hac_measures_v1_vbc_hac__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Year"},"description":"Fiscal year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/hac-worst":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hac Worst","description":"Hospitals with worst HAC scores (highest risk of payment reduction).","operationId":"hac_worst_v1_vbc_hac_worst_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/hrrp":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp Search","description":"Search hospitals by HRRP payment reduction, worst penalties first.","operationId":"hrrp_search_v1_vbc_hrrp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by state","title":"State"},"description":"Filter by state"},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Fiscal Year"},"description":"Fiscal year (default: latest)"},{"name":"min_reduction_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minimum payment reduction percentage","title":"Min Reduction Pct"},"description":"Minimum payment reduction percentage"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/hrrp/{ccn}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp History","description":"HRRP payment adjustment factor history for a hospital, all fiscal years.","operationId":"hrrp_history_v1_vbc_hrrp__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/hrrp/{ccn}/measures":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Hrrp Measures","description":"Per-condition HRRP detail (excess readmission ratios) for a hospital.","operationId":"hrrp_measures_v1_vbc_hrrp__ccn__measures_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year (default: latest)","title":"Fiscal Year"},"description":"Fiscal year (default: latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/models":{"get":{"tags":["Value-Based Care / ACO"],"summary":"List Models","description":"The Innovation Center models we load, with CMS's stage for each,\nwhat CMS publishes, and the rows and periods we hold.","operationId":"list_models_v1_vbc_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/vbc/models/by-npi/{npi}":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Models By Npi","description":"The model participations CMS states for an NPI.\n\nToday only BPCI Advanced publishes NPIs: the attending and operating\nanchor providers of each episode initiator, from the model's data\ncrosswalk. Every row carries `match_method` `cms_crosswalk_npi` and\n`confidence` `high`; none is a name match. An NPI with no stated\nparticipation gets an empty list, not a 404.","operationId":"models_by_npi_v1_vbc_models_by_npi__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{10}$","description":"10-digit National Provider Identifier.","title":"Npi"},"description":"10-digit National Provider Identifier."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/models/{model_id}/participants":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Model Participants","description":"One model's participants, newest period first. `source_row` carries\nthe CMS row as published.","operationId":"model_participants_v1_vbc_models__model_id__participants_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team","title":"Model Id"},"description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state","title":"State"},"description":"Two-letter state"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Legal or DBA name (partial match)","title":"Q"},"description":"Legal or DBA name (partial match)"},{"name":"ccn","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital CCN (CJR, BPCI Advanced anchors)","title":"Ccn"},"description":"Hospital CCN (CJR, BPCI Advanced anchors)"},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A model year (MY8), performance year (PY2024) or list date","title":"Period"},"description":"A model year (MY8), performance year (PY2024) or list date"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vbc/models/{model_id}/results":{"get":{"tags":["Value-Based Care / ACO"],"summary":"Model Results","description":"One model's financial and quality results in long form: one row per\nparticipant, period and metric. `value_num` holds a number; `value_text`\nholds a category such as \"Decile 9\" or \"PASS\". A model whose results CMS\ndoes not publish returns an empty list.","operationId":"model_results_v1_vbc_models__model_id__results_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team","title":"Model Id"},"description":"One of: bpci_advanced, cjr, kcc, primary_care_first, making_care_primary, aco_pc_flex, team"},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Performance year, e.g. PY2024 or PY5.1","title":"Period"},"description":"Performance year, e.g. PY2024 or PY5.1"},{"name":"participant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CMS participant id (CCN, KCC_ID, BPID)","title":"Participant Id"},"description":"CMS participant id (CCN, KCC_ID, BPID)"},{"name":"ccn","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hospital CCN (CJR)","title":"Ccn"},"description":"Hospital CCN (CJR)"},{"name":"metric","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Metric key, e.g. final_reconciliation_amount","title":"Metric"},"description":"Metric key, e.g. final_reconciliation_amount"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Participant name (partial match)","title":"Q"},"description":"Participant name (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/portfolio":{"get":{"tags":["Portfolios & Analytics"],"summary":"List Portfolios Endpoint","description":"List all portfolios for your organization.","operationId":"list_portfolios_endpoint_v1_portfolio_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]},"post":{"tags":["Portfolios & Analytics"],"summary":"Create Portfolio Endpoint","description":"Create a new portfolio of hospitals.","operationId":"create_portfolio_endpoint_v1_portfolio_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/portfolio/{portfolio_id}":{"get":{"tags":["Portfolios & Analytics"],"summary":"Get Portfolio Endpoint","description":"Get portfolio details.","operationId":"get_portfolio_endpoint_v1_portfolio__portfolio_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Portfolios & Analytics"],"summary":"Update Portfolio Endpoint","description":"Update a portfolio.","operationId":"update_portfolio_endpoint_v1_portfolio__portfolio_id__put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Portfolios & Analytics"],"summary":"Delete Portfolio Endpoint","description":"Delete a portfolio.","operationId":"delete_portfolio_endpoint_v1_portfolio__portfolio_id__delete","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/portfolio/{portfolio_id}/hcahps/summary":{"get":{"tags":["Portfolios & Analytics"],"summary":"Portfolio Hcahps Summary","description":"HCAHPS dimension summaries for all hospitals in a portfolio.","operationId":"portfolio_hcahps_summary_v1_portfolio__portfolio_id__hcahps_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/portfolio/{portfolio_id}/hcahps/outliers":{"get":{"tags":["Portfolios & Analytics"],"summary":"Portfolio Outliers","description":"Find hospitals in portfolio below a national percentile threshold.","operationId":"portfolio_outliers_v1_portfolio__portfolio_id__hcahps_outliers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."},{"name":"threshold","in":"query","required":false,"schema":{"type":"integer","maximum":99,"minimum":1,"description":"Percentile threshold (hospitals below this)","default":25,"title":"Threshold"},"description":"Percentile threshold (hospitals below this)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/watchlists":{"get":{"tags":["Portfolios & Analytics"],"summary":"List Watchlists Endpoint","description":"List your organization's watchlists.","operationId":"list_watchlists_endpoint_v1_watchlists_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]},"post":{"tags":["Portfolios & Analytics"],"summary":"Create Watchlist Endpoint","description":"Create a watchlist to monitor portfolio hospitals.","operationId":"create_watchlist_endpoint_v1_watchlists_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchlistCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/alerts":{"get":{"tags":["Portfolios & Analytics"],"summary":"Get Alerts Endpoint","description":"Get alerts triggered by your watchlists.","operationId":"get_alerts_endpoint_v1_alerts_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"unread_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only show unread alerts","default":true,"title":"Unread Only"},"description":"Only show unread alerts"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum results","default":100,"title":"Limit"},"description":"Maximum results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/alerts/{alert_id}/read":{"put":{"tags":["Portfolios & Analytics"],"summary":"Mark Alert Read Endpoint","description":"Mark an alert as read.","operationId":"mark_alert_read_endpoint_v1_alerts__alert_id__read_put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"integer","title":"Alert Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/export/hcahps/facility/{ccn}":{"get":{"tags":["Export"],"summary":"Export Facility Hcahps","description":"Export full HCAHPS history for a facility with benchmarks and percentiles.","operationId":"export_facility_hcahps_v1_export_hcahps_facility__ccn__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ccn","in":"path","required":true,"schema":{"type":"string","title":"Ccn"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"Export format: csv or json","default":"csv","title":"Format"},"description":"Export format: csv or json"},{"name":"quarters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated quarters, or 'all'","title":"Quarters"},"description":"Comma-separated quarters, or 'all'"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/export/hcahps/portfolio/{portfolio_id}":{"get":{"tags":["Export"],"summary":"Export Portfolio Hcahps","description":"Export HCAHPS data for all hospitals in a portfolio.","operationId":"export_portfolio_hcahps_v1_export_hcahps_portfolio__portfolio_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"portfolio_id","in":"path","required":true,"schema":{"type":"integer","title":"Portfolio Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"Export format: csv or json","default":"csv","title":"Format"},"description":"Export format: csv or json"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter. Defaults to latest.","title":"Quarter"},"description":"Quarter. Defaults to latest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinical-trials":{"get":{"tags":["Clinical Trials"],"summary":"Clinical Trials Search","description":"Search ClinicalTrials.gov studies with at least one US-located site.","operationId":"clinical_trials_search_v1_clinical_trials_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by trial title (partial match)","title":"Q"},"description":"Search by trial title (partial match)"},{"name":"condition","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by condition (partial match)","title":"Condition"},"description":"Filter by condition (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by site state (2-letter code)","title":"State"},"description":"Filter by site state (2-letter code)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by overall status (e.g. RECRUITING, COMPLETED)","title":"Status"},"description":"Filter by overall status (e.g. RECRUITING, COMPLETED)"},{"name":"sponsor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by lead sponsor (partial match)","title":"Sponsor"},"description":"Filter by lead sponsor (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinical-trials/{nct_id}":{"get":{"tags":["Clinical Trials"],"summary":"Clinical Trial Detail","description":"Full trial detail including matched facility sites and investigators.","operationId":"clinical_trial_detail_v1_clinical_trials__nct_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"nct_id","in":"path","required":true,"schema":{"type":"string","title":"Nct Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clinical-trials/provider/{npi}":{"get":{"tags":["Clinical Trials"],"summary":"Provider Clinical Trials","description":"Clinical trials where this provider (by NPI) is listed as an investigator.","operationId":"provider_clinical_trials_v1_clinical_trials_provider__npi__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/summary":{"get":{"tags":["Drug Economics"],"summary":"Row counts and freshness across the drug economics layer","description":"Counts and latest dates for every rx dataset: NDC packages, RxNorm links,\ningredients, NADAC rows and as-of date, CMS spending, SDUD, current\nshortages, Cost Plus products captured, and employer health plans.","operationId":"rx_summary_v1_rx_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/rx/ingredients":{"get":{"tags":["Drug Economics"],"summary":"Search active ingredients with NDC counts and median generic NADAC","description":"One row per RxNorm ingredient: how many NDCs carry it, how many are\nbranded, how many have a NADAC price, and the median generic NADAC per\nunit at the latest effective date.","operationId":"rx_ingredients_v1_rx_ingredients_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient name (partial match), e.g. atorvastatin","title":"Q"},"description":"Ingredient name (partial match), e.g. atorvastatin"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/ingredients/{rxcui}":{"get":{"tags":["Drug Economics"],"summary":"Ingredient detail: NDCs with NADAC, CMS spending, Cost Plus, shortages","description":"Every NDC that resolves to the ingredient with its latest NADAC, the\nCMS Part D, Part B, and Medicaid spending rows for matching generic\nnames, Cost Plus products matched to the ingredient's clinical drugs,\nand openFDA shortage records.","operationId":"rx_ingredient_v1_rx_ingredients__rxcui__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"rxcui","in":"path","required":true,"schema":{"type":"string","description":"RxNorm RXCUI of the ingredient, e.g. 83367","title":"Rxcui"},"description":"RxNorm RXCUI of the ingredient, e.g. 83367"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/ndcs/{ndc11}":{"get":{"tags":["Drug Economics"],"summary":"NDC package profile with RxNorm, NADAC, and national Medicaid utilization","operationId":"rx_ndc_v1_rx_ndcs__ndc11__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/ndcs/{ndc11}/nadac":{"get":{"tags":["Drug Economics"],"summary":"NADAC price history for one NDC (change-only series)","operationId":"rx_ndc_nadac_v1_rx_ndcs__ndc11__nadac_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/nadac/movers":{"get":{"tags":["Drug Economics"],"summary":"Largest NADAC price moves in the last N weeks","description":"Percent change between an NDC's latest effective price and the one\nbefore it, for NDCs whose price changed inside the window.","operationId":"rx_nadac_movers_v1_rx_nadac_movers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"weeks","in":"query","required":false,"schema":{"type":"integer","maximum":104,"minimum":1,"default":4,"title":"Weeks"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"up or down","default":"up","title":"Direction"},"description":"up or down"},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"G (generic) or B (brand)","title":"Classification"},"description":"G (generic) or B (brand)"},{"name":"min_per_unit","in":"query","required":false,"schema":{"type":"number","minimum":0,"description":"Ignore NDCs priced below this per unit","default":0.0,"title":"Min Per Unit"},"description":"Ignore NDCs priced below this per unit"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/spending":{"get":{"tags":["Drug Economics"],"summary":"CMS Spending by Drug (Part D, Part B, Medicaid), one row per drug and year","operationId":"rx_spending_v1_rx_spending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"program","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: partd, partb, medicaid","title":"Program"},"description":"One of: partd, partb, medicaid"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Generic or brand name (partial match)","title":"Q"},"description":"Generic or brand name (partial match)"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2013},{"type":"null"}],"title":"Year"}},{"name":"manufacturer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"'Overall' for the program total, a labeler name, or empty for all","default":"Overall","title":"Manufacturer"},"description":"'Overall' for the program total, a labeler name, or empty for all"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/spending/top":{"get":{"tags":["Drug Economics"],"summary":"Top drugs by total spending for a program and year","operationId":"rx_spending_top_v1_rx_spending_top_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"program","in":"query","required":false,"schema":{"type":"string","description":"One of: partd, partb, medicaid","default":"partd","title":"Program"},"description":"One of: partd, partb, medicaid"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2013},{"type":"null"}],"description":"Defaults to the latest loaded year","title":"Year"},"description":"Defaults to the latest loaded year"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/shortages":{"get":{"tags":["Drug Economics"],"summary":"FDA drug shortages (openFDA)","operationId":"rx_shortages_v1_rx_shortages_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current or Resolved (prefix match)","title":"Status"},"description":"Current or Resolved (prefix match)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Generic name or company (partial match)","title":"Q"},"description":"Generic name or company (partial match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/cost-plus":{"get":{"tags":["Drug Economics"],"summary":"Cost Plus Drugs public prices beside median NADAC","operationId":"rx_costplus_v1_rx_cost_plus_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Product, brand, or slug (partial match)","title":"Q"},"description":"Product, brand, or slug (partial match)"},{"name":"matched_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only products matched to an RxNorm clinical drug","default":false,"title":"Matched Only"},"description":"Only products matched to an RxNorm clinical drug"},{"name":"in_stock","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Stock"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/cost-plus/catalog/timeline":{"get":{"tags":["Drug Economics"],"summary":"Cost Plus catalog size by month since 2022 and products first seen each month","description":"One row per month with a usable Internet Archive sitemap capture (or\nthe live catalog for the current month): how many medication slugs the\ncatalog listed, and how many products are first seen in that month.","operationId":"rx_costplus_timeline_v1_rx_cost_plus_catalog_timeline_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/rx/cost-plus/{slug}":{"get":{"tags":["Drug Economics"],"summary":"One Cost Plus product with its dated price history and catalog entry month","operationId":"rx_costplus_product_v1_rx_cost_plus__slug__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"URL slug, e.g. atorvastatin-10mg-tablet","title":"Slug"},"description":"URL slug, e.g. atorvastatin-10mg-tablet"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/meps/mix":{"get":{"tags":["Drug Economics"],"summary":"Weighted drug mix by ingredient for a MEPS payer segment (the commercial population)","description":"Ingredient shares of fills and spend for one payer segment, with the\nmedian generic NADAC per unit beside what MEPS respondents' payers paid\nper unit. Answers \"what does a commercially insured population actually\nfill, and what is it paying against acquisition cost.","operationId":"rx_meps_mix_v1_rx_meps_mix_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2018},{"type":"null"}],"description":"Survey year; defaults to the latest loaded","title":"Year"},"description":"Survey year; defaults to the latest loaded"},{"name":"segment","in":"query","required":false,"schema":{"type":"string","description":"One of: private_under_65, private_65_plus, public_only, uninsured","default":"private_under_65","title":"Segment"},"description":"One of: private_under_65, private_65_plus, public_only, uninsured"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient name (partial match)","title":"Q"},"description":"Ingredient name (partial match)"},{"name":"min_sample","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Minimum unweighted fills in the sample","default":20,"title":"Min Sample"},"description":"Minimum unweighted fills in the sample"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"spend, fills, or paid_per_unit","default":"spend","title":"Sort"},"description":"spend, fills, or paid_per_unit"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/pharmacies":{"get":{"tags":["Drug Economics"],"summary":"Pharmacies from NPPES with type, chain flag, metro, and county","operationId":"rx_pharmacies_v1_rx_pharmacies_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pharmacy name (partial match)","title":"Q"},"description":"Pharmacy name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"zip5","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":5,"maxLength":5},{"type":"null"}],"title":"Zip5"}},{"name":"county_fips","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":5,"maxLength":5},{"type":"null"}],"title":"County Fips"}},{"name":"cbsa","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cbsa"}},{"name":"pharmacy_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: community_retail, clinic, compounding, home_infusion, institutional, long_term_care, mail_order, managed_care, nuclear, specialty, pharmacy","title":"Pharmacy Type"},"description":"One of: community_retail, clinic, compounding, home_infusion, institutional, long_term_care, mail_order, managed_care, nuclear, specialty, pharmacy"},{"name":"chain","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for chains, false for independents","title":"Chain"},"description":"true for chains, false for independents"},{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Active"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/pharmacies/access":{"get":{"tags":["Drug Economics"],"summary":"Pharmacy access by county: retail pharmacies per 10K residents beside SVI","description":"The pharmacy-desert table: every county with its active retail pharmacy\nstorefronts, independents versus chains, and the CDC Social Vulnerability\nIndex, uninsured rate, and no-vehicle rate. min_population defaults to\n10,000; pass 0 for all 3,144 counties.","operationId":"rx_pharmacy_access_v1_rx_pharmacies_access_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"min_population","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":10000,"title":"Min Population"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"retail_per_10k (fewest first), svi, independents","default":"retail_per_10k","title":"Sort"},"description":"retail_per_10k (fewest first), svi, independents"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/demand":{"get":{"tags":["Drug Economics"],"summary":"Part D prescribing volume for a generic by state, metro, or county","operationId":"rx_demand_v1_rx_demand_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"generic","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"Generic name (partial match), e.g. atorvastatin","title":"Generic"},"description":"Generic name (partial match), e.g. atorvastatin"},{"name":"level","in":"query","required":false,"schema":{"type":"string","description":"state, cbsa, or county","default":"cbsa","title":"Level"},"description":"state, cbsa, or county"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"Restrict county rows to one state","title":"State"},"description":"Restrict county rows to one state"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/asp":{"get":{"tags":["Drug Economics"],"summary":"Medicare Part B ASP payment limits by HCPCS code (quarterly)","operationId":"rx_asp_v1_rx_asp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Short description (partial match), e.g. ustekinumab. Public HCPCS Level II rows only: a CPT descriptor is not served or searched","title":"Q"},"description":"Short description (partial match), e.g. ustekinumab. Public HCPCS Level II rows only: a CPT descriptor is not served or searched"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HCPCS code, e.g. J3357","title":"Hcpcs"},"description":"HCPCS code, e.g. J3357"},{"name":"ndc","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit NDC; resolves to its HCPCS through the crosswalk","title":"Ndc"},"description":"11-digit NDC; resolves to its HCPCS through the crosswalk"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter start date YYYY-MM-DD; defaults to the latest final quarter","title":"Quarter"},"description":"Quarter start date YYYY-MM-DD; defaults to the latest final quarter"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/biosimilars":{"get":{"tags":["Drug Economics"],"summary":"Purple Book biosimilars beside the reference product's ASP and Cost Plus price","operationId":"rx_biosimilars_v1_rx_biosimilars_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"molecule","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proper name (partial match), e.g. ustekinumab","title":"Molecule"},"description":"Proper name (partial match), e.g. ustekinumab"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":200,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/employers":{"get":{"tags":["Drug Economics"],"summary":"Employer health plans (DOL 5500) with funding class, PBM, and drug-coverage carriers","description":"One row per health-plan filing. The default sort is active participants,\nlargest first, which makes the unfiltered call a ranked target list.","operationId":"rx_employers_v1_rx_employers_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor or plan name (partial match)","title":"Q"},"description":"Sponsor or plan name (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"funding_class","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: self_funded_only, self_funded_plus_insurance, insured_only, unspecified","title":"Funding Class"},"description":"One of: self_funded_only, self_funded_plus_insurance, insured_only, unspecified"},{"name":"pbm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"PBM family (partial match), e.g. Optum","title":"Pbm"},"description":"PBM family (partial match), e.g. Optum"},{"name":"min_participants","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum active participants","title":"Min Participants"},"description":"Minimum active participants"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year (tax_period_end year)","title":"Year"},"description":"Plan year (tax_period_end year)"},{"name":"with_pbm_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only plans that name a PBM on Schedule C","default":false,"title":"With Pbm Only"},"description":"Only plans that name a PBM on Schedule C"},{"name":"cbsa","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA code of the sponsor's ZIP, e.g. 34980 (Nashville)","title":"Cbsa"},"description":"CBSA code of the sponsor's ZIP, e.g. 34980 (Nashville)"},{"name":"metro","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CBSA title (partial match), e.g. Nashville","title":"Metro"},"description":"CBSA title (partial match), e.g. Nashville"},{"name":"integration","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"same_parent, blues_affiliated, or different","title":"Integration"},"description":"same_parent, blues_affiliated, or different"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/employers/metros":{"get":{"tags":["Drug Economics"],"summary":"Self-funded health plans by metro: plans, covered employees, PBM share","description":"The employer channel on a map: every Core-Based Statistical Area ranked by\nself-funded covered employees, with the PBMs most often named there.","operationId":"rx_employer_metros_v1_rx_employers_metros_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the fullest loaded","title":"Year"},"description":"Plan year; defaults to the fullest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}},{"name":"min_participants","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Only plans with at least this many active participants","default":0,"title":"Min Participants"},"description":"Only plans with at least this many active participants"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/employers/integration":{"get":{"tags":["Drug Economics"],"summary":"Self-funded plans that buy pharmacy and medical from one conglomerate","description":"Counts, covered employees, and disclosed PBM fees by integration class\n(same_parent, blues_affiliated, different, unclassified), the same by\nparent company, and the 25 largest same-parent plans.","operationId":"rx_employer_integration_v1_rx_employers_integration_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the fullest loaded","title":"Year"},"description":"Plan year; defaults to the fullest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/employers/{ein}":{"get":{"tags":["Drug Economics"],"summary":"One employer: health-plan filings, every paid service provider, insurance contracts","operationId":"rx_employer_v1_rx_employers__ein__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ein","in":"path","required":true,"schema":{"type":"string","description":"Plan sponsor EIN, digits only","title":"Ein"},"description":"Plan sponsor EIN, digits only"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/pbms":{"get":{"tags":["Drug Economics"],"summary":"PBM market rollup from Schedule C: plans, covered participants, disclosed fees","operationId":"rx_pbms_v1_rx_pbms_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2030,"minimum":2015},{"type":"null"}],"description":"Plan year; defaults to the latest loaded","title":"Year"},"description":"Plan year; defaults to the latest loaded"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"title":"State"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/orange-book":{"get":{"tags":["Drug Economics"],"summary":"FDA Orange Book approved products with therapeutic equivalence codes","description":"Every product in the FDA Orange Book: brand and generic applications, their\napplicant, strength, therapeutic equivalence code, and approval date.","operationId":"rx_orange_book_v1_rx_orange_book_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trade name or ingredient (partial match)","title":"Q"},"description":"Trade name or ingredient (partial match)"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient (partial match), e.g. semaglutide","title":"Ingredient"},"description":"Ingredient (partial match), e.g. semaglutide"},{"name":"appl_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"N for brand (NDA), A for generic (ANDA)","title":"Appl Type"},"description":"N for brand (NDA), A for generic (ANDA)"},{"name":"product_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"RX, OTC, or DISCN (discontinued)","title":"Product Type"},"description":"RX, OTC, or DISCN (discontinued)"},{"name":"te_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Therapeutic equivalence code, e.g. AB","title":"Te Code"},"description":"Therapeutic equivalence code, e.g. AB"},{"name":"applicant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Applicant name (partial match)","title":"Applicant"},"description":"Applicant name (partial match)"},{"name":"rld","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for reference listed drugs only","title":"Rld"},"description":"true for reference listed drugs only"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/orange-book/launch-radar":{"get":{"tags":["Drug Economics"],"summary":"Brand drugs with no approved generic, by the date protection ends","description":"Brand prescription products with no approved generic of the same ingredient,\ndosage form, and strength, ordered by the earliest date a generic could launch on\npaper. Products with nothing listed sort first: no barrier is on record.","operationId":"rx_generic_launch_radar_v1_rx_orange_book_launch_radar_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient (partial match)","title":"Ingredient"},"description":"Ingredient (partial match)"},{"name":"applicant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Applicant name (partial match)","title":"Applicant"},"description":"Applicant name (partial match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Protection ends before this date (YYYY-MM-DD)","title":"Before"},"description":"Protection ends before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Protection ends on or after this date (YYYY-MM-DD)","title":"After"},"description":"Protection ends on or after this date (YYYY-MM-DD)"},{"name":"unprotected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for products with no listed patent or exclusivity","title":"Unprotected"},"description":"true for products with no listed patent or exclusivity"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/establishments":{"get":{"tags":["Drug Economics"],"summary":"FDA-registered drug establishments worldwide, filterable by operation, country, and firm","description":"Every drug establishment registered with the FDA (DECRS), with its FEI number,\nfirm name, country, and registered operations. operation=API MANUFACTURE isolates the\nplants that make an active ingredient, the supply-side view behind a drug shortage.","operationId":"rx_establishments_v1_rx_establishments_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"operation","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered operation, e.g. API MANUFACTURE, MANUFACTURE, ANALYSIS, PACK, LABEL, STERILIZE","title":"Operation"},"description":"Registered operation, e.g. API MANUFACTURE, MANUFACTURE, ANALYSIS, PACK, LABEL, STERILIZE"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}],"description":"ISO-3 country code, e.g. USA, CHN, IND","title":"Country"},"description":"ISO-3 country code, e.g. USA, CHN, IND"},{"name":"firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Firm or registrant name (partial match)","title":"Firm"},"description":"Firm or registrant name (partial match)"},{"name":"exclusion","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true for establishments flagged excluded from registration","title":"Exclusion"},"description":"true for establishments flagged excluded from registration"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/establishments/operations":{"get":{"tags":["Drug Economics"],"summary":"Distinct establishment operations with counts (the operation filter values)","description":"The 15 registered operation types with how many establishments hold each,\nmost common first. Use these exact values for the operation filter.","operationId":"rx_establishment_operations_v1_rx_establishments_operations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/rx/recalls":{"get":{"tags":["Drug Economics"],"summary":"FDA drug recalls (openFDA enforcement), NDC-matched","description":"Drug recall enforcement reports with classification, status, recalling firm, reason,\ndistribution pattern, and dates. NDCs are extracted from the openFDA block and the\nfree-text product description and code info, then matched to the current NDC directory;\nthe response's match_stats and methodology_note report the match rate.","operationId":"rx_recalls_v1_rx_recalls_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit NDC (5-4-2, no dashes); matches recalls that cite it","title":"Ndc"},"description":"11-digit NDC (5-4-2, no dashes); matches recalls that cite it"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ingredient, generic, or substance name (partial match)","title":"Ingredient"},"description":"Ingredient, generic, or substance name (partial match)"},{"name":"firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Recalling firm (partial match)","title":"Firm"},"description":"Recalling firm (partial match)"},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: Class I, Class II, Class III (or I, II, III)","title":"Classification"},"description":"One of: Class I, Class II, Class III (or I, II, III)"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: Ongoing, Completed, Terminated (prefix match)","title":"Status"},"description":"One of: Ongoing, Completed, Terminated (prefix match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Report date before this date (YYYY-MM-DD)","title":"Before"},"description":"Report date before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Report date on or after this date (YYYY-MM-DD)","title":"After"},"description":"Report date on or after this date (YYYY-MM-DD)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/drugsfda":{"get":{"tags":["Drug Economics"],"summary":"Drugs@FDA approved applications with first approval dates","description":"FDA-approved drug applications (NDA, ANDA, BLA) with their sponsor, products,\ningredients, first and latest approval dates, and submission and product counts.\nOrdered by first approval date, most recent first. Use GET /rx/drugsfda/{appl_no}\nfor the full product list and submission history.","operationId":"rx_drugsfda_v1_rx_drugsfda_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor, drug name, or active ingredient (partial match)","title":"Q"},"description":"Sponsor, drug name, or active ingredient (partial match)"},{"name":"appl_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: NDA, ANDA, BLA (NDA brand, ANDA generic, BLA biologic)","title":"Appl Type"},"description":"One of: NDA, ANDA, BLA (NDA brand, ANDA generic, BLA biologic)"},{"name":"sponsor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sponsor name (partial match)","title":"Sponsor"},"description":"Sponsor name (partial match)"},{"name":"ingredient","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Active ingredient (partial match)","title":"Ingredient"},"description":"Active ingredient (partial match)"},{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Drug (brand) name (partial match)","title":"Drug"},"description":"Drug (brand) name (partial match)"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First approval before this date (YYYY-MM-DD)","title":"Before"},"description":"First approval before this date (YYYY-MM-DD)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First approval on or after this date (YYYY-MM-DD)","title":"After"},"description":"First approval on or after this date (YYYY-MM-DD)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/drugsfda/{appl_no}":{"get":{"tags":["Drug Economics"],"summary":"One Drugs@FDA application with products and full submission history","description":"One application's products (form, strength, ingredient, TE code, marketing status)\nand its complete submission history, original plus every supplement, with approval dates.","operationId":"rx_drugsfda_application_v1_rx_drugsfda__appl_no__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"appl_no","in":"path","required":true,"schema":{"type":"string","description":"Application number, digits (e.g. 021688 or 21688)","title":"Appl No"},"description":"Application number, digits (e.g. 021688 or 21688)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/labels":{"get":{"tags":["Drug Economics"],"summary":"DailyMed drug labels (official SPL), version-pinned","description":"Human prescription labels from DailyMed with set_id, version, effective date, title,\nlabeler, and which of the four key sections are present. The dailymed_url is pinned to the\nstored version. Many SPL titles are the standard highlights preamble, so search also\nmatches the labeler and the RxNorm drug name.","operationId":"rx_labels_v1_rx_labels_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title, labeler, or RxNorm drug name (partial match)","title":"Q"},"description":"Title, labeler, or RxNorm drug name (partial match)"},{"name":"drug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"RxNorm drug name (partial match)","title":"Drug"},"description":"RxNorm drug name (partial match)"},{"name":"labeler","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Labeler name (partial match)","title":"Labeler"},"description":"Labeler name (partial match)"},{"name":"section","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only labels with this section: boxed_warning, indications, dosage_administration, contraindications","title":"Section"},"description":"Only labels with this section: boxed_warning, indications, dosage_administration, contraindications"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/labels/{set_id}":{"get":{"tags":["Drug Economics"],"summary":"One DailyMed label with its key sections, RxNorm, and pharmacologic classes","description":"One label's boxed warning, indications, dosage and administration, and contraindications\nsection text, its RxNorm concepts, and its pharmacologic classes. The dailymed_url is pinned\nto the version we hold, so the citation never shows newer text than we stored.","operationId":"rx_label_v1_rx_labels__set_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"set_id","in":"path","required":true,"schema":{"type":"string","description":"DailyMed SPL set_id (GUID)","title":"Set Id"},"description":"DailyMed SPL set_id (GUID)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/drug-classes":{"get":{"tags":["Drug Economics"],"summary":"Pharmacologic classes from DailyMed with label counts","description":"Pharmacologic classes from DailyMed's official class mapping, with the number of\nhuman prescription labels in each, filterable by name and FDA class type (EPC, MoA, PE, CS).","operationId":"rx_drug_classes_v1_rx_drug_classes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Class name (partial match), e.g. HMG-CoA","title":"Q"},"description":"Class name (partial match), e.g. HMG-CoA"},{"name":"class_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: EPC, MoA, PE, CS, Chemical/Ingredient, EXT","title":"Class Type"},"description":"One of: EPC, MoA, PE, CS, Chemical/Ingredient, EXT"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/partd/plans/{contract_id}/{plan_id}/{segment_id}":{"get":{"tags":["Drug Economics"],"summary":"One Part D plan: premium, deductible, service area, and cost share by tier","description":"A Medicare Part D plan from CMS's monthly formulary public use file: premium,\ndeductible, SNP type, service area, the beneficiary cost share by tier, coverage\nlevel, days supply and pharmacy channel, and insulin cost.","operationId":"rx_partd_plan_v1_rx_partd_plans__contract_id___plan_id___segment_id__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","description":"CMS contract ID, e.g. H0028 or S1030","title":"Contract Id"},"description":"CMS contract ID, e.g. H0028 or S1030"},{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","description":"Plan ID, e.g. 007","title":"Plan Id"},"description":"Plan ID, e.g. 007"},{"name":"segment_id","in":"path","required":true,"schema":{"type":"string","description":"Segment ID, 000 for R and S contracts","title":"Segment Id"},"description":"Segment ID, 000 for R and S contracts"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/partd/plans/{contract_id}/{plan_id}/{segment_id}/drugs/{ndc11}":{"get":{"tags":["Drug Economics"],"summary":"One NDC on one Part D plan: tier, utilization rules, cost share, and unit cost","description":"Whether the plan's formulary lists the NDC, with its tier, quantity limit, prior\nauthorization and step therapy; the cost share for that tier; indication-based coverage;\nand the plan's average unit cost for a 30, 60 and 90 day supply from CMS's quarterly\npricing file.","operationId":"rx_partd_plan_drug_v1_rx_partd_plans__contract_id___plan_id___segment_id__drugs__ndc11__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","description":"CMS contract ID, e.g. H0028","title":"Contract Id"},"description":"CMS contract ID, e.g. H0028"},{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","description":"Plan ID, e.g. 007","title":"Plan Id"},"description":"Plan ID, e.g. 007"},{"name":"segment_id","in":"path","required":true,"schema":{"type":"string","description":"Segment ID, e.g. 000","title":"Segment Id"},"description":"Segment ID, e.g. 000"},{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rx/partd/drugs/{ndc11}/plans":{"get":{"tags":["Drug Economics"],"summary":"Part D plans whose formulary lists an NDC","description":"Every Part D plan whose formulary lists the NDC, lowest tier first, with prior\nauthorization, step therapy, quantity limit and the 30-day unit cost. county_code keeps\nthe plans that serve that county (local plans by county, PDPs and regional plans by region).","operationId":"rx_partd_drug_plans_v1_rx_partd_drugs__ndc11__plans_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"ndc11","in":"path","required":true,"schema":{"type":"string","description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610","title":"Ndc11"},"description":"11-digit NDC without dashes (5-4-2), e.g. 00093505610"},{"name":"contract_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2019},{"type":"null"}],"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started.","title":"Contract Year"},"description":"Contract year, e.g. 2026. Omit for the newest contract year that has started."},{"name":"county_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SSA county code (5 digits), e.g. 28100","title":"County Code"},"description":"SSA county code (5 digits), e.g. 28100"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/fee-schedules/opps/{hcpcs}":{"get":{"tags":["Medicare Fee Schedules"],"summary":"OPPS Addendum B payment rate for a HCPCS code, by quarter","description":"Hospital outpatient national payment rate for one code, per quarter:\nstatus indicator, APC, relative weight, payment rate and copayments, from\nCMS's quarterly Addendum B. National unadjusted amounts; no wage index is applied.","operationId":"opps_rates_v1_fee_schedules_opps__hcpcs__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015","title":"Hcpcs"},"description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first.","title":"Quarter"},"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/fee-schedules/asc/{hcpcs}":{"get":{"tags":["Medicare Fee Schedules"],"summary":"ASC Addendum AA payment rate for a HCPCS code, by quarter","description":"Ambulatory surgical center national payment rate for one covered\nsurgical procedure, per quarter: payment indicator, multiple procedure\ndiscount, payment weight and rate, from CMS's quarterly Addendum AA.\n`office_based` is true for indicators P2 and P3; a P3 rate is based on\nMPFS nonfacility PE RVUs (Addendum DD1). National unadjusted amounts; no\nwage index is applied.","operationId":"asc_rates_v1_fee_schedules_asc__hcpcs__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"path","required":true,"schema":{"type":"string","description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015","title":"Hcpcs"},"description":"HCPCS Level II or CPT code, five letters or digits, e.g. 22326 or J9015"},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first.","title":"Quarter"},"description":"One quarter, e.g. 2026Q4. Omit for every quarter held, newest first."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/state-regulations/md/comar/{section}":{"get":{"tags":["State Regulations"],"summary":"One Maryland COMAR section, in Verzi's plain structure, with its receipt","description":"The section's citation, heading, regulation text and stated effective\ndate (NULL when the archived page states none), parsed from the archived\npage. The receipt names the COMAR section, links its official page on\nregs.maryland.gov and carries the archived file's sha256. Covered today:\nCOMAR 10.09.12 (Disposable Medical Supplies and Durable Medical Equipment).","operationId":"comar_section_v1_state_regulations_md_comar__section__get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"section","in":"path","required":true,"schema":{"type":"string","description":"COMAR section number, e.g. 10.09.12.04","title":"Section"},"description":"COMAR section number, e.g. 10.09.12.04"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The date the section must be in force on (YYYY-MM-DD). Default today.","title":"As Of"},"description":"The date the section must be in force on (YYYY-MM-DD). Default today."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/signals":{"get":{"tags":["Construction Signals"],"summary":"Signals Search","description":"Search healthcare construction signals, newest first.\n\nA signal is a building permit, Certificate of Need / Determination of\nNeed filing, or statewide project registration classified as healthcare\nconstruction. Resolved signals carry the matched facility, health\nsystem, and an organizational contact from public NPPES data.","operationId":"signals_search_v1_signals_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search entity name and project description (partial match)","title":"Q"},"description":"Search entity name and project description (partial match)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"null"}],"description":"2-letter state code","title":"State"},"description":"2-letter state code"},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City or county (partial match)","title":"City"},"description":"City or county (partial match)"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: hospital, asc, clinic, imaging, dental, senior_care, behavioral, pharmacy_lab, other_healthcare","title":"Category"},"description":"One of: hospital, asc, clinic, imaging, dental, senior_care, behavioral, pharmacy_lab, other_healthcare"},{"name":"signal_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of: permit, con_filing, project_registration","title":"Signal Type"},"description":"One of: permit, con_filing, project_registration"},{"name":"system","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved health system name (partial match)","title":"System"},"description":"Resolved health system name (partial match)"},{"name":"min_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Minimum estimated project value in USD","title":"Min Value"},"description":"Minimum estimated project value in USD"},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":1},{"type":"null"}],"description":"Only signals from the last N days","title":"Days"},"description":"Only signals from the last N days"},{"name":"resolved_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only signals resolved to a facility/system/NPI","default":false,"title":"Resolved Only"},"description":"Only signals resolved to a facility/system/NPI"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/signals/summary":{"get":{"tags":["Construction Signals"],"summary":"Signals Summary","description":"Signal counts and estimated dollar volume by state and category.","operationId":"signals_summary_v1_signals_summary_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":3650,"minimum":1,"description":"Aggregation window in days","default":365,"title":"Days"},"description":"Aggregation window in days"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/signals/systems":{"get":{"tags":["Construction Signals"],"summary":"Signals By System","description":"Resolved signals rolled up per health system, ranked by dollar volume.","operationId":"signals_by_system_v1_signals_systems_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":3650,"minimum":1,"description":"Aggregation window in days","default":365,"title":"Days"},"description":"Aggregation window in days"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/ncci/ptp":{"get":{"tags":["Coding Rules"],"summary":"Is a code pair PTP-edited for a setting on a date of service","description":"The PTP edit for the pair and setting on the date, with its modifier\nindicator (0 not allowed, 1 allowed, 9 not applicable), or `edited:\nfalse` when none applies. The answer comes from CMS's PTP file in force\non the date: the complete quarter file for the date's quarter, named in\n`checked`. When Verzi holds no complete file for that quarter, the pair\nanswers `edited: null` with a `reason`; no other quarter's file answers\nfor it. For a date before 2022-01-01, a pair with a code that is not\npublic HCPCS Level II (such as a CPT or CDT code) also answers `edited: null`,\nwith `checked.rule` license_scope. The row's own effective and deletion\ndates gate the edit (half-open: the deletion date is the first day out\nof force). Codes are upper-cased; a value that is not five characters of\ndigits or letters, or a code paired with itself, is a 422. Cites the\narchive version, member file, and its sha256.","operationId":"ncci_ptp_v1_rules_ncci_ptp_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"setting","in":"query","required":true,"schema":{"type":"string","description":"practitioner | hospital","title":"Setting"},"description":"practitioner | hospital"},{"name":"code_a","in":"query","required":true,"schema":{"type":"string","description":"Column 1 (comprehensive) code","title":"Code A"},"description":"Column 1 (comprehensive) code"},{"name":"code_b","in":"query","required":true,"schema":{"type":"string","description":"Column 2 (component) code","title":"Code B"},"description":"Column 2 (component) code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PtpResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/ncci/mue":{"get":{"tags":["Coding Rules"],"summary":"The MUE value and MAI for a code and setting on a date of service","description":"The per-code maximum units of service and the MUE Adjudication\nIndicator (1 line, 2 date-of-service policy, 3 date-of-service clinical)\nfrom the quarter snapshot in force on the date. When the setting's table\nfor the quarter is missing or not parsed, it answers `mue_value: null` with\na `reason` instead of 404. For a date before 2022-01-01, a code that is\nnot public HCPCS Level II (such as a CPT or CDT code) also answers\n`mue_value: null` with a `reason`. Cites the version, member\nfile, and its sha256.","operationId":"ncci_mue_v1_rules_ncci_mue_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"setting","in":"query","required":true,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier"},{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MueResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/dmepos/fee":{"get":{"tags":["Coding Rules"],"summary":"The DMEPOS allowed amount, ceiling, and floor for a fee cell on a date of service","description":"The allowed amount for the fee cell keyed by HCPCS, both modifiers, and\narea, from the quarter snapshot in force on the date. Pass `state` (with\nan optional `rural` flag) for a state cell, or `cba` for a former\ncompetitive-bidding area. The code, the modifiers, and the state are\nupper-cased; a code that is not five characters of digits or letters is\na 422. An area string the fee schedule does not carry is a 422 that lists\nthe valid strings (and the nearest ones). Ceiling and floor are the file's\nown national values: CMS fills\nthem with zeros for codes adjusted using competitive bidding information\n(its README, fields 6 and 7), so 0.0 is CMS's value; they are null when\nthe file leaves them blank, for the non-continental areas, and for CBA\ncells. Cites the version, member file, and its sha256.","operationId":"dmepos_fee_v1_rules_dmepos_fee_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS code","title":"Hcpcs"},"description":"HCPCS code"},{"name":"state","in":"query","required":false,"schema":{"type":"string","description":"Two-letter state or territory, e.g. AL (state cells)","title":"State"},"description":"Two-letter state or territory, e.g. AL (state cells)"},{"name":"cba","in":"query","required":false,"schema":{"type":"string","description":"Competitive-bidding area name (CBA cells); alternative to state","title":"Cba"},"description":"Competitive-bidding area name (CBA cells); alternative to state"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column; '' when absent","default":"","title":"Modifier"},"description":"'Mod' column; '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column; '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column; '' when absent"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural cell (state cells only)","default":false,"title":"Rural"},"description":"Rural cell (state cells only)"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/provider/{npi}/standing":{"get":{"tags":["Provider Standing"],"summary":"Provider standing on a date of service (exclusion, enrollment, supplier directory), with receipts","description":"Per-fact standing for the NPI on the date of service. Each present\nanswer cites the archived version, member file, and its sha256, so the\nanswer is auditable and reproducible. The bytes are fetched through the\nexisting /archive/files/{sha256}.","operationId":"provider_standing_v1_provider__npi__standing_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","description":"10-digit NPI","title":"Npi"},"description":"10-digit NPI"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/receipt":{"get":{"tags":["Coding Rules"],"summary":"The receipt join: standing, fee cell, and edits for one code, provider, and date, each with its receipt","description":"One object per receipt, each with its fact and its receipt, or an honest\ngap state. R0 is the supplier standing; r0_ordering is the ordering\nphysician's standing, present only when ordering_npi is passed. R1 is the\nDMEPOS fee cell. R2 is the MUE (always) plus the PTP pair edit (when a\ncompanion is supplied). R3 is the served documentation-requirement set for\nthe code as of the DOS, or not_yet_available when nothing is served (spec\n§2.4). For a document with no approved coder label, R3 carries CMS's\nsections as published (section_text, marked unlabeled): an LCD's\ncoverage indications and Associated Information (where CMS states\ndocumentation requirements), and a Policy Article's text. An approved\ncoder label carries its quote as passage_text for a key with the receipt\ncapability; without it (DISABLE_AUTH dev) only one item does, marked\nsample. The payer slot defaults to medicare. payer=medicare_advantage\n(alias ma) returns the same Medicare envelope plus\nreceipts.medicare_advantage: 42 CFR 422.101(b) (the lead-in, (b)(1) to\n(b)(3), and (b)(6) with its applicability as CMS-4201-F states it) and the\nSubpart M appeal path, each quoted from the version in force on the DOS\nwith a receipt per quote, or an honest gap with a reason. beneficiary_state\nadds receipts.dme_mac (the DME MAC for the state on the DOS and that MAC's\nplace-of-service lines, quoted; which codes are valid stays a pending\ncoder label). r0.ptan_on_dos states that no held source gives the\nsupplier's PTAN dates. receipts.icd10_lists carries the covered and non-covered ICD-10-CM codes,\nCMS's descriptions and group paragraphs, of each Policy Article mapped to\nthe code, from the Article version in force on the DOS, paged by\nicd10_offset and icd10_limit; the Article's HCPCS tables are not served.\nNever a CPT descriptor.\n\nEvery block carries `crosswalk`, a Verzi Health label beside CMS's\ntext: {initial_claim, claim_denial, claim_items, denials, priority}, the\nclaim items and the Verzi denial ids (each with its outcome: returned,\ndenied, or check) the block answers. r0, r0_ordering and r2 carry the\nunion of their sub-blocks' labels; each sub-block carries its own. The\nfilters use, claim_item and denial keep only the blocks whose label\nmatches all of them; meta.filtered_out names every block left out\n(empty when none was). An unknown claim item or denial id is a 422.\n\nclaim_type (default dmepos) or claim_format names the claim type the\nreceipt is for; meta.claim_type, meta.claim_format and\nmeta.claim_type_status say which and how far it is filled. Only dmepos\nis served: any other claim type answers not_started with a reason and\nno receipts (never DME rules in its place), and claim_format=professional\nserves the dmepos blocks with status partial and the other professional\nclaim types marked not_started in meta.claim_types. An unknown value, or\na claim_type and claim_format that disagree, is a 422.","operationId":"receipt_v1_rules_receipt_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias). Drives every receipt's as-of.","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias). Drives every receipt's as-of."},{"name":"npi","in":"query","required":true,"schema":{"type":"string","description":"10-digit billing or supplier NPI (R0 standing)","title":"Npi"},"description":"10-digit billing or supplier NPI (R0 standing)"},{"name":"ordering_npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"10-digit ordering physician NPI; adds a second R0 standing block","title":"Ordering Npi"},"description":"10-digit ordering physician NPI; adds a second R0 standing block"},{"name":"payer","in":"query","required":false,"schema":{"type":"string","description":"medicare (default) | medicare_advantage (alias ma): the same Medicare receipts plus receipts.medicare_advantage, 42 CFR 422.101(b) and the Subpart M appeal path as of the DOS. Other values return the payer block as not_yet_available","default":"medicare","title":"Payer"},"description":"medicare (default) | medicare_advantage (alias ma): the same Medicare receipts plus receipts.medicare_advantage, 42 CFR 422.101(b) and the Subpart M appeal path as of the DOS. Other values return the payer block as not_yet_available"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized).","title":"State"},"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)."},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to R2","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to R2"},{"name":"beneficiary_state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state or territory where the beneficiary lives (no other beneficiary data). Adds receipts.dme_mac: the DME MAC jurisdiction and contractor CMS's Who are the MACs page names for the state, from the version in force on the DOS, and the place-of-service lines that MAC publishes, quoted from the versions in force on the DOS. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)","title":"Beneficiary State"},"description":"Two-letter state or territory where the beneficiary lives (no other beneficiary data). Adds receipts.dme_mac: the DME MAC jurisdiction and contractor CMS's Who are the MACs page names for the state, from the version in force on the DOS, and the place-of-service lines that MAC publishes, quoted from the versions in force on the DOS. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)"},{"name":"use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"initial_claim (needed to fill the claim before it is sent) | claim_denial (needed to answer a denial). Keeps the blocks whose crosswalk label has the flag; meta.filtered_out names the rest","title":"Use"},"description":"initial_claim (needed to fill the claim before it is sent) | claim_denial (needed to answer a denial). Keeps the blocks whose crosswalk label has the flag; meta.filtered_out names the rest"},{"name":"claim_item","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A CMS-1500 item (such as 24B), attachment id (att_abn) or electronic data id (e_utn): keeps the blocks whose crosswalk label names it","title":"Claim Item"},"description":"A CMS-1500 item (such as 24B), attachment id (att_abn) or electronic data id (e_utn): keeps the blocks whose crosswalk label names it"},{"name":"denial","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A Verzi denial id, D1 to D47 (such as D25): keeps the blocks whose crosswalk label names it; meta.denial gives the row and its outcome (returned or denied)","title":"Denial"},"description":"A Verzi denial id, D1 to D47 (such as D25): keeps the blocks whose crosswalk label names it; meta.denial gives the row and its outcome (returned or denied)"},{"name":"icd10_offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"receipts.icd10_lists: the first ICD-10-CM code row to serve in each Article code list (paging; each list states codes_total and next_offset)","default":0,"title":"Icd10 Offset"},"description":"receipts.icd10_lists: the first ICD-10-CM code row to serve in each Article code list (paging; each list states codes_total and next_offset)"},{"name":"icd10_limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"receipts.icd10_lists: the most ICD-10-CM code rows to serve per Article code list; the list says so when more remain (next_offset)","default":500,"title":"Icd10 Limit"},"description":"receipts.icd10_lists: the most ICD-10-CM code rows to serve per Article code list; the list says so when more remain (next_offset)"},{"name":"claim_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format","title":"Claim Type"},"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format"},{"name":"claim_format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree","title":"Claim Format"},"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/claim-fields":{"get":{"tags":["Coding Rules"],"summary":"The claim field map on a date of service: every CMS-1500 item, attachment and electronic datum, who fills it, and the rule that decides it","description":"Every row of the claim field map in force on the DOS: the CMS-1500\nitems 1 to 33, then the claim attachments and the electronic claim data\nwhose DOS range holds the DOS (CMNs and DIFs only before 2023-01-01; an\nattachment names the form edition in force, such as the ABN's). Each row\nhas item, field, filled_by, the initial_claim and claim_denial flags,\npriority, status, the Verzi denial ids it triggers (with outcome), and\nrule: the crosswalk's source pointer and status, and the receipt blocks\nthat serve the rule. The blocks the rows name that need only the code\nand the DOS (today R2 with its MUE, R3, code, prior_authorization read\nwith no state, timely_filing and rule_passages) are built by the\nreceipt's own readers and quoted under `receipts` with their own\nreceipts; blocks that need an NPI, a fee area, a modifier or a\nbeneficiary state are named in\nrule.served_by_receipt (from /rules/receipt).\nThe map, pointers, statuses and priorities are Verzi Health labels, not\nCMS text. It takes no field values: no beneficiary or claim data.\nclaim_type (default dmepos) or claim_format works as on /rules/receipt:\na claim type that is not started answers not_started with a reason and\nno fields, and meta names the claim type.","operationId":"claim_fields_v1_rules_claim_fields_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS code; the receipt blocks that serve a field's rule are built for it","title":"Hcpcs"},"description":"HCPCS code; the receipt blocks that serve a field's rule are built for it"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)"},{"name":"use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"initial_claim (needed to fill the claim) | claim_denial (needed to answer a denial); filtered_out names the rows left out","title":"Use"},"description":"initial_claim (needed to fill the claim) | claim_denial (needed to answer a denial); filtered_out names the rows left out"},{"name":"claim_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format","title":"Claim Type"},"description":"The claim type the answer is for, one of: dmepos, practitioner, independent_lab, ambulance, asc, inpatient, outpatient, snf, home_health, hospice, esrd, rhc_fqhc, corf, orf, cmhc, dental, pharmacy. Default dmepos, the only claim type filled today. Any other claim type answers meta.claim_type_status not_started with a reason and no blocks; it never gets DME rules. meta names the claim type and its claim_format"},{"name":"claim_format","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree","title":"Claim Format"},"description":"professional | institutional | dental | pharmacy: every claim type with that format in the payer scope's table. professional serves the dmepos blocks with meta.claim_type_status partial, and meta.claim_types marks the other professional claim types not_started. Pass with claim_type only when the two agree"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimFieldsResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/receipt/appeal":{"get":{"tags":["Coding Rules"],"summary":"The appeal-ready export: a receipt answer plus its receipts, assembled into a Medicare redetermination exhibit (or a Medicare Advantage reconsideration exhibit)","description":"Assemble a redetermination exhibit from the receipt envelope. It reuses\nthe receipt join (no new authority logic) and renders the exhibit over it.\nReturns a structured appeal_exhibit plus a plain rendered text draft, or a\nno_exhibit status when nothing citable is present (fail closed, design §3).\ndenial_code, when supplied, is echoed into the exhibit as context; when\nabsent, its key is omitted. payer=medicare_advantage (alias ma) frames the\nexhibit as a request to the MA organization for reconsideration and adds\nthe 42 CFR 422.101(b) and Subpart M quotes from receipts.medicare_advantage\nbeside a code-specific exhibit (never alone). This is not legal advice: the\ndraft states the evidence and the filer completes and files it.","operationId":"receipt_appeal_v1_rules_receipt_appeal_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"dos","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Date of service, YYYY-MM-DD; alias of as_of. The claim's date, argued against the policy in force then.","title":"Dos"},"description":"Date of service, YYYY-MM-DD; alias of as_of. The claim's date, argued against the policy in force then."},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias).","title":"As Of"},"description":"The as-of date, YYYY-MM-DD; canonical name (dos is the alias)."},{"name":"npi","in":"query","required":true,"schema":{"type":"string","description":"10-digit billing or supplier NPI (R0 standing)","title":"Npi"},"description":"10-digit billing or supplier NPI (R0 standing)"},{"name":"ordering_npi","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"10-digit ordering physician NPI; adds a second R0 standing block","title":"Ordering Npi"},"description":"10-digit ordering physician NPI; adds a second R0 standing block"},{"name":"payer","in":"query","required":false,"schema":{"type":"string","description":"medicare (default): a Medicare redetermination exhibit | medicare_advantage (alias ma): a Medicare Advantage reconsideration exhibit that adds the 42 CFR 422.101(b) and Subpart M quotes beside the code's exhibit","default":"medicare","title":"Payer"},"description":"medicare (default): a Medicare redetermination exhibit | medicare_advantage (alias ma): a Medicare Advantage reconsideration exhibit that adds the 42 CFR 422.101(b) and Subpart M quotes beside the code's exhibit"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized).","title":"State"},"description":"Two-letter state for the R1 fee cell; pass exactly one of state or cba. It also scopes the prior_authorization block: the list's state-limited phases are read against it. A code that is not a state, DC, or territory gives that block not_determinable (state_not_recognized)."},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell; pass exactly one of state or cba"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; also checked in receipts.modifiers (valid on the DOS); '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to R2","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to R2"},{"name":"denial_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CARC/RARC denial code; optional passthrough echoed into the exhibit as context","title":"Denial Code"},"description":"CARC/RARC denial code; optional passthrough echoed into the exhibit as context"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppealResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/receipt/changes":{"get":{"tags":["Coding Rules"],"summary":"The change-timeline receipt: what moved in the policy for a code between two dates of service","description":"Diff the policy receipt for the code between two dates of service: per\nblock (R1 fee, R2 MUE and PTP, R3 requirements, refill applicability) the\nsnapshot at each date and whether it changed, plus R3's requirement-level\nadded/removed. Each side keeps its own receipt. `any_change` is the headline\nfor an appeal that turns on whether the policy moved since the claim's DOS.\nPass `state` or `cba` to include the fee-cell diff; `companion` to include\nthe PTP pair.","operationId":"receipt_changes_v1_rules_receipt_changes_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"hcpcs","in":"query","required":true,"schema":{"type":"string","description":"HCPCS/CPT code","title":"Hcpcs"},"description":"HCPCS/CPT code"},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The earlier date of service, YYYY-MM-DD (e.g. the claim's DOS)","title":"From"},"description":"The earlier date of service, YYYY-MM-DD (e.g. the claim's DOS)"},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The later date of service, YYYY-MM-DD (e.g. today)","title":"To"},"description":"The later date of service, YYYY-MM-DD (e.g. today)"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state for the R1 fee cell; pass state or cba to include the fee diff","title":"State"},"description":"Two-letter state for the R1 fee cell; pass state or cba to include the fee diff"},{"name":"cba","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Competitive-bidding area name for the R1 fee cell","title":"Cba"},"description":"Competitive-bidding area name for the R1 fee cell"},{"name":"rural","in":"query","required":false,"schema":{"type":"boolean","description":"Rural fee cell (state cells only)","default":false,"title":"Rural"},"description":"Rural fee cell (state cells only)"},{"name":"modifier","in":"query","required":false,"schema":{"type":"string","description":"'Mod' column for the R1 fee cell; '' when absent","default":"","title":"Modifier"},"description":"'Mod' column for the R1 fee cell; '' when absent"},{"name":"modifier2","in":"query","required":false,"schema":{"type":"string","description":"'Mod2' column for the R1 fee cell; '' when absent","default":"","title":"Modifier2"},"description":"'Mod2' column for the R1 fee cell; '' when absent"},{"name":"setting","in":"query","required":false,"schema":{"type":"string","description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)","default":"dme_supplier","title":"Setting"},"description":"practitioner | outpatient_hospital | dme_supplier (R2 edits)"},{"name":"companion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second HCPCS code; adds the PTP pair edit to the diff","title":"Companion"},"description":"A second HCPCS code; adds the PTP pair edit to the diff"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesResponse"}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rules/receipt/signing-key":{"get":{"tags":["Coding Rules"],"summary":"The Ed25519 public key that signs receipt attestations, for offline verification","description":"Return the public key, key id, and verification recipe for the receipt\nattestations. Unauthenticated: a public key is public, and a payer or auditor\nverifying a filed receipt must reach it without an API key. Returns 404 when\nsigning is not enabled in this deployment (local dev).","operationId":"receipt_signing_key_v1_rules_receipt_signing_key_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyResponse"}}}}},"security":[]}},"/v1/receipt/r3/pending":{"get":{"tags":["Coding Rules"],"summary":"R3 read seam: requirement rows awaiting an approval decision, each with its span and source citation","description":"The rows awaiting a decision: grounded and either pending, or approved\nonce and now re-review (the content moved, spec §3.4). Each item carries the\nrequirement content, the span, the source citation, and the current\ncontent_hash. The admin queue renders from this and echoes content_hash as\nseen_hash on a decision. Paged: the response carries `total` (the full\npending count for the filter), so the client pages with `offset` until it\nhas them all. A review queue must never silently cap. Pass `hcpcs` to work a\nsingle code (the queue is ordered by arrival, not code, so one code's rows\ncan otherwise sit past a page boundary).","operationId":"r3_pending_v1_receipt_r3_pending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum rows to return per page","default":200,"title":"Limit"},"description":"Maximum rows to return per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip, for paging through the full queue","default":0,"title":"Offset"},"description":"Rows to skip, for paging through the full queue"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter the queue to one HCPCS code, so a reviewer can work it end to end","title":"Hcpcs"},"description":"Filter the queue to one HCPCS code, so a reviewer can work it end to end"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/{requirement_id}/decision":{"post":{"tags":["Coding Rules"],"summary":"R3 write seam: apply a named human's approve/reject/needs_changes decision (409 if the content moved)","description":"Write the approval columns for one requirement. status must be one of\napproved | rejected | needs_changes. On approve, approved_hash is set to\ncontent_hash. Returns 404 when there is no such requirement, and 409 when\nseen_hash != content_hash (the content moved under the reviewer, spec §6.1);\non a 409 nothing is written.","operationId":"r3_decision_v1_receipt_r3__requirement_id__decision_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"requirement_id","in":"path","required":true,"schema":{"type":"integer","title":"Requirement Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3Decision"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/labels/pending":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label read seam: labels awaiting an approval decision, each with its verbatim quote and context","description":"The passage-layer labels awaiting a decision (migration 128,\ndocs/VERBATIM_DECISION.md): pending, or approved once and now re-review\n(the content moved). Each item carries the label, the VERBATIM quote\nwith surrounding context from the pinned rendering, the section\ncitation, and the content_hash the portal echoes back as seen_hash.\nBy default only labels on the version in force today are listed;\nin_force_total and superseded_total give both counts, and scope lists\nthe others. Same contract as /receipt/r3/pending. Ordered by the\nautomated cross-check's review bucket (disagree, then the double-checked\ntier, then the rest; migration 229); a double-checked label is still\npending and only a coder's decision approves it.","operationId":"r3_labels_pending_v1_receipt_r3_labels_pending_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum rows to return per page","default":200,"title":"Limit"},"description":"Maximum rows to return per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Rows to skip, for paging through the full queue","default":0,"title":"Offset"},"description":"Rows to skip, for paging through the full queue"},{"name":"hcpcs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter the queue to one HCPCS code","title":"Hcpcs"},"description":"Filter the queue to one HCPCS code"},{"name":"scope","in":"query","required":false,"schema":{"type":"string","pattern":"^(in_force|superseded|all)$","description":"in_force: labels on the version in force today (default); superseded: labels on a version not in force today (older or upcoming); all: both","default":"in_force","title":"Scope"},"description":"in_force: labels on the version in force today (default); superseded: labels on a version not in force today (older or upcoming); all: both"},{"name":"bucket","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(disagree|tier|rest)$"},{"type":"null"}],"description":"The automated cross-check's review bucket: disagree (reviews disagreed, unsure, or a rule flag), tier (double-checked, awaiting coder), rest. Omit for all","title":"Bucket"},"description":"The automated cross-check's review bucket: disagree (reviews disagreed, unsure, or a rule flag), tier (double-checked, awaiting coder), rest. Omit for all"},{"name":"run","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Only labels from this check run","title":"Run"},"description":"Only labels from this check run"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/labels/counts":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label counts per HCPCS code: pending, approved, rejected","description":"Per-code counts for the label review queue. pending uses the same rule\nas /receipt/r3/labels/pending (includes re-review); approved counts labels whose\napproval still pins the current content.","operationId":"r3_label_counts_v1_receipt_r3_labels_counts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/receipt/r3/labels/{label_id}/decision":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: apply a named human's decision (409 if the content moved)","description":"Write the approval columns for one label. Same 409 rule as the\nrequirement seam: a seen_hash mismatch writes nothing.","operationId":"r3_label_decision_v1_receipt_r3_labels__label_id__decision_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3Decision"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/labels/{label_id}/extend":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: extend an approved label on the same words to this pending label's codes (409 if either moved)","description":"One coder action: the pending label's codes join the approved label\n(w3_label_code) and the pending label is merged into it. The approved\nlabel's approval and content never change. Same 409 rules as the\ndecision seam; not_extendable when either label left the state the\nreviewer saw.","operationId":"r3_label_extend_v1_receipt_r3_labels__label_id__extend_post","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3LabelExtend"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/labels/batch-pool":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label batch sign-off: one double-checked group's pool, the sample size the rule asks for, and the sample","description":"Every live double-checked label of the run in the group, the sample\nsize (zero defects in a random sample shows the group's defect rate is\nunder 5% with 95% confidence, hypergeometric), the sample (drawn the same\nway every time for the same pool), and each sampled label with its quote\nfor the certified coder's own decision. Reads only.","operationId":"r3_label_batch_pool_v1_receipt_r3_labels_batch_pool_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"run","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The automated check run","title":"Run"},"description":"The automated check run"},{"name":"codes","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"Comma-separated codes; a pool label applies to one of them","title":"Codes"},"description":"Comma-separated codes; a pool label applies to one of them"},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"Comma-separated label kinds","title":"Kinds"},"description":"Comma-separated label kinds"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt/r3/labels/batch-signoff":{"post":{"tags":["Coding Rules"],"summary":"R3 passage-label write seam: a coder signs off a sampled double-checked group (audit recorded)","description":"Records the audit and approves the un-sampled pool members only when\nevery sampled label was approved by the coder and the coder confirms\n(label_tier.batch_signoff). 422 when refused: nothing is written then.","operationId":"r3_label_batch_signoff_v1_receipt_r3_labels_batch_signoff_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3BatchSignoff"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/v1/receipt/r3/labels/{label_id}/claim-refs":{"get":{"tags":["Coding Rules"],"summary":"R3 passage-label claim refs: the denial ids and claim items one label answers","description":"The label's denial_ids and claim_items (migration 228), who set them\nand when, and its approval_status and content_hash.","operationId":"r3_label_claim_refs_v1_receipt_r3_labels__label_id__claim_refs_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Coding Rules"],"summary":"R3 passage-label claim refs write seam: set the denial ids and claim items one label answers (409 if the content moved)","description":"Set denial_ids and/or claim_items on one label. Metadata only: the\napproval columns are never written, so this never approves a label and\nnever drops one to pending. 422 for a bad id or item; 409 when seen_hash\ndiffers from content_hash or the label was merged; nothing is written\nthen.","operationId":"r3_label_set_claim_refs_v1_receipt_r3_labels__label_id__claim_refs_put","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"label_id","in":"path","required":true,"schema":{"type":"integer","title":"Label Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/R3LabelClaimRefs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/source-proof":{"get":{"tags":["Coding Rules"],"summary":"Source proof: resolve a citation to the cited passage in the archived rendering","description":"Resolve a receipt citation to the exact passage in the archived\nrendering. Give render_sha256 (preferred), OR doc_id + version_id, plus the\nspan (start, end).\n\nWith Accept: text/html this returns a page that shows the passage\nhighlighted. Otherwise it returns the JSON receipt. An unknown citation\nanswers 404; a resolving citation whose span misses answers 200 with\nfound=false. The receipt shows the archived rendering identified by\nrender_sha256, not the live document.","operationId":"source_proof_v1_source_proof_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"render_sha256","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rendering hash from the citation (preferred)","title":"Render Sha256"},"description":"The rendering hash from the citation (preferred)"},{"name":"doc_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The citation's document (use with version_id when render_sha256 is absent)","title":"Doc Id"},"description":"The citation's document (use with version_id when render_sha256 is absent)"},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The citation's version (use with doc_id)","title":"Version Id"},"description":"The citation's version (use with doc_id)"},{"name":"start","in":"query","required":true,"schema":{"type":"integer","description":"Span start offset into the rendering","title":"Start"},"description":"Span start offset into the rendering"},{"name":"end","in":"query","required":true,"schema":{"type":"integer","description":"Span end offset into the rendering","title":"End"},"description":"Span end offset into the rendering"},{"name":"accept","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accept"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"402":{"description":"Requires a paid plan or granted entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","example":"capability_required"},"capability":{"type":"string","example":"receipt"},"message":{"type":"string"},"upgrade":{"type":"string","format":"uri"}}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/subscriptions":{"post":{"tags":["Change Subscriptions"],"summary":"Subscribe to the change feed (email digest or signed webhook)","description":"Email: public, double opt-in. The response is the same whether or\nnot the address already subscribes; the confirmation email carries the\nlink. Webhook: needs an API key; the response carries the HMAC secret\nonce, and never again.","operationId":"create_subscription_v1_subscriptions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{},{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/billing/checkout":{"get":{"tags":["Billing"],"summary":"Create Checkout Session","description":"Create a Stripe Checkout session for a paid tier.","operationId":"create_checkout_session_billing_checkout_get","security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}],"parameters":[{"name":"tier","in":"query","required":false,"schema":{"type":"string","pattern":"^(starter|pro)$","description":"Tier to subscribe to. Free is self-serve at /signup; Enterprise is contact-sales.","default":"pro","title":"Tier"},"description":"Tier to subscribe to. Free is self-serve at /signup; Enterprise is contact-sales."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/billing/portal":{"get":{"tags":["Billing"],"summary":"Create Portal Session","description":"Create a Stripe Customer Portal session for managing subscription.","operationId":"create_portal_session_billing_portal_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/billing/status":{"get":{"tags":["Billing"],"summary":"Billing Status","description":"Get current billing status for the authenticated user's organization.","operationId":"billing_status_billing_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyHeader":[]},{"BearerApiKey":[]}]}},"/auth/send-otp":{"post":{"tags":["Dashboard Auth"],"summary":"Send Otp","description":"Email a 6-digit code to an existing, active, approved user. The reply\nis the same for every email, and nothing is ever created.","operationId":"send_otp_auth_send_otp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendOTPRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/auth/verify-otp":{"post":{"tags":["Dashboard Auth"],"summary":"Verify Otp Endpoint","description":"Verify the code and return a 14-day session token. Refuses a user who\nis not active and approved, with the same answer as a wrong code.","operationId":"verify_otp_endpoint_auth_verify_otp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOTPRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/auth/me":{"get":{"tags":["Dashboard Auth"],"summary":"Get Me","description":"Current user from the session token in the X-Dashboard-Session header.","operationId":"get_me_auth_me_get","parameters":[{"name":"X-Dashboard-Session","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Dashboard-Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/auth/logout":{"post":{"tags":["Dashboard Auth"],"summary":"Logout","description":"End the session named in the X-Dashboard-Session header.","operationId":"logout_auth_logout_post","parameters":[{"name":"X-Dashboard-Session","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Dashboard-Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}}},"components":{"schemas":{"AppealArgument-Input":{"properties":{"shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shape"},"requirement_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Class"},"statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement"},"evidence":{"anyOf":[{"items":{"$ref":"#/components/schemas/AppealEvidence"},"type":"array"},{"type":"null"}],"title":"Evidence"}},"additionalProperties":true,"type":"object","title":"AppealArgument","description":"shape: applicability | requirements_met."},"AppealArgument-Output":{"properties":{"shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shape"},"requirement_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Class"},"statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement"},"evidence":{"anyOf":[{"items":{"$ref":"#/components/schemas/AppealEvidence"},"type":"array"},{"type":"null"}],"title":"Evidence"}},"additionalProperties":true,"type":"object","title":"AppealArgument","description":"shape: applicability | requirements_met."},"AppealEvidence":{"properties":{"authority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authority"},"version_in_force":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version In Force"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"verzi_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verzi Summary","description":"Deprecated: always null since 2026-10-16. Removed on or after 2026-12-01.","deprecated":true},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"requirement_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Kind"}},"additionalProperties":true,"type":"object","title":"AppealEvidence","description":"quote is CMS's words only (a slice of the archived rendering).\nverzi_summary is deprecated and always null (strict verbatim, 2026-10-16).\nrequirement_kind is a Verzi coder label, not CMS's words."},"AppealExcluded":{"properties":{"block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Block"},"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"additionalProperties":true,"type":"object","title":"AppealExcluded"},"AppealResponse":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"arguments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AppealArgument-Output"},"type":"array"},{"type":"null"}],"title":"Arguments"},"excluded":{"anyOf":[{"items":{"$ref":"#/components/schemas/AppealExcluded"},"type":"array"},{"type":"null"}],"title":"Excluded"},"denial_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Denial Code"},"appeal_context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appeal Context","description":"Present only for payer medicare_advantage: medicare_advantage_reconsideration (a request to the MA organization for reconsideration, not a Medicare redetermination)."},"rendered":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rendered"},"attestation":{"anyOf":[{"$ref":"#/components/schemas/Attestation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"AppealResponse","description":"GET /rules/receipt/appeal. status: ok | no_exhibit."},"ApplicabilityBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"requirement_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Class"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Code"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"applies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Applies"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"basis":{"anyOf":[{"items":{"$ref":"#/components/schemas/BasisItem"},"type":"array"},{"type":"null"}],"title":"Basis"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ApplicabilityBlock","description":"receipts.applicability. status: ok (a held CMS sentence states the\nverdict; completeness cited) | unknown (reason_code no_cms_statement_held;\napplies null) | not_yet_available."},"ApplicabilityBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"requirement_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Class"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Code"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"applies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Applies"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"basis":{"anyOf":[{"items":{"$ref":"#/components/schemas/BasisItem"},"type":"array"},{"type":"null"}],"title":"Basis"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ApplicabilityBlock","description":"receipts.applicability. status: ok (a held CMS sentence states the\nverdict; completeness cited) | unknown (reason_code no_cms_statement_held;\napplies null) | not_yet_available."},"ApplicabilityDiff-Input":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Input"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Input"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"ApplicabilityDiff","description":"changed: true or false only when both dates carry a cited verdict (a\nheld CMS sentence). Otherwise null: whether the requirement applies is not\nknown on one date. A block with no CMS statement held on either date is\nleft out of any_change."},"ApplicabilityDiff-Output":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Output"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Output"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"ApplicabilityDiff","description":"changed: true or false only when both dates carry a cited verdict (a\nheld CMS sentence). Otherwise null: whether the requirement applies is not\nknown on one date. A block with no CMS statement held on either date is\nleft out of any_change."},"AsOfRule":{"properties":{"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"version_in_force":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version In Force"}},"additionalProperties":true,"type":"object","title":"AsOfRule","description":"An as-of resolution: the rule that decided it and its boundary."},"Attestation":{"properties":{"alg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alg"},"kid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kid"},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issued At"},"canonicalization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonicalization"},"signed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed"},"public_key_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key Url"},"signature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signature"}},"additionalProperties":true,"type":"object","title":"Attestation","description":"The signed receipt: Ed25519 over the RFC 8785 canonical response with\nonly the signature field removed. Present only when signing is enabled."},"AuthResponse":{"properties":{"token":{"type":"string","title":"Token"},"user":{"additionalProperties":true,"type":"object","title":"User"}},"type":"object","required":["token","user"],"title":"AuthResponse"},"AvailableFeeCell":{"properties":{"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"modifier2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier2"}},"additionalProperties":true,"type":"object","title":"AvailableFeeCell","description":"A modifier combination that carries a fee cell for the code and area\non the DOS. Returned on an R1 miss so the caller learns what exists\n(E0601 is published only under RR) without the status leaving not_found."},"BasisItem":{"properties":{"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"regulation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Regulation"},"version_in_force":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version In Force"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"effect":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effect"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"},"coder_label_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Coder Label Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"BasisItem","description":"One applicability basis entry. kind discriminates: category |\nauthority | policy_text_exemption; each kind carries its own fields.\ncategory and authority are CMS facts in force on the DOS, never a\nverdict. policy_text_exemption is the CMS passage that states the\nverdict: quote is rendering[span] of the archived file, served under the\nreceipt's license rule."},"CeilingFloorStatement":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"readme_member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Readme Member File Id"},"readme_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Readme Sha256"},"readme_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Readme Name"},"ceiling_field_6":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ceiling Field 6"},"floor_field_7":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Floor Field 7"}},"additionalProperties":true,"type":"object","title":"CeilingFloorStatement","description":"CMS's own words for README fields 6 (CEILING) and 7 (FLOOR), given when a\ncell's ceiling and floor are both 0.00. ceiling_field_6 and floor_field_7 are\nCMS's text as written (line breaks collapsed). The label is Verzi's. The\nreadme_* fields name the README file in the quarter's zip."},"ChangesBlocks-Input":{"properties":{"r1_fee":{"anyOf":[{"$ref":"#/components/schemas/FeeDiff-Input"},{"type":"null"}]},"r2_mue":{"anyOf":[{"$ref":"#/components/schemas/MueDiff-Input"},{"type":"null"}]},"r2_ptp":{"anyOf":[{"$ref":"#/components/schemas/PtpDiff-Input"},{"type":"null"}]},"r3_requirements":{"anyOf":[{"$ref":"#/components/schemas/R3Diff-Input"},{"type":"null"}]},"applicability":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityDiff-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ChangesBlocks"},"ChangesBlocks-Output":{"properties":{"r1_fee":{"anyOf":[{"$ref":"#/components/schemas/FeeDiff-Output"},{"type":"null"}]},"r2_mue":{"anyOf":[{"$ref":"#/components/schemas/MueDiff-Output"},{"type":"null"}]},"r2_ptp":{"anyOf":[{"$ref":"#/components/schemas/PtpDiff-Output"},{"type":"null"}]},"r3_requirements":{"anyOf":[{"$ref":"#/components/schemas/R3Diff-Output"},{"type":"null"}]},"applicability":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityDiff-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ChangesBlocks"},"ChangesResponse":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"},"any_change":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Any Change"},"blocks":{"anyOf":[{"$ref":"#/components/schemas/ChangesBlocks-Output"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"attestation":{"anyOf":[{"$ref":"#/components/schemas/Attestation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ChangesResponse","description":"GET /rules/receipt/changes: per block, the as-of state at each date and\nwhether it moved. any_change is true if any block moved, null if none\nmoved but a block cannot be told (an unknown side), false otherwise."},"CheckedFeeFiles":{"properties":{"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"doc_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Doc Ids"},"version_ids":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Version Ids"},"row":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Row"},"files":{"anyOf":[{"items":{"$ref":"#/components/schemas/CheckedFeeTable"},"type":"array"},{"type":"null"}],"title":"Files"}},"additionalProperties":true,"type":"object","title":"CheckedFeeFiles","description":"The files an R1 miss relied on (rule fee_table_in_force): the DMEPOS\nversions in force on the date (doc_ids, version_ids) and each fee table\nread for the area type (files), member-continued tables included."},"CheckedFeeTable":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"layout_era":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Layout Era"},"continuation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Continuation"}},"additionalProperties":true,"type":"object","title":"CheckedFeeTable","description":"One fee table an R1 miss read: a parsed member of a version in force,\nor a member of an earlier quarter that a publisher statement keeps in\nforce in this quarter (migration 174). Only the second carries\ncontinuation: the quarter, the authority (doc_id, version_id, sha256),\nand the publisher's sentence, as a member_continued fee answer names\nthem."},"CheckedFiles":{"properties":{"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"doc_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Doc Ids"},"version_ids":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Version Ids"},"row":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Row"}},"additionalProperties":true,"type":"object","title":"CheckedFiles","description":"The files an edits answer relied on, negative answers included: the\nrule applied, the quarter, the archive doc_ids and version_ids read. For\nPTP (rule ptp_edition_in_force) that is CMS's complete quarter file in\nforce on the date; a not_edited answer adds the pair's newest row (in\nforce or not, `present` false when CMS's file no longer lists it). For\nMUE (rule mue_table_in_force) it is the setting's table in force. Rule\nlicense_scope (PTP and MUE): the file is held, but for a date before\n2022-01-01 a code is not public HCPCS Level II, so no row was read."},"ClaimFieldRow":{"properties":{"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"item":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"filled_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filled By"},"initial_claim":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Initial Claim"},"claim_denial":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Claim Denial"},"priority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Priority"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"rule":{"anyOf":[{"$ref":"#/components/schemas/ClaimFieldRule"},{"type":"null"}]},"denials":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Denials"},"dos_rules":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Dos Rules"},"form_versions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Form Versions"}},"additionalProperties":true,"type":"object","title":"ClaimFieldRow","description":"One field-map row: a CMS-1500 item (kind claim_field), a claim\nattachment, or electronic claim data. status: served | partly_served |\nnot_linked | not_held | check | n_a. priority: must | good | customer |\nn_a. denials: the Verzi denial ids the field triggers, with outcome."},"ClaimFieldRule":{"properties":{"source_pointer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Pointer"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"receipt_blocks":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Receipt Blocks"},"served_here":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Served Here"},"served_by_receipt":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Served By Receipt"}},"additionalProperties":true,"type":"object","title":"ClaimFieldRule","description":"source_pointer: the crosswalk's pointer to the documents whose text\ndecides the field (Verzi Health metadata, not CMS text). served_here:\nthe blocks under `receipts` that serve it for this code and DOS.\nserved_by_receipt: blocks that need an input this route does not take\n(block, needs, route)."},"ClaimFieldsResponse":{"properties":{"query":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Query"},"fields":{"anyOf":[{"items":{"$ref":"#/components/schemas/ClaimFieldRow"},"type":"array"},{"type":"null"}],"title":"Fields"},"dos_rules":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Dos Rules"},"not_in_force_on_dos":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Not In Force On Dos"},"filtered_out":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Filtered Out"},"receipts":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Receipts"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"attestation":{"anyOf":[{"$ref":"#/components/schemas/Attestation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ClaimFieldsResponse","description":"GET /rules/claim-fields: the claim field map on the DOS. No field\nvalues in, none out."},"CodeBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CodeValidity"},{"type":"null"}]},"COV":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cov"},"PRCNGCD":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Prcngcd"},"BETOS":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Betos"},"admin_citation":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"CodeBlock","description":"receipts.code: the HCPCS Level II code on the DOS. status: ok (validity\nresolved) | unknown | not_yet_available. COV, PRCNGCD and BETOS as the\nfile in admin_citation states them. admin_citation can differ from\nvalidity.citation: when the later file decides, these fields still come\nfrom the file in force on the DOS, except a re-activation (ACTN_CD R)\nthe later file states, where both name the later file."},"CodeBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CodeValidity"},{"type":"null"}]},"COV":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cov"},"PRCNGCD":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Prcngcd"},"BETOS":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Betos"},"admin_citation":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"CodeBlock","description":"receipts.code: the HCPCS Level II code on the DOS. status: ok (validity\nresolved) | unknown | not_yet_available. COV, PRCNGCD and BETOS as the\nfile in admin_citation states them. admin_citation can differ from\nvalidity.citation: when the later file decides, these fields still come\nfrom the file in force on the DOS, except a re-activation (ACTN_CD R)\nthe later file states, where both name the later file."},"CodeCitation":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"version_in_force":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version In Force"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"code_listed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Code Listed"},"unparsed_version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unparsed Version Id"},"unparsed_member":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unparsed Member"}},"additionalProperties":true,"type":"object","title":"CodeCitation","description":"The HCPCS file a code answer rests on. source: file_in_force, or\nstated_in_later_file (the first held file after the DOS stated the date).\nWith reason file_in_force_not_parsed: unparsed_version_id names the\nversion not parsed, and unparsed_member its own code table member."},"CodeValidity":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dates":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Dates"},"citation":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]},"later_file":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"CodeValidity","description":"status: valid | not_valid | unknown. reason (when not valid):\nterminated, not_yet_effective, not_in_file_in_force, not_in_later_file, files_disagree,\nbefore_first_held_file, no_file_in_force, file_in_force_not_parsed,\nlater_file_not_parsed, fields_not_parsed, dates_not_readable, later_file_not_held,\nlicense_scope, not_yet_available. dates: CMS's own\nfields as stated (YYYYMMDD) under CMS's names ADD_DT, EFCTV_DT, TERM_DT,\nACTN_CD."},"CompetitiveBiddingBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Basis"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"rounds":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompetitiveBiddingRound"},"type":"array"},{"type":"null"}],"title":"Rounds"},"gap":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gap"},"exemptions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Exemptions"}},"additionalProperties":true,"type":"object","title":"CompetitiveBiddingBlock","description":"receipts.competitive_bidding: what the held CBIC files show for the\ncode on the DOS. No beneficiary ZIP reaches the API: where the answer\nturns on the ZIP, the round says zip_checked_by_caller and names the held\nZIP file (zip_file) to check it against. status: ok (the held files show\nthe contract-supplier requirement did not apply; basis\nno_round_in_force or code_not_in_awarded_category) | unknown (reason:\nthe first round's unknown, zip_checked_by_caller ranked last, or\nsupplier_file_not_held where a round applies, or before_first_held_file,\nno_round_stated, not_level_ii, not_a_modifier) | not_yet_available.\ngap: the stated gap in force, with seen_through (the latest held capture of CMS's page that\nstill holds the quote). The exemptions are not evaluated. A block that is\nnot ok is not weighed in the confidence rollup; it keeps its own status\nand reason."},"CompetitiveBiddingBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Basis"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"rounds":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompetitiveBiddingRound"},"type":"array"},{"type":"null"}],"title":"Rounds"},"gap":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gap"},"exemptions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Exemptions"}},"additionalProperties":true,"type":"object","title":"CompetitiveBiddingBlock","description":"receipts.competitive_bidding: what the held CBIC files show for the\ncode on the DOS. No beneficiary ZIP reaches the API: where the answer\nturns on the ZIP, the round says zip_checked_by_caller and names the held\nZIP file (zip_file) to check it against. status: ok (the held files show\nthe contract-supplier requirement did not apply; basis\nno_round_in_force or code_not_in_awarded_category) | unknown (reason:\nthe first round's unknown, zip_checked_by_caller ranked last, or\nsupplier_file_not_held where a round applies, or before_first_held_file,\nno_round_stated, not_level_ii, not_a_modifier) | not_yet_available.\ngap: the stated gap in force, with seen_through (the latest held capture of CMS's page that\nstill holds the quote). The exemptions are not evaluated. A block that is\nnot ok is not weighed in the confidence rollup; it keeps its own status\nand reason."},"CompetitiveBiddingCitation":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File"},"row":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Row"}},"additionalProperties":true,"type":"object","title":"CompetitiveBiddingCitation","description":"One held CBIC file an answer read, and what it read (row): a row of\nthe file, an absence ({\"absent\": \"hcpcs\", ...}), a quote with the note it\nsits in, or {\"read\": \"zip\", \"answers_range\": ...}: the ZIP file, with the\nDOS range it answers (\"not_shown\" when no held source states one)."},"CompetitiveBiddingRound":{"properties":{"round":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Round"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"contract_from":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Contract From"},"contract_to":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Contract To"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome"},"cba":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cba"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"supplier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supplier"},"citation":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompetitiveBiddingCitation"},"type":"array"},{"type":"null"}],"title":"Citation"},"zip_edition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Zip Edition"},"zip_file":{"anyOf":[{"$ref":"#/components/schemas/CompetitiveBiddingZipFile"},{"type":"null"}]},"not_held":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Not Held"},"categories_ended":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Categories Ended"}},"additionalProperties":true,"type":"object","title":"CompetitiveBiddingRound","description":"One round in force on the DOS. contract_from and contract_to: the\nround's dates with their basis and CBIC's or CMS's quote. outcome:\napplies, code_not_in_awarded_category, zip_checked_by_caller, or an\nunknown reason (round_files_not_held, zip_file_versions_not_held,\nround_rules_not_checked, category_key_not_stated, modifiers_not_given,\nheld_file_not_readable). zip_edition: where each end of the ZIP file's\nrange comes from. not_held: what the held files do not hold."},"CompetitiveBiddingZipFile":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File"},"answers_range":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Answers Range"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"}},"additionalProperties":true,"type":"object","title":"CompetitiveBiddingZipFile","description":"The held ZIP file a caller checks the beneficiary's ZIP against (no\nZIP reaches the API), and the DOS range it answers, both ends inclusive.\narchive_file: the archive route that links the original bytes."},"ConfidenceBlockEntry":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"}},"additionalProperties":true,"type":"object","title":"ConfidenceBlockEntry"},"ConfidenceSummary":{"properties":{"as_of_dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Dos"},"blocks":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ConfidenceBlockEntry"},"type":"object"},{"type":"null"}],"title":"Blocks"},"overall":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overall"},"claim_types":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Claim Types"}},"additionalProperties":true,"type":"object","title":"ConfidenceSummary","description":"The advisory rollup. overall: unknown | partial | cited. It never\nchanges a block. claim_types, only on a partial answer (a claim_format\nwith claim types not started): {covers, not_started, note}, the claim\ntypes the rollup covers and the ones it does not."},"DmeMacBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"jurisdiction":{"anyOf":[{"$ref":"#/components/schemas/DmeMacJurisdiction"},{"type":"null"}]},"place_of_service":{"anyOf":[{"$ref":"#/components/schemas/DmeMacPlaceOfService-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"DmeMacBlock","description":"receipts.dme_mac (present when beneficiary_state is passed): the DME MAC\nfor the state on the DOS and that MAC's place-of-service lines. status: ok\n(a MAC is named), state_needed, not_determinable, not_yet_available. Not\nweighed in the confidence rollup unless ok."},"DmeMacBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"jurisdiction":{"anyOf":[{"$ref":"#/components/schemas/DmeMacJurisdiction"},{"type":"null"}]},"place_of_service":{"anyOf":[{"$ref":"#/components/schemas/DmeMacPlaceOfService-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"DmeMacBlock","description":"receipts.dme_mac (present when beneficiary_state is passed): the DME MAC\nfor the state on the DOS and that MAC's place-of-service lines. status: ok\n(a MAC is named), state_needed, not_determinable, not_yet_available. Not\nweighed in the confidence rollup unless ok."},"DmeMacCodeNamed":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"}},"additionalProperties":true,"type":"object","title":"DmeMacCodeNamed","description":"A place-of-service code a quoted line names, with its offsets into the\nrendering (inside the passage)."},"DmeMacCodeSet":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citation"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"additionalProperties":true,"type":"object","title":"DmeMacCodeSet"},"DmeMacJurisdiction":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"beneficiary_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary State"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"jurisdiction_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction Label"},"contractor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contractor"},"quote":{"anyOf":[{"$ref":"#/components/schemas/DmeMacQuote"},{"type":"null"}]},"state_span":{"anyOf":[{"$ref":"#/components/schemas/DmeMacSpan"},{"type":"null"}]},"contractor_span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"first_live_capture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Live Capture"},"source":{"anyOf":[{"$ref":"#/components/schemas/DmeMacSource"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/DmeMacProof"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"DmeMacJurisdiction","description":"dme_mac.jurisdiction: the DME MAC CMS's Who are the MACs page names for\nthe beneficiary's state, from the version in force on the DOS. status: ok,\nstate_needed (no state given; the map version in force is cited),\nnot_determinable with reason (the archive's as-of reason and\nfirst_live_capture when no version is in force; state_not_recognized,\nrendering_not_held, page_shape_not_recognized, state_in_two_jurisdictions,\nstate_not_listed, text_not_servable). quote is CMS's row as printed."},"DmeMacPlaceOfService-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"jurisdictions":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosJurisdiction-Input"},"type":"array"},{"type":"null"}],"title":"Jurisdictions"},"codes_valid_for_mac":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Codes Valid For Mac"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"cms_code_set":{"anyOf":[{"$ref":"#/components/schemas/DmeMacCodeSet"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"DmeMacPlaceOfService","description":"dme_mac.place_of_service: the DME MAC's place-of-service lines, quoted\nfrom the versions in force on the DOS (the named MAC's jurisdiction, or all\nfour when none is named). status: quoted_unlabeled or none_served.\ncodes_valid_for_mac stays null and label_status pending_coder_label until\na coder label on the passages is approved."},"DmeMacPlaceOfService-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"jurisdictions":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosJurisdiction-Output"},"type":"array"},{"type":"null"}],"title":"Jurisdictions"},"codes_valid_for_mac":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Codes Valid For Mac"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"cms_code_set":{"anyOf":[{"$ref":"#/components/schemas/DmeMacCodeSet"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"DmeMacPlaceOfService","description":"dme_mac.place_of_service: the DME MAC's place-of-service lines, quoted\nfrom the versions in force on the DOS (the named MAC's jurisdiction, or all\nfour when none is named). status: quoted_unlabeled or none_served.\ncodes_valid_for_mac stays null and label_status pending_coder_label until\na coder label on the passages is approved."},"DmeMacPosJurisdiction-Input":{"properties":{"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"sources":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosSource-Input"},"type":"array"},{"type":"null"}],"title":"Sources"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"DmeMacPosJurisdiction"},"DmeMacPosJurisdiction-Output":{"properties":{"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"sources":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosSource-Output"},"type":"array"},{"type":"null"}],"title":"Sources"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"DmeMacPosJurisdiction"},"DmeMacPosPassage":{"properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"},"quote_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Sha256"},"codes_named":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacCodeNamed"},"type":"array"},{"type":"null"}],"title":"Codes Named"}},"additionalProperties":true,"type":"object","title":"DmeMacPosPassage"},"DmeMacPosSource-Input":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"first_live_capture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Live Capture"},"passages":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosPassage"},"type":"array"},{"type":"null"}],"title":"Passages"},"codes_named":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Codes Named"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/DmeMacProof"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"DmeMacPosSource","description":"One DME MAC place-of-service source on the DOS. outcome: quoted,\nno_version_in_force (reason, first_live_capture), text_withheld (a PDF, or\na line the license or word-order rule holds), names_no_place_of_service_code,\nunreadable."},"DmeMacPosSource-Output":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"first_live_capture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Live Capture"},"passages":{"anyOf":[{"items":{"$ref":"#/components/schemas/DmeMacPosPassage"},"type":"array"},{"type":"null"}],"title":"Passages"},"codes_named":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Codes Named"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/DmeMacProof"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"DmeMacPosSource","description":"One DME MAC place-of-service source on the DOS. outcome: quoted,\nno_version_in_force (reason, first_live_capture), text_withheld (a PDF, or\na line the license or word-order rule holds), names_no_place_of_service_code,\nunreadable."},"DmeMacProof":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Renderer Version"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"},"observed_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed From"},"observed_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed To"},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"DmeMacProof","description":"The source proof of one archived page in the dme_mac block: the file\n(sha256, archive_file, url), its stored rendering (render_sha256,\nrenderer_version), and the version in force on the DOS with the as-of\nrule and boundary that chose it."},"DmeMacQuote":{"properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"},"quote_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Sha256"}},"additionalProperties":true,"type":"object","title":"DmeMacQuote","description":"A slice of the stored rendering: rendering[start:end] == text."},"DmeMacSource":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"}},"additionalProperties":true,"type":"object","title":"DmeMacSource"},"DmeMacSpan":{"properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"}},"additionalProperties":true,"type":"object","title":"DmeMacSpan"},"DosAsOf":{"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"}},"additionalProperties":true,"type":"object","title":"DosAsOf"},"EditionReceipt":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"establishing_edition":{"anyOf":[{"$ref":"#/components/schemas/EstablishingEdition"},{"type":"null"}]},"in_force_edition":{"anyOf":[{"$ref":"#/components/schemas/InForceEdition"},{"type":"null"}]},"observed_continuity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed Continuity"},"editions_spanned":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Editions Spanned"},"byte_proof":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Byte Proof"}},"additionalProperties":true,"type":"object","title":"EditionReceipt","description":"The edition-based receipt used by enrollment and order_referring."},"EnrollmentRow":{"properties":{"enrlmt_id":{"anyOf":[{},{"type":"null"}],"title":"Enrlmt Id"},"pecos_asct_cntl_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pecos Asct Cntl Id"},"provider_type_cd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Type Cd"},"provider_type_desc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Type Desc"},"state_cd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Cd"},"org_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Name"},"establishing_edition":{"anyOf":[{"$ref":"#/components/schemas/EstablishingEdition"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"EnrollmentRow"},"EstablishingEdition":{"properties":{"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"edition_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edition Date"}},"additionalProperties":true,"type":"object","title":"EstablishingEdition"},"ExclusionCoverage":{"properties":{"rein_months_checked":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rein Months Checked"},"from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},"additionalProperties":true,"type":"object","title":"ExclusionCoverage","description":"The monthly reinstatement files a historical \"not excluded\" rests on."},"ExclusionReceipt":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"snapshot_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snapshot Date"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"ExclusionReceipt"},"ExclusionRecord":{"properties":{"excldate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excldate"},"reindate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reindate"},"excltype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excltype"},"waiverdate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waiverdate"},"waiverstate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waiverstate"},"source":{"anyOf":[{"$ref":"#/components/schemas/ExclusionSource"},{"type":"null"}]},"superseded_reinstatement":{"anyOf":[{"$ref":"#/components/schemas/ExclusionSource"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ExclusionRecord"},"ExclusionSource":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"}},"additionalProperties":true,"type":"object","title":"ExclusionSource","description":"The archived LEIE file a record was read from: the full database\nsnapshot (leie:UPDATED) or a monthly reinstatement supplement."},"ExclusionsBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"exclusions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Requirement-Input"},"type":"array"},{"type":"null"}],"title":"Exclusions"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/R3Coverage"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ExclusionsBlock","description":"receipts.exclusions. status: not_yet_available | none_served | ok."},"ExclusionsBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"exclusions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Requirement-Output"},"type":"array"},{"type":"null"}],"title":"Exclusions"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/R3Coverage"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ExclusionsBlock","description":"receipts.exclusions. status: not_yet_available | none_served | ok."},"FaceToFaceWopdAsOf":{"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdAsOf"},"FaceToFaceWopdBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"list_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Name"},"required_face_to_face_wopd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Required Face To Face Wopd"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"answer_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer Source"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"list_entry":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdListEntry"},{"type":"null"}]},"list":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdList"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdReceipt"},{"type":"null"}]},"contractor_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/FaceToFaceWopdContractorStatement"},"type":"array"},{"type":"null"}],"title":"Contractor Statements"},"sources_checked":{"anyOf":[{"items":{"$ref":"#/components/schemas/FaceToFaceWopdSourceChecked"},"type":"array"},{"type":"null"}],"title":"Sources Checked"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdBlock","description":"CMS's Required Face-to-Face Encounter and Written Order Prior to\nDelivery List, as of the DOS. required_face_to_face_wopd is listed,\nnot_listed, or not_determinable (not_determinable_kind:\nno_version_in_force, with as_of.reason; not_parsed; date_not_readable;\neffective_after_dos; partial_list; sources_disagree; source_unreadable): list\nmembership, never a payer decision. answer_source says what a listed or\nnot_listed answer rests on: cms_list, or dme_mac_statement (no CMS\nedition held for the DOS; completeness contractor_statement, quoted in\ncontractor_statements). sources_checked lists every source read when no\nCMS edition answers the DOS."},"FaceToFaceWopdBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"list_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Name"},"required_face_to_face_wopd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Required Face To Face Wopd"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"answer_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer Source"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"list_entry":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdListEntry"},{"type":"null"}]},"list":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdList"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdReceipt"},{"type":"null"}]},"contractor_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/FaceToFaceWopdContractorStatement"},"type":"array"},{"type":"null"}],"title":"Contractor Statements"},"sources_checked":{"anyOf":[{"items":{"$ref":"#/components/schemas/FaceToFaceWopdSourceChecked"},"type":"array"},{"type":"null"}],"title":"Sources Checked"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdBlock","description":"CMS's Required Face-to-Face Encounter and Written Order Prior to\nDelivery List, as of the DOS. required_face_to_face_wopd is listed,\nnot_listed, or not_determinable (not_determinable_kind:\nno_version_in_force, with as_of.reason; not_parsed; date_not_readable;\neffective_after_dos; partial_list; sources_disagree; source_unreadable): list\nmembership, never a payer decision. answer_source says what a listed or\nnot_listed answer rests on: cms_list, or dme_mac_statement (no CMS\nedition held for the DOS; completeness contractor_statement, quoted in\ncontractor_statements). sources_checked lists every source read when no\nCMS edition answers the DOS."},"FaceToFaceWopdContractorReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Renderer Version"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"},"publisher_effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher Effective From"},"observed_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed From"},"observed_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed To"},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdContractorReceipt","description":"The source proof for a DME MAC page version (source dme_mac_noridian)."},"FaceToFaceWopdContractorStatement":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"attribution":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attribution"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"stated_effective_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stated Effective Text"},"stated_effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stated Effective From"},"sentence":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdQuote"},{"type":"null"}]},"line":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdQuote"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdContractorReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdContractorStatement","description":"A DME MAC's sentence and item line that name the code, in its words."},"FaceToFaceWopdList":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"authority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authority"},"effective_date_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date Text"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdList","description":"The list's own title, authority line, and effective date line."},"FaceToFaceWopdListEntry":{"properties":{"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"row_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row Text"},"effective_date_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date Text"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"page_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Number"},"parse_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parse Note"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdListEntry","description":"The code's row on the F2F/WOPD list version in force, in the list's own words."},"FaceToFaceWopdQuote":{"properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdQuote","description":"A verbatim slice of the stored rendering: text == rendering[start:end]."},"FaceToFaceWopdReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"publisher_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher Version"},"observed_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed From"},"observed_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed To"},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"},"parser_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parser Version"},"publisher_effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher Effective From"},"publisher_effective_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher Effective To"},"row_ref":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdRowRef"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdReceipt"},"FaceToFaceWopdRowRef":{"properties":{"table":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"page_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Number"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdRowRef","description":"Where the quoted row sits: the parsed table's key and the page."},"FaceToFaceWopdSourceChecked":{"properties":{"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher"},"attribution":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attribution"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome"},"as_of_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Reason"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"observed_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed From"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"unreadable_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unreadable Reason"}},"additionalProperties":true,"type":"object","title":"FaceToFaceWopdSourceChecked","description":"One source checked for a DOS no CMS list edition answers, and what it states."},"FeeDiff-Input":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"FeeDiff","description":"from and to: the fee fact on each date, null for no cell, or an unknown\nside ({\"status\": \"unknown\", \"reason_code\": \"revision_not_served\", ...})\nwhen a held CMS revision covers the date and is not served yet; changed is\nthen null (unknown)."},"FeeDiff-Output":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"FeeDiff","description":"from and to: the fee fact on each date, null for no cell, or an unknown\nside ({\"status\": \"unknown\", \"reason_code\": \"revision_not_served\", ...})\nwhen a held CMS revision covers the date and is not served yet; changed is\nthen null (unknown)."},"FeeResponse":{"properties":{"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"modifier2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier2"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"area_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Area Type"},"area":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Area"},"rural":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rural"},"allowed_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Allowed Amount"},"ceiling":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ceiling"},"floor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]},"citation":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"ceiling_floor_statement":{"anyOf":[{"$ref":"#/components/schemas/CeilingFloorStatement"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"FeeResponse","description":"GET /rules/dmepos/fee (and the r1 fact, and the timeline fee sides)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Icd10Article-Input":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"served":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Served"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/NcdAsOf"},{"type":"null"}]},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/NcdVersionInForce"},{"type":"null"}]},"lists":{"anyOf":[{"$ref":"#/components/schemas/Icd10ArticleLists-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10Article","description":"One Policy Article CMS maps to the code, its version in force on the\nDOS, and its ICD-10-CM lists for that version."},"Icd10Article-Output":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"served":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Served"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/NcdAsOf"},{"type":"null"}]},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/NcdVersionInForce"},{"type":"null"}]},"lists":{"anyOf":[{"$ref":"#/components/schemas/Icd10ArticleLists-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10Article","description":"One Policy Article CMS maps to the code, its version in force on the\nDOS, and its ICD-10-CM lists for that version."},"Icd10ArticleLists-Input":{"properties":{"covered":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListPair-Input"},{"type":"null"}]},"noncovered":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListPair-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10ArticleLists"},"Icd10ArticleLists-Output":{"properties":{"covered":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListPair-Output"},{"type":"null"}]},"noncovered":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListPair-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10ArticleLists"},"Icd10CodeList":{"properties":{"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"list_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Doc Id"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListReceipt"},{"type":"null"}]},"codes_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Codes Total"},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"codes_served":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Codes Served"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"rows_withheld":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rows Withheld"},"rows_withheld_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rows Withheld Reason"},"codes":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Codes"}},"additionalProperties":true,"type":"object","title":"Icd10CodeList","description":"One ICD-10-CM code list of the Article version in force (endpoint\nicd10-covered or icd10-noncovered). status: held (rows serve), not_held\n(unknown, with reason), drift, incomplete, no_parent, bytes_not_loaded.\ncodes are CMS's rows under CMS's field names (icd10_code_id, description,\nthe group number, sort_order, asterisk, ...). Paged: codes_total,\noffset, limit, codes_served and next_offset (None at the end) say what\nthis answer holds; rows_withheld counts rows whose code is not ICD-10-CM\nshaped."},"Icd10GroupList":{"properties":{"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"list_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Doc Id"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListReceipt"},{"type":"null"}]},"groups":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Groups"}},"additionalProperties":true,"type":"object","title":"Icd10GroupList","description":"CMS's groups of one list (endpoint icd10-covered-group or\nicd10-noncovered-group): the group number, CMS's paragraph and asterisk\nnote, verbatim, or <field>_withheld when a text guard holds it."},"Icd10ListPair-Input":{"properties":{"codes":{"anyOf":[{"$ref":"#/components/schemas/Icd10CodeList"},{"type":"null"}]},"groups":{"anyOf":[{"$ref":"#/components/schemas/Icd10GroupList"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10ListPair"},"Icd10ListPair-Output":{"properties":{"codes":{"anyOf":[{"$ref":"#/components/schemas/Icd10CodeList"},{"type":"null"}]},"groups":{"anyOf":[{"$ref":"#/components/schemas/Icd10GroupList"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"Icd10ListPair"},"Icd10ListReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"fetched_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fetched At"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"}},"additionalProperties":true,"type":"object","title":"Icd10ListReceipt","description":"The archived Coverage API list file the rows come from (source\nmcd_coverage_lists). The source is not public: its bytes do not serve."},"Icd10ListsBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"articles":{"anyOf":[{"items":{"$ref":"#/components/schemas/Icd10Article-Input"},"type":"array"},{"type":"null"}],"title":"Articles"},"paging":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Paging"},"hcpcs_tables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hcpcs Tables"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"Icd10ListsBlock","description":"The covered and non-covered ICD-10-CM lists of each Policy Article CMS\nmaps to the code, from the Article version in force on the DOS. status: ok,\nunknown (no list held for the version in force; never \"not listed\"),\nnone_served (no Article mapped), not_yet_available. The Article's HCPCS\ncode tables are never served (hcpcs_tables)."},"Icd10ListsBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"articles":{"anyOf":[{"items":{"$ref":"#/components/schemas/Icd10Article-Output"},"type":"array"},{"type":"null"}],"title":"Articles"},"paging":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Paging"},"hcpcs_tables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hcpcs Tables"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"Icd10ListsBlock","description":"The covered and non-covered ICD-10-CM lists of each Policy Article CMS\nmaps to the code, from the Article version in force on the DOS. status: ok,\nunknown (no list held for the version in force; never \"not listed\"),\nnone_served (no Article mapped), not_yet_available. The Article's HCPCS\ncode tables are never served (hcpcs_tables)."},"InForceEdition":{"properties":{"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"snapshot_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snapshot Date"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"InForceEdition"},"LicenseCurrentState":{"properties":{"license_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"License Count"},"states":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"States"}},"additionalProperties":true,"type":"object","title":"LicenseCurrentState"},"MaAppealRights-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaAppealSection-Input"},"type":"array"},{"type":"null"}],"title":"Sections"}},"additionalProperties":true,"type":"object","title":"MaAppealRights","description":"The MA appeal path (42 CFR 422.566, 422.578, 422.582, 422.584,\n422.590) from the version in force on the DOS."},"MaAppealRights-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaAppealSection-Output"},"type":"array"},{"type":"null"}],"title":"Sections"}},"additionalProperties":true,"type":"object","title":"MaAppealRights","description":"The MA appeal path (42 CFR 422.566, 422.578, 422.582, 422.584,\n422.590) from the version in force on the DOS."},"MaAppealSection-Input":{"properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"quotes":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaQuote-Input"},"type":"array"},{"type":"null"}],"title":"Quotes"}},"additionalProperties":true,"type":"object","title":"MaAppealSection","description":"One Subpart M section: its heading and its own top-level paragraphs."},"MaAppealSection-Output":{"properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"quotes":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaQuote-Output"},"type":"array"},{"type":"null"}],"title":"Quotes"}},"additionalProperties":true,"type":"object","title":"MaAppealSection","description":"One Subpart M section: its heading and its own top-level paragraphs."},"MaApplicability-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"applies_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applies From"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"quote":{"anyOf":[{"$ref":"#/components/schemas/MaQuote-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaApplicability","description":"When 422.101(b)(6) applies, in CMS-4201-F's own words (fr:2023-07115,\nthe DATES section's applicability sentence). applies_from is the rule's\nstated date, present only with status ok (the located sentence states\nit). status ok | unknown with reason."},"MaApplicability-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"applies_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applies From"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"quote":{"anyOf":[{"$ref":"#/components/schemas/MaQuote-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaApplicability","description":"When 422.101(b)(6) applies, in CMS-4201-F's own words (fr:2023-07115,\nthe DATES section's applicability sentence). applies_from is the rule's\nstated date, present only with status ok (the located sentence states\nit). status ok | unknown with reason."},"MaBinding-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"quotes":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaQuote-Input"},"type":"array"},{"type":"null"}],"title":"Quotes"}},"additionalProperties":true,"type":"object","title":"MaBinding","description":"42 CFR 422.101(b) from the cfr:42-422 version in force on the DOS:\nthe section heading, the (b) lead-in, (b)(1), (b)(2), (b)(3). status ok |\nunknown with reason (the archive's as-of reason, rendering_not_held,\nsection_not_found, section_ambiguous, paragraph_not_found,\nparagraph_marker_unexpected, paragraph_marker_ambiguous, text_withheld)."},"MaBinding-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"quotes":{"anyOf":[{"items":{"$ref":"#/components/schemas/MaQuote-Output"},"type":"array"},{"type":"null"}],"title":"Quotes"}},"additionalProperties":true,"type":"object","title":"MaBinding","description":"42 CFR 422.101(b) from the cfr:42-422 version in force on the DOS:\nthe section heading, the (b) lead-in, (b)(1), (b)(2), (b)(3). status ok |\nunknown with reason (the archive's as-of reason, rendering_not_held,\nsection_not_found, section_ambiguous, paragraph_not_found,\nparagraph_marker_unexpected, paragraph_marker_ambiguous, text_withheld)."},"MaInternalCoverageCriteria-Input":{"properties":{"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"applicability":{"anyOf":[{"$ref":"#/components/schemas/MaApplicability-Input"},{"type":"null"}]},"quote":{"anyOf":[{"$ref":"#/components/schemas/MaQuote-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaInternalCoverageCriteria","description":"42 CFR 422.101(b)(6). state: applicable | not_yet_applicable |\nnot_in_force (the version in force has no (b)(6)) | unknown (reason)."},"MaInternalCoverageCriteria-Output":{"properties":{"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"applicability":{"anyOf":[{"$ref":"#/components/schemas/MaApplicability-Output"},{"type":"null"}]},"quote":{"anyOf":[{"$ref":"#/components/schemas/MaQuote-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaInternalCoverageCriteria","description":"42 CFR 422.101(b)(6). state: applicable | not_yet_applicable |\nnot_in_force (the version in force has no (b)(6)) | unknown (reason)."},"MaQuote-Input":{"properties":{"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"marker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marker"},"part":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Part"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"},"redactions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Redactions"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/MaQuoteReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaQuote","description":"One verbatim quote. cite: the citation (\"42 CFR 422.101(b)(3)\"),\nmetadata only. marker: the CFR's own paragraph marker. part: heading |\nlead_in | paragraph | text | sentence. quote is the publisher's words, or\nnull with text_withheld (license, rendering_not_in_document_order,\nlicensed_text)."},"MaQuote-Output":{"properties":{"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"marker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marker"},"part":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Part"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"},"redactions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Redactions"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/MaQuoteReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MaQuote","description":"One verbatim quote. cite: the citation (\"42 CFR 422.101(b)(3)\"),\nmetadata only. marker: the CFR's own paragraph marker. part: heading |\nlead_in | paragraph | text | sentence. quote is the publisher's words, or\nnull with text_withheld (license, rendering_not_in_document_order,\nlicensed_text)."},"MaQuoteReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Renderer Version"},"fetched_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fetched At"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"quote_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Sha256"},"source_proof":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Proof"}},"additionalProperties":true,"type":"object","title":"MaQuoteReceipt","description":"The source proof of one Medicare Advantage quote: the archived file\n(sha256, archive_file), its stored rendering (render_sha256,\nrenderer_version), the version in force on the DOS and the as-of rule that\nchose it, the span, the sha256 of rendering[start:end], and the\n/source-proof link that re-slices it."},"MedicareAdvantageBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"binding":{"anyOf":[{"$ref":"#/components/schemas/MaBinding-Input"},{"type":"null"}]},"internal_coverage_criteria":{"anyOf":[{"$ref":"#/components/schemas/MaInternalCoverageCriteria-Input"},{"type":"null"}]},"appeal_rights":{"anyOf":[{"$ref":"#/components/schemas/MaAppealRights-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MedicareAdvantageBlock","description":"receipts.medicare_advantage, present only for payer\nmedicare_advantage: the 42 CFR 422.101(b) floor and the Subpart M appeal\npath, verbatim, as of the DOS. status ok (the binding quotes serve) |\nunknown (reason) | not_yet_available. completeness (when ok): complete (the\n(b)(6) state is decided and every Subpart M section serves) | partial\n(graded partial in the rollup). Not weighed in the rollup unless ok."},"MedicareAdvantageBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"binding":{"anyOf":[{"$ref":"#/components/schemas/MaBinding-Output"},{"type":"null"}]},"internal_coverage_criteria":{"anyOf":[{"$ref":"#/components/schemas/MaInternalCoverageCriteria-Output"},{"type":"null"}]},"appeal_rights":{"anyOf":[{"$ref":"#/components/schemas/MaAppealRights-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MedicareAdvantageBlock","description":"receipts.medicare_advantage, present only for payer\nmedicare_advantage: the 42 CFR 422.101(b) floor and the Subpart M appeal\npath, verbatim, as of the DOS. status ok (the binding quotes serve) |\nunknown (reason) | not_yet_available. completeness (when ok): complete (the\n(b)(6) state is decided and every Subpart M section serves) | partial\n(graded partial in the rollup). Not weighed in the rollup unless ok."},"ModifierBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CodeValidity"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_citation":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ModifierBlock","description":"One HCPCS Level II modifier on the DOS (the code block's rule on the\nmodifier records of the ANWEB file, migration 187). status: ok (validity\nresolved) | unknown | not_yet_available. description: CMS's long\ndescription from the row that answered, in CMS's words.\ndescription_citation: the file that row comes from. It can differ from\nvalidity.citation, which can name the later file. A digit-first\n(CPT) modifier answers unknown with reason license_scope; input that is\nnot a modifier answers not_a_modifier. Neither is read."},"ModifierBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CodeValidity"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_citation":{"anyOf":[{"$ref":"#/components/schemas/CodeCitation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ModifierBlock","description":"One HCPCS Level II modifier on the DOS (the code block's rule on the\nmodifier records of the ANWEB file, migration 187). status: ok (validity\nresolved) | unknown | not_yet_available. description: CMS's long\ndescription from the row that answered, in CMS's words.\ndescription_citation: the file that row comes from. It can differ from\nvalidity.citation, which can name the later file. A digit-first\n(CPT) modifier answers unknown with reason license_scope; input that is\nnot a modifier answers not_a_modifier. Neither is read."},"ModifiersBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"absent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Absent"},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/ModifierBlock-Input"},"type":"array"},{"type":"null"}],"title":"Items"},"required_when":{"anyOf":[{"$ref":"#/components/schemas/RequiredWhen"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ModifiersBlock","description":"receipts.modifiers, present when the request names a modifier: one item\nper modifier, in request order. status: ok when every modifier Verzi can\nassert about resolves, else unknown. absent: Verzi can assert about none\n(the confidence rollup does not weigh the block)."},"ModifiersBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"absent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Absent"},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/ModifierBlock-Output"},"type":"array"},{"type":"null"}],"title":"Items"},"required_when":{"anyOf":[{"$ref":"#/components/schemas/RequiredWhen"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ModifiersBlock","description":"receipts.modifiers, present when the request names a modifier: one item\nper modifier, in request order. status: ok when every modifier Verzi can\nassert about resolves, else unknown. absent: Verzi can assert about none\n(the confidence rollup does not weigh the block)."},"MueDiff-Input":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"MueDiff","description":"changed: true, false, or null when either side is unknown (a table\nmissing or unread, or a code outside the license scope; the side then\nreads {status: unknown, reason})."},"MueDiff-Output":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"MueDiff","description":"changed: true, false, or null when either side is unknown (a table\nmissing or unread, or a code outside the license scope; the side then\nreads {status: unknown, reason})."},"MueResponse":{"properties":{"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"mue_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mue Value"},"mai":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Mai"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]},"citation":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"additionalProperties":true,"type":"object","title":"MueResponse","description":"GET /rules/ncci/mue (and the r2.mue fact)."},"MueSubBlock-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFiles"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MueSubBlock","description":"r2.mue. status: not_found | unknown | ok. unknown carries a reason:\nthe setting's MUE table for the quarter is missing or not parsed, or, for\na date before 2022-01-01, the code is not public HCPCS Level II (then\n`checked.rule` is license_scope)."},"MueSubBlock-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/MueResponse"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFiles"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MueSubBlock","description":"r2.mue. status: not_found | unknown | ok. unknown carries a reason:\nthe setting's MUE table for the quarter is missing or not parsed, or, for\na date before 2022-01-01, the code is not public HCPCS Level II (then\n`checked.rule` is license_scope)."},"NcdAsOf":{"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"additionalProperties":true,"type":"object","title":"NcdAsOf"},"NcdBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"ncds":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdEntry-Input"},"type":"array"},{"type":"null"}],"title":"Ncds"},"unresolved_citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdUnresolvedCitation-Input"},"type":"array"},{"type":"null"}],"title":"Unresolved Citations"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"NcdBlock","description":"The National Coverage Determinations CMS links to the code on the DOS,\neach quoted from its version in force. status: ok, unknown, none_served\n(no CMS link found; never a claim that no NCD applies), not_yet_available."},"NcdBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"ncds":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdEntry-Output"},"type":"array"},{"type":"null"}],"title":"Ncds"},"unresolved_citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdUnresolvedCitation-Output"},"type":"array"},{"type":"null"}],"title":"Unresolved Citations"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"NcdBlock","description":"The National Coverage Determinations CMS links to the code on the DOS,\neach quoted from its version in force. status: ok, unknown, none_served\n(no CMS link found; never a claim that no NCD applies), not_yet_available."},"NcdCitationRef":{"properties":{"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"line_span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"NcdCitationRef","description":"A span citation into a pinned rendering: span is the cited NCD number,\nline_span the line of CMS's text that holds it."},"NcdCitedBy-Input":{"properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/NcdCitationRef"},{"type":"null"}]},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"NcdCitedBy","description":"CMS's link from the code to the NCD: an LCD or Policy Article CMS maps\nto the code, in its version in force on the DOS, prints the NCD Manual\nsection number in its CMS National Coverage Policy section. quote is that\nline, CMS's words (text_withheld instead when a text guard holds it)."},"NcdCitedBy-Output":{"properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/NcdCitationRef"},{"type":"null"}]},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"NcdCitedBy","description":"CMS's link from the code to the NCD: an LCD or Policy Article CMS maps\nto the code, in its version in force on the DOS, prints the NCD Manual\nsection number in its CMS National Coverage Policy section. quote is that\nline, CMS's words (text_withheld instead when a text guard holds it)."},"NcdEntry-Input":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"ncd_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ncd Section"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/NcdAsOf"},{"type":"null"}]},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/NcdVersionInForce"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/NcdReceipt"},{"type":"null"}]},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageSection-Input"},"type":"array"},{"type":"null"}],"title":"Sections"},"section_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Reason"},"cited_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdCitedBy-Input"},"type":"array"},{"type":"null"}],"title":"Cited By"}},"additionalProperties":true,"type":"object","title":"NcdEntry","description":"One NCD CMS links to the code. state is served (its sections are\nCMS's words from the version in force on the DOS) or unknown\n(not_determinable_kind: no_version_in_force with as_of.reason,\nsections_not_registered, rendering_unavailable, section_hash_drift).\nncd_section is the NCD Manual section number as CMS prints it."},"NcdEntry-Output":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"ncd_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ncd Section"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/NcdAsOf"},{"type":"null"}]},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/NcdVersionInForce"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/NcdReceipt"},{"type":"null"}]},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageSection-Output"},"type":"array"},{"type":"null"}],"title":"Sections"},"section_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Reason"},"cited_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdCitedBy-Output"},"type":"array"},{"type":"null"}],"title":"Cited By"}},"additionalProperties":true,"type":"object","title":"NcdEntry","description":"One NCD CMS links to the code. state is served (its sections are\nCMS's words from the version in force on the DOS) or unknown\n(not_determinable_kind: no_version_in_force with as_of.reason,\nsections_not_registered, rendering_unavailable, section_hash_drift).\nncd_section is the NCD Manual section number as CMS prints it."},"NcdReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Renderer Version"},"fetched_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fetched At"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"}},"additionalProperties":true,"type":"object","title":"NcdReceipt","description":"The archived NCD file of the version in force and the rendering its\nsections cite."},"NcdUnresolvedCitation-Input":{"properties":{"ncd_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ncd Section"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"cited_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdCitedBy-Input"},"type":"array"},{"type":"null"}],"title":"Cited By"}},"additionalProperties":true,"type":"object","title":"NcdUnresolvedCitation","description":"A number CMS prints in NCD context that Verzi does not map to one\nregistered NCD (reason: no_registered_ncd_states_this_number,\nmore_than_one_ncd_states_this_number). Nothing serves for it."},"NcdUnresolvedCitation-Output":{"properties":{"ncd_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ncd Section"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"cited_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/NcdCitedBy-Output"},"type":"array"},{"type":"null"}],"title":"Cited By"}},"additionalProperties":true,"type":"object","title":"NcdUnresolvedCitation","description":"A number CMS prints in NCD context that Verzi does not map to one\nregistered NCD (reason: no_registered_ncd_states_this_number,\nmore_than_one_ncd_states_this_number). Nothing serves for it."},"NcdVersionInForce":{"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"effective_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective To"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"}},"additionalProperties":true,"type":"object","title":"NcdVersionInForce"},"OptOutRecord":{"properties":{"optout_effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optout Effective Date"},"optout_end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optout End Date"},"specialty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specialty"},"eligible_to_order_refer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eligible To Order Refer"},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated"}},"additionalProperties":true,"type":"object","title":"OptOutRecord"},"OrderReferringEligibility":{"properties":{"partb":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Partb"},"dme":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dme"},"hha":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hha"},"pmd":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pmd"},"hospice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hospice"}},"additionalProperties":true,"type":"object","title":"OrderReferringEligibility"},"OrderReferringEligible-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"order_dme_eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Order Dme Eligible"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]},"eligibility_on_dos":{"anyOf":[{"$ref":"#/components/schemas/OrderingEligibilityOnDos"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"OrderReferringEligible","description":"The ordering-physician DME eligibility read (r0_ordering only)."},"OrderReferringEligible-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"order_dme_eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Order Dme Eligible"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]},"eligibility_on_dos":{"anyOf":[{"$ref":"#/components/schemas/OrderingEligibilityOnDos"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"OrderReferringEligible","description":"The ordering-physician DME eligibility read (r0_ordering only)."},"OrderingEligibilityOnDos":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"columns":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Columns"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"citation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Citation"}},"additionalProperties":true,"type":"object","title":"OrderingEligibilityOnDos","description":"The ordering physician's DME eligibility in the valid-on-DOS shape.\nstatus: valid | not_valid | unknown. reason (the plan's shared\nvocabulary): not_in_file_in_force, dme_n, dme_not_stated,\nbefore_first_held_file, no_file_in_force, file_in_force_not_parsed,\nedition_before_change_baseline (with #427), not_yet_available,\nstanding_not_ok (the roster block is missing or not ok). columns:\nCMS's header names PARTB, DME, HHA, PMD, HOSPICE with \"Y\", \"N\" or null\n(any other value in the file). citation: null when no edition is in force."},"PayerBlock":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"PayerBlock"},"PortfolioCreate":{"properties":{"name":{"type":"string","title":"Name"},"facility_ids":{"items":{"type":"string"},"type":"array","title":"Facility Ids"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name","facility_ids"],"title":"PortfolioCreate"},"PortfolioUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"facility_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Facility Ids"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"PortfolioUpdate"},"PriorAuthAsOf":{"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"PriorAuthAsOf"},"PriorAuthList":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"authority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authority"},"list_date_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Date Text"},"list_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Date"},"effective_date_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date Note"}},"additionalProperties":true,"type":"object","title":"PriorAuthList","description":"The list's own title, authority line, date line, and effective-date note."},"PriorAuthListEntry":{"properties":{"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"effective_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Text"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"effective_phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/PriorAuthPhase"},"type":"array"},{"type":"null"}],"title":"Effective Phases"},"in_effect_phase":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthPhase"},{"type":"null"}]},"later_phases":{"anyOf":[{"items":{"$ref":"#/components/schemas/PriorAuthPhase"},"type":"array"},{"type":"null"}],"title":"Later Phases"},"row_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row Text"},"page_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Number"},"parse_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parse Note"}},"additionalProperties":true,"type":"object","title":"PriorAuthListEntry","description":"The code's row on the list version in force, in the list's own words."},"PriorAuthPhase":{"properties":{"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phase"},"date_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Text"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"scope_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope Text"},"nationwide":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nationwide"},"states":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"States"},"segment_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Segment Text"}},"additionalProperties":true,"type":"object","title":"PriorAuthPhase","description":"One phase of the list's Effective Date cell, as printed (P1, P2, or none)."},"PriorAuthReceipt":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"publisher_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher Version"},"observed_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed From"},"observed_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observed To"},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"archive_file":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archive File"},"parser_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parser Version"}},"additionalProperties":true,"type":"object","title":"PriorAuthReceipt"},"PriorAuthorizationBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"list_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Name"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"required_prior_authorization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Required Prior Authorization"},"scope_on_dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope On Dos"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"list_entry":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthListEntry"},{"type":"null"}]},"list":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthList"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthReceipt"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"PriorAuthorizationBlock","description":"CMS's Required Prior Authorization List for DMEPOS, as of the DOS.\nrequired_prior_authorization is listed, not_listed, listed_in_stated_states,\nor not_determinable: list membership, never a payer decision."},"PriorAuthorizationBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"list_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Name"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"required_prior_authorization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Required Prior Authorization"},"scope_on_dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope On Dos"},"not_determinable_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Determinable Kind"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"list_entry":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthListEntry"},{"type":"null"}]},"list":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthList"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthReceipt"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthAsOf"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"PriorAuthorizationBlock","description":"CMS's Required Prior Authorization List for DMEPOS, as of the DOS.\nrequired_prior_authorization is listed, not_listed, listed_in_stated_states,\nor not_determinable: list membership, never a payer decision."},"ProviderContext":{"properties":{"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi"},"state":{"anyOf":[{"$ref":"#/components/schemas/ProviderContextValue"},{"type":"null"}]},"prior_authorization_state":{"anyOf":[{"$ref":"#/components/schemas/ProviderContextValue"},{"type":"null"}]},"setting":{"anyOf":[{"$ref":"#/components/schemas/ProviderContextValue"},{"type":"null"}]},"resolution":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolution"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"ProviderContext"},"ProviderContextValue":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"cba":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cba"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"ProviderContextValue"},"PtanOnDos":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Code"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"related":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Related"}},"additionalProperties":true,"type":"object","title":"PtanOnDos","description":"receipts.r0.ptan_on_dos (crosswalk D27): whether the supplier's PTAN\nwas in effect on the DOS. status not_held: no held source states a PTAN's\neffective dates for an NPI, so no date is given; related names the r0\nparts that hold the nearest facts (enrollment, supplier_directory)."},"PtpCorrection":{"properties":{"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"doc_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Doc Ids"},"version_ids":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Version Ids"},"deletion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletion Date"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"PtpCorrection","description":"A later PTP edition that back-dates this row's deletion to on or\nbefore the date of service. It never rewrites the edition that answered;\nit only names the later file, so the caller sees the correction\n(api.providers.rules.queries._later_back_dated_deletion)."},"PtpDiff-Input":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"PtpDiff","description":"changed: true, false, or null when either side is unknown (a PTP part\nmissing or unread; the side then reads {status: unknown, reason})."},"PtpDiff-Output":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"PtpDiff","description":"changed: true, false, or null when either side is unknown (a PTP part\nmissing or unread; the side then reads {status: unknown, reason})."},"PtpFact":{"properties":{"edited":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Edited"},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"column_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Column 1"},"column_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Column 2"},"modifier_indicator":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Modifier Indicator"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"deletion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletion Date"},"pre_1996":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pre 1996"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]},"citation":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"corrections":{"anyOf":[{"items":{"$ref":"#/components/schemas/PtpCorrection"},"type":"array"},{"type":"null"}],"title":"Corrections"}},"additionalProperties":true,"type":"object","title":"PtpFact","description":"One PTP edit row (api.providers.rules.queries.ptp_on_dos)."},"PtpResponse":{"properties":{"edited":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Edited"},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"column_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Column 1"},"column_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Column 2"},"modifier_indicator":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Modifier Indicator"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"deletion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletion Date"},"pre_1996":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pre 1996"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]},"citation":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"corrections":{"anyOf":[{"items":{"$ref":"#/components/schemas/PtpCorrection"},"type":"array"},{"type":"null"}],"title":"Corrections"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFiles"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"PtpResponse","description":"GET /rules/ncci/ptp. Three shapes: an edit row carries the full fact\nwith as_of (version_in_force names the quarter file in force) and\ncitation; edited=false carries `date` only; edited=null carries `date`\nand `reason`: Verzi holds no complete file for the date's quarter, so a\nmissing row proves nothing; or, for a date before 2022-01-01, a code is\nnot public HCPCS Level II, such as a CPT or CDT code (`checked.rule`\nlicense_scope). `checked`\nnames the file in force."},"PtpSubBlock-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFiles"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"PtpSubBlock","description":"r2.ptp. status: not_requested | not_edited | unknown | ok. unknown\ncarries a reason naming the PTP parts missing or not parsed."},"PtpSubBlock-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/PtpFact"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFiles"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"PtpSubBlock","description":"r2.ptp. status: not_requested | not_edited | unknown | ok. unknown\ncarries a reason naming the PTP parts missing or not parsed."},"R0Block-Input":{"properties":{"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingExclusion-Input"},{"type":"null"}]},"supplier_directory":{"anyOf":[{"$ref":"#/components/schemas/StandingSupplierDirectory"},{"type":"null"}]},"enrollment":{"anyOf":[{"$ref":"#/components/schemas/StandingEnrollment-Input"},{"type":"null"}]},"sam_exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingSamExclusion"},{"type":"null"}]},"medicare_opt_out":{"anyOf":[{"$ref":"#/components/schemas/StandingMedicareOptOut"},{"type":"null"}]},"order_referring":{"anyOf":[{"$ref":"#/components/schemas/StandingOrderReferring-Input"},{"type":"null"}]},"license":{"anyOf":[{"$ref":"#/components/schemas/StandingLicense"},{"type":"null"}]},"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"order_referring_eligible":{"anyOf":[{"$ref":"#/components/schemas/OrderReferringEligible-Input"},{"type":"null"}]},"ptan_on_dos":{"anyOf":[{"$ref":"#/components/schemas/PtanOnDos"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R0Block","description":"receipts.r0 / receipts.r0_ordering: the standing object plus the\nreceipt wrapper; r0_ordering adds order_referring_eligible. r0 carries\nptan_on_dos."},"R0Block-Output":{"properties":{"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingExclusion-Output"},{"type":"null"}]},"supplier_directory":{"anyOf":[{"$ref":"#/components/schemas/StandingSupplierDirectory"},{"type":"null"}]},"enrollment":{"anyOf":[{"$ref":"#/components/schemas/StandingEnrollment-Output"},{"type":"null"}]},"sam_exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingSamExclusion"},{"type":"null"}]},"medicare_opt_out":{"anyOf":[{"$ref":"#/components/schemas/StandingMedicareOptOut"},{"type":"null"}]},"order_referring":{"anyOf":[{"$ref":"#/components/schemas/StandingOrderReferring-Output"},{"type":"null"}]},"license":{"anyOf":[{"$ref":"#/components/schemas/StandingLicense"},{"type":"null"}]},"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"order_referring_eligible":{"anyOf":[{"$ref":"#/components/schemas/OrderReferringEligible-Output"},{"type":"null"}]},"ptan_on_dos":{"anyOf":[{"$ref":"#/components/schemas/PtanOnDos"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R0Block","description":"receipts.r0 / receipts.r0_ordering: the standing object plus the\nreceipt wrapper; r0_ordering adds order_referring_eligible. r0 carries\nptan_on_dos."},"R1Block-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Code"},"revision":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Revision"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFeeFiles"},{"type":"null"}]},"available_cells":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailableFeeCell"},"type":"array"},{"type":"null"}],"title":"Available Cells"}},"additionalProperties":true,"type":"object","title":"R1Block","description":"receipts.r1 fee cell. status: unknown | not_found | ok. Every answer\nthat is not ok carries a reason_code and a reason:\nrevision_not_served (unknown): a held CMS revision file covers the date\nand is not parsed yet; revision names it (edition, file, url, sha256,\nwindow, basis) and no amount is served. The other codes carry checked:\ncode_not_in_file (not_found): the fee table in force does not list the\ncode for the area type. cell_not_in_file_in_force (not_found): it lists\nthe code but not this key; available_cells names the keys it has.\nno_file_in_force, file_in_force_not_parsed, no_table_in_force\n(unknown): a miss does not show that no fee exists. state_not_supplied\n(unknown): no state was given and NPI to state is not available, so no\ncell was looked up; it carries no checked."},"R1Block-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"fact":{"anyOf":[{"$ref":"#/components/schemas/FeeResponse"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/RuleCitation"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Code"},"revision":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Revision"},"checked":{"anyOf":[{"$ref":"#/components/schemas/CheckedFeeFiles"},{"type":"null"}]},"available_cells":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailableFeeCell"},"type":"array"},{"type":"null"}],"title":"Available Cells"}},"additionalProperties":true,"type":"object","title":"R1Block","description":"receipts.r1 fee cell. status: unknown | not_found | ok. Every answer\nthat is not ok carries a reason_code and a reason:\nrevision_not_served (unknown): a held CMS revision file covers the date\nand is not parsed yet; revision names it (edition, file, url, sha256,\nwindow, basis) and no amount is served. The other codes carry checked:\ncode_not_in_file (not_found): the fee table in force does not list the\ncode for the area type. cell_not_in_file_in_force (not_found): it lists\nthe code but not this key; available_cells names the keys it has.\nno_file_in_force, file_in_force_not_parsed, no_table_in_force\n(unknown): a miss does not show that no fee exists. state_not_supplied\n(unknown): no state was given and NPI to state is not available, so no\ncell was looked up; it carries no checked."},"R2Block-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"mue":{"anyOf":[{"$ref":"#/components/schemas/MueSubBlock-Input"},{"type":"null"}]},"ptp":{"anyOf":[{"$ref":"#/components/schemas/PtpSubBlock-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R2Block"},"R2Block-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"mue":{"anyOf":[{"$ref":"#/components/schemas/MueSubBlock-Output"},{"type":"null"}]},"ptp":{"anyOf":[{"$ref":"#/components/schemas/PtpSubBlock-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R2Block"},"R3BatchSignoff":{"properties":{"decided_by":{"type":"string","title":"Decided By","description":"The portal's AdminUser identity; written to signed_by and decided_by"},"group":{"additionalProperties":true,"type":"object","title":"Group","description":"{\"run\": required, \"codes\": [...], \"kinds\": [...], \"name\": \"...\"}"},"pool_label_ids":{"items":{"type":"integer"},"type":"array","title":"Pool Label Ids","description":"Every label of the group the sample was drawn from"},"sample_decisions":{"items":{"$ref":"#/components/schemas/R3SampleDecision"},"type":"array","title":"Sample Decisions","description":"The coder's decision on each sampled label"},"note":{"type":"string","title":"Note","description":"The coder's audit note (required)"},"confirm":{"type":"boolean","title":"Confirm","description":"Must be true: the coder confirms the sign-off"},"decided_by_coder_id":{"anyOf":[{"type":"string","pattern":"^C-[0-9]{3,}$"},{"type":"null"}],"title":"Decided By Coder Id","description":"The portal's coder ID for decided_by (migration 231)"},"decided_by_certified":{"type":"boolean","title":"Decided By Certified","description":"decided_by is a certified coder: the sampled approvals carry certified_codes","default":false}},"type":"object","required":["decided_by","group","pool_label_ids","sample_decisions","note","confirm"],"title":"R3BatchSignoff","description":"A certified coder's batch sign-off of one sampled double-checked\ngroup (migration 229)."},"R3Block-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"requirements":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Requirement-Input"},"type":"array"},{"type":"null"}],"title":"Requirements","description":"Deprecated: receipts.r3 no longer serves the legacy requirement list (2026-10-16); it serves documents[]. /rules/receipt/changes still serves it in blocks.r3_requirements.from and .to, with requirement_text null; there the replacement is added[] and removed[] (by quote_sha256). Removed on or after 2026-12-01.","deprecated":true},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageDocument-Input"},"type":"array"},{"type":"null"}],"title":"Documents"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/R3Coverage"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R3Block","description":"receipts.r3. status: not_yet_available | ok.\n\nreceipt_kind='policy_passages' carries documents[] (CMS's passages, with the\napproved coder labels beside them). Since the strict verbatim decision\n(2026-10-16) receipts.r3 never serves the legacy receipt_kind='policy_clause'\nshape. /rules/receipt/changes still serves it in R3Diff.from and .to, with\nrequirement_text always null."},"R3Block-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"requirements":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Requirement-Output"},"type":"array"},{"type":"null"}],"title":"Requirements","description":"Deprecated: receipts.r3 no longer serves the legacy requirement list (2026-10-16); it serves documents[]. /rules/receipt/changes still serves it in blocks.r3_requirements.from and .to, with requirement_text null; there the replacement is added[] and removed[] (by quote_sha256). Removed on or after 2026-12-01.","deprecated":true},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageDocument-Output"},"type":"array"},{"type":"null"}],"title":"Documents"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/R3Coverage"},{"type":"null"}]},"as_of":{"anyOf":[{"$ref":"#/components/schemas/DosAsOf"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R3Block","description":"receipts.r3. status: not_yet_available | ok.\n\nreceipt_kind='policy_passages' carries documents[] (CMS's passages, with the\napproved coder labels beside them). Since the strict verbatim decision\n(2026-10-16) receipts.r3 never serves the legacy receipt_kind='policy_clause'\nshape. /rules/receipt/changes still serves it in R3Diff.from and .to, with\nrequirement_text always null."},"R3Citation":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"quote_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Sha256"},"as_of":{"anyOf":[{"$ref":"#/components/schemas/AsOfRule"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R3Citation","description":"The per-requirement receipt: document, version, file, rendering hash,\nexact character span, and its own as-of."},"R3Coverage":{"properties":{"docs_in_force":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Docs In Force"},"requirements_served":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Requirements Served"},"requirements_pending":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Requirements Pending"},"requirements_withheld":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Requirements Withheld"},"exclusions_served":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Exclusions Served"},"exclusions_pending":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Exclusions Pending"},"exclusions_withheld":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Exclusions Withheld"},"documents_in_force":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Documents In Force"},"items_served":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Items Served"},"labels_pending":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Labels Pending"},"documents_unlabeled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Documents Unlabeled"},"labels_not_in_force":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Labels Not In Force"},"double_checked_served":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Double Checked Served"},"completeness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completeness"}},"additionalProperties":true,"type":"object","title":"R3Coverage","description":"The disclosure on a served R3 set: an approved subset, never asserted\ncomplete."},"R3Decision":{"properties":{"status":{"type":"string","title":"Status","description":"approved | rejected | needs_changes"},"decided_by":{"type":"string","title":"Decided By","description":"The portal's AdminUser identity; written to decided_by"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Free-text decision note"},"seen_hash":{"type":"string","title":"Seen Hash","description":"The content_hash the reviewer saw; a mismatch returns 409"},"seen_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Seen Codes","description":"Labels only: the codes the reviewer saw the label apply to; when they differ from the label's codes now, 409. Omit to skip the check"},"decided_by_coder_id":{"anyOf":[{"type":"string","pattern":"^C-[0-9]{3,}$"},{"type":"null"}],"title":"Decided By Coder Id","description":"Labels only (migration 231): the portal's coder ID for decided_by; admins only, never on a receipt"},"decided_by_certified":{"type":"boolean","title":"Decided By Certified","description":"Labels only (migration 231): decided_by is a certified coder. On an approval the label's codes are stored as certified_codes","default":false}},"type":"object","required":["status","decided_by","seen_hash"],"title":"R3Decision","description":"The decision body (spec §6.1 write seam)."},"R3Diff-Input":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Input"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Input"},{"type":"null"}]},"added":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3DiffItem"},"type":"array"},{"type":"null"}],"title":"Added"},"removed":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3DiffItem"},"type":"array"},{"type":"null"}],"title":"Removed"},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"R3Diff","description":"from and to are the legacy requirement shape (policy_clause) with\nrequirement_text always null. added and removed name each requirement that\nmoved by the hash of CMS's words and its coder labels; before 2026-10-16\nthey held Verzi's paraphrase strings."},"R3Diff-Output":{"properties":{"from":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Output"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Output"},{"type":"null"}]},"added":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3DiffItem"},"type":"array"},{"type":"null"}],"title":"Added"},"removed":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3DiffItem"},"type":"array"},{"type":"null"}],"title":"Removed"},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed"}},"additionalProperties":true,"type":"object","title":"R3Diff","description":"from and to are the legacy requirement shape (policy_clause) with\nrequirement_text always null. added and removed name each requirement that\nmoved by the hash of CMS's words and its coder labels; before 2026-10-16\nthey held Verzi's paraphrase strings."},"R3DiffItem":{"properties":{"quote_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Sha256"},"requirement_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Kind"},"rental_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rental Month"},"service_context":{"anyOf":[{},{"type":"null"}],"title":"Service Context"}},"additionalProperties":true,"type":"object","title":"R3DiffItem","description":"One requirement that moved between the two dates: the hash of CMS's\nwords it cites, plus its coder labels. No text (strict verbatim)."},"R3DocumentReceipt":{"properties":{"file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Renderer Version"},"capture_render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capture Render Sha256"},"capture_renderer_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capture Renderer Version"},"fetched_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fetched At"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"}},"additionalProperties":true,"type":"object","title":"R3DocumentReceipt","description":"The receipt for an unlabeled document: the archived file that holds\nthe version's bytes, its sha256, the text rendering its sections cite\n(render_sha256 and the renderer_version that made it), when Verzi\nfetched it, and the publisher URL it came from. When the cited rendering\nis a later one than the rendering made at capture (render.py 2.0.0,\ndocument order, beside 1.0.0), capture_render_sha256 and\ncapture_renderer_version name the capture rendering; both stay stored\nand verify."},"R3LabelClaimRefs":{"properties":{"decided_by":{"type":"string","title":"Decided By","description":"The portal's AdminUser identity; written to claim_refs_set_by"},"seen_hash":{"type":"string","title":"Seen Hash","description":"The label's content_hash the coder saw; a mismatch returns 409"},"denial_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Denial Ids","description":"Crosswalk denial ids, e.g. D3, D25"},"claim_items":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Claim Items","description":"CMS-1500 items, e.g. 11, 17b, 24B"}},"type":"object","required":["decided_by","seen_hash"],"title":"R3LabelClaimRefs","description":"The claim-refs body: the denial ids and claim items one label answers\n(migration 228). An omitted field is left as it is; null clears it to\n\"not said\"; a list (possibly empty) replaces it."},"R3LabelExtend":{"properties":{"target_label_id":{"type":"integer","title":"Target Label Id","description":"The approved label to extend"},"decided_by":{"type":"string","title":"Decided By","description":"The portal's AdminUser identity; written to merged_by and added_by"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"The audit note, stored on the pending label's decision_note"},"seen_hash":{"type":"string","title":"Seen Hash","description":"The pending label's content_hash the reviewer saw"},"seen_target_hash":{"type":"string","title":"Seen Target Hash","description":"The approved label's content_hash the reviewer saw"},"seen_codes":{"items":{"type":"string"},"type":"array","title":"Seen Codes","description":"The pending label's codes the reviewer saw"}},"type":"object","required":["target_label_id","decided_by","seen_hash","seen_target_hash","seen_codes"],"title":"R3LabelExtend","description":"The extend body: a pending label's codes join an approved label on the\nsame words, and the pending label merges into it."},"R3PassageDocument-Input":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Input"},"type":"array"},{"type":"null"}],"title":"Labels"},"double_checked_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Input"},"type":"array"},{"type":"null"}],"title":"Double Checked Items","description":"Labels double-checked by two independent automated reviews from different model families plus Verzi's rule checks, not yet reviewed by a certified coder. Never approved, never in sections[].items or labels, never counted in items_served, and they may change when a coder reviews them. Each carries tier 'double_checked', tier_note, its quote_span, and its section's heading and citation. passage_text appears only where every approved item gets it (a caller with the receipt capability); unlike approved items, a double-checked item is never the free sample. The sections still serve in full."},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/R3VersionInForce"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/R3DocumentReceipt"},{"type":"null"}]},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageSection-Input"},"type":"array"},{"type":"null"}],"title":"Sections"},"section_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Reason"},"document_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Text"},"text_available":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Text Available"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"R3PassageDocument","description":"One in-force document: its as-of resolution and its sections.\n\nlabel_status: 'labeled' (at least one approved label of a requirement\nkind for the code serves from registered sections that verify) or\n'unlabeled' (none does; the document serves with its title, version and\nreceipt; approved labels of a non-requirement kind, such as\nrefill_exempt, then serve in labels). In\nreceipts.r3 an unlabeled document's sections hold an LCD's coverage-\nindications and documentation-requirements sections, or an Article's\ntext, each with CMS's words, marked unlabeled (Article A55426, related to every\nDME LCD, stays cited with no section text); section_reason says why none\nserves: section_not_registered (no verified registered section with that\nkey) or licensed_text (every one is held). receipts.r3 never carries\ndocument_text. The\nentitled KB code page (GET /kb/code/{hcpcs}/passages, a KB session or\nan entitled X-API-Key) gets document_text, the full verbatim rendering\nof the version. There, text_available is false when the rendering did\nnot load or did not match render_sha256: no text serves (fail\nclosed). text_withheld 'rendering_not_in_document_order' says the\nrendering is not verified to keep CMS's word order, so no text\nserves."},"R3PassageDocument-Output":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Output"},"type":"array"},{"type":"null"}],"title":"Labels"},"double_checked_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Output"},"type":"array"},{"type":"null"}],"title":"Double Checked Items","description":"Labels double-checked by two independent automated reviews from different model families plus Verzi's rule checks, not yet reviewed by a certified coder. Never approved, never in sections[].items or labels, never counted in items_served, and they may change when a coder reviews them. Each carries tier 'double_checked', tier_note, its quote_span, and its section's heading and citation. passage_text appears only where every approved item gets it (a caller with the receipt capability); unlike approved items, a double-checked item is never the free sample. The sections still serve in full."},"version_in_force":{"anyOf":[{"$ref":"#/components/schemas/R3VersionInForce"},{"type":"null"}]},"receipt":{"anyOf":[{"$ref":"#/components/schemas/R3DocumentReceipt"},{"type":"null"}]},"sections":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageSection-Output"},"type":"array"},{"type":"null"}],"title":"Sections"},"section_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Reason"},"document_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Text"},"text_available":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Text Available"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"R3PassageDocument","description":"One in-force document: its as-of resolution and its sections.\n\nlabel_status: 'labeled' (at least one approved label of a requirement\nkind for the code serves from registered sections that verify) or\n'unlabeled' (none does; the document serves with its title, version and\nreceipt; approved labels of a non-requirement kind, such as\nrefill_exempt, then serve in labels). In\nreceipts.r3 an unlabeled document's sections hold an LCD's coverage-\nindications and documentation-requirements sections, or an Article's\ntext, each with CMS's words, marked unlabeled (Article A55426, related to every\nDME LCD, stays cited with no section text); section_reason says why none\nserves: section_not_registered (no verified registered section with that\nkey) or licensed_text (every one is held). receipts.r3 never carries\ndocument_text. The\nentitled KB code page (GET /kb/code/{hcpcs}/passages, a KB session or\nan entitled X-API-Key) gets document_text, the full verbatim rendering\nof the version. There, text_available is false when the rendering did\nnot load or did not match render_sha256: no text serves (fail\nclosed). text_withheld 'rendering_not_in_document_order' says the\nrendering is not verified to keep CMS's word order, so no text\nserves."},"R3PassageItem-Input":{"properties":{"item_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Item Id"},"marker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marker"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"quote_span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"passage_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Passage Text"},"sample":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sample"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"},"related_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Related Code"},"label_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Note"},"review_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Review Note"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier"},"tier_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier Note"},"machine_check_run":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Check Run"}},"additionalProperties":true,"type":"object","title":"R3PassageItem","description":"One served label: a Verzi finding aid pinned to a verbatim quote.\nmarker is CMS's own letter or number, null when CMS used none; it is\nnever invented (docs/VERBATIM_DECISION.md). passage_text appears only\nfor display-licensed keys."},"R3PassageItem-Output":{"properties":{"item_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Item Id"},"marker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marker"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"quote_span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"passage_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Passage Text"},"sample":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sample"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"},"related_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Related Code"},"label_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Note"},"review_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Review Note"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier"},"tier_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier Note"},"machine_check_run":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Check Run"}},"additionalProperties":true,"type":"object","title":"R3PassageItem","description":"One served label: a Verzi finding aid pinned to a verbatim quote.\nmarker is CMS's own letter or number, null when CMS used none; it is\nnever invented (docs/VERBATIM_DECISION.md). passage_text appears only\nfor display-licensed keys."},"R3PassageSection-Input":{"properties":{"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"label_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Note"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Input"},"type":"array"},{"type":"null"}],"title":"Items"},"section_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Text"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"R3PassageSection","description":"One registered section of the in-force version: the source's own\nheading, the span citation into the pinned rendering, and the served\nlabels. section_text appears only for display-licensed keys.\n\nIn an unlabeled document (receipts.r3 since 2026-10-16), a section is an\nLCD's coverage-indications or documentation-requirements section\n(Associated Information) or an Article's text: section_key is the\npublisher's own key,\nsection_text is CMS's words at the span, label_status is 'unlabeled' and\nlabel_note is Verzi's note that no coder label points into it. A held\nsection has text_withheld 'licensed_text' and no text."},"R3PassageSection-Output":{"properties":{"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"},"label_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Note"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3PassageItem-Output"},"type":"array"},{"type":"null"}],"title":"Items"},"section_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Text"},"redactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/R3Redaction"},"type":"array"},{"type":"null"}],"title":"Redactions"},"text_withheld":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Withheld"}},"additionalProperties":true,"type":"object","title":"R3PassageSection","description":"One registered section of the in-force version: the source's own\nheading, the span citation into the pinned rendering, and the served\nlabels. section_text appears only for display-licensed keys.\n\nIn an unlabeled document (receipts.r3 since 2026-10-16), a section is an\nLCD's coverage-indications or documentation-requirements section\n(Associated Information) or an Article's text: section_key is the\npublisher's own key,\nsection_text is CMS's words at the span, label_status is 'unlabeled' and\nlabel_note is Verzi's note that no coder label points into it. A held\nsection has text_withheld 'licensed_text' and no text."},"R3Redaction":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"R3Redaction","description":"A gap in served text: Verzi left out licensed words CMS quotes (issue\n#365). The text carries a plain note in their place; the receipt still\nnames the source bytes, so a reader can see the quote is not complete.\nAfter a redaction the served text is not the rendering: spans and\noffsets still index the rendering named by render_sha256, and the\nserved text no longer hashes to it."},"R3Requirement-Input":{"properties":{"requirement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Text","description":"Deprecated: always null since 2026-10-16 (it held Verzi's paraphrase; strict verbatim). Removed on or after 2026-12-01.","deprecated":true},"requirement_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Kind"},"rental_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rental Month"},"service_context":{"anyOf":[{},{"type":"null"}],"title":"Service Context"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"confidence_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Tier"},"applicability_effect":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applicability Effect"}},"additionalProperties":true,"type":"object","title":"R3Requirement","description":"One served requirement or exclusion, with its own citation. CMS's words\nare at citation (render_sha256 + span). requirement_text is deprecated and\nalways null: it held Verzi's paraphrase (strict verbatim, 2026-10-16).\nrequirement_kind is a Verzi coder label, not CMS's words."},"R3Requirement-Output":{"properties":{"requirement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Text","description":"Deprecated: always null since 2026-10-16 (it held Verzi's paraphrase; strict verbatim). Removed on or after 2026-12-01.","deprecated":true},"requirement_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requirement Kind"},"rental_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rental Month"},"service_context":{"anyOf":[{},{"type":"null"}],"title":"Service Context"},"citation":{"anyOf":[{"$ref":"#/components/schemas/R3Citation"},{"type":"null"}]},"confidence_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Tier"},"applicability_effect":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applicability Effect"}},"additionalProperties":true,"type":"object","title":"R3Requirement","description":"One served requirement or exclusion, with its own citation. CMS's words\nare at citation (render_sha256 + span). requirement_text is deprecated and\nalways null: it held Verzi's paraphrase (strict verbatim, 2026-10-16).\nrequirement_kind is a Verzi coder label, not CMS's words."},"R3SampleDecision":{"properties":{"label_id":{"type":"integer","title":"Label Id"},"status":{"type":"string","title":"Status","description":"The coder's decision on this sampled label"},"seen_hash":{"type":"string","title":"Seen Hash","description":"The label's content_hash the coder saw"},"seen_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Seen Codes"}},"type":"object","required":["label_id","status","seen_hash"],"title":"R3SampleDecision"},"R3VersionInForce":{"properties":{"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"},"version_in_force":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version In Force"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"effective_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective To"},"effective_from_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From Source"},"published_on_dos":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Published On Dos","description":"Present only when CMS later made the version in force retroactive: the version CMS had published on the date of service. The version in force does not change. Keys: version, version_id, updated_on and effective_from (the published version's row), version_in_force_updated_on, date_source ('mcd_public_versions_updated_on': the Updated On column of CMS's Public Versions table in the archived MCD pages), citations (version_in_force and published_on_dos: each the version_id, file_id, render_sha256 and span of that version's own row in its archived page's rendering) and verzi_note (Verzi's plain sentence, not CMS's words). Absent whenever the archive does not prove which version was published on the date of service."}},"additionalProperties":true,"type":"object","title":"R3VersionInForce","description":"The publisher version in force on the DOS and CMS's stated window.\neffective_from_source says where the start date came from: 'bytes'\n(stated in the archived bytes) or 'transmittal'; null when undated.\npublished_on_dos is present only when CMS posted this version after the\nDOS and made it retroactive: it names the version CMS had published on\nthe DOS (see the field's description)."},"ReceiptBlocks-Input":{"properties":{"r0":{"anyOf":[{"$ref":"#/components/schemas/R0Block-Input"},{"type":"null"}]},"r0_ordering":{"anyOf":[{"$ref":"#/components/schemas/R0Block-Input"},{"type":"null"}]},"r1":{"anyOf":[{"$ref":"#/components/schemas/R1Block-Input"},{"type":"null"}]},"r2":{"anyOf":[{"$ref":"#/components/schemas/R2Block-Input"},{"type":"null"}]},"r3":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Input"},{"type":"null"}]},"exclusions":{"anyOf":[{"$ref":"#/components/schemas/ExclusionsBlock-Input"},{"type":"null"}]},"applicability":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Input"},{"type":"null"}]},"prior_authorization":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthorizationBlock-Input"},{"type":"null"}]},"code":{"anyOf":[{"$ref":"#/components/schemas/CodeBlock-Input"},{"type":"null"}]},"timely_filing":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingBlock-Input"},{"type":"null"}]},"modifiers":{"anyOf":[{"$ref":"#/components/schemas/ModifiersBlock-Input"},{"type":"null"}]},"competitive_bidding":{"anyOf":[{"$ref":"#/components/schemas/CompetitiveBiddingBlock-Input"},{"type":"null"}]},"face_to_face_wopd":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdBlock-Input"},{"type":"null"}]},"ncd":{"anyOf":[{"$ref":"#/components/schemas/NcdBlock-Input"},{"type":"null"}]},"icd10_lists":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListsBlock-Input"},{"type":"null"}]},"medicare_advantage":{"anyOf":[{"$ref":"#/components/schemas/MedicareAdvantageBlock-Input"},{"type":"null"}]},"rule_passages":{"anyOf":[{"$ref":"#/components/schemas/RulePassagesBlock"},{"type":"null"}]},"dme_mac":{"anyOf":[{"$ref":"#/components/schemas/DmeMacBlock-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ReceiptBlocks"},"ReceiptBlocks-Output":{"properties":{"r0":{"anyOf":[{"$ref":"#/components/schemas/R0Block-Output"},{"type":"null"}]},"r0_ordering":{"anyOf":[{"$ref":"#/components/schemas/R0Block-Output"},{"type":"null"}]},"r1":{"anyOf":[{"$ref":"#/components/schemas/R1Block-Output"},{"type":"null"}]},"r2":{"anyOf":[{"$ref":"#/components/schemas/R2Block-Output"},{"type":"null"}]},"r3":{"anyOf":[{"$ref":"#/components/schemas/R3Block-Output"},{"type":"null"}]},"exclusions":{"anyOf":[{"$ref":"#/components/schemas/ExclusionsBlock-Output"},{"type":"null"}]},"applicability":{"anyOf":[{"$ref":"#/components/schemas/ApplicabilityBlock-Output"},{"type":"null"}]},"prior_authorization":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthorizationBlock-Output"},{"type":"null"}]},"code":{"anyOf":[{"$ref":"#/components/schemas/CodeBlock-Output"},{"type":"null"}]},"timely_filing":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingBlock-Output"},{"type":"null"}]},"modifiers":{"anyOf":[{"$ref":"#/components/schemas/ModifiersBlock-Output"},{"type":"null"}]},"competitive_bidding":{"anyOf":[{"$ref":"#/components/schemas/CompetitiveBiddingBlock-Output"},{"type":"null"}]},"face_to_face_wopd":{"anyOf":[{"$ref":"#/components/schemas/FaceToFaceWopdBlock-Output"},{"type":"null"}]},"ncd":{"anyOf":[{"$ref":"#/components/schemas/NcdBlock-Output"},{"type":"null"}]},"icd10_lists":{"anyOf":[{"$ref":"#/components/schemas/Icd10ListsBlock-Output"},{"type":"null"}]},"medicare_advantage":{"anyOf":[{"$ref":"#/components/schemas/MedicareAdvantageBlock-Output"},{"type":"null"}]},"rule_passages":{"anyOf":[{"$ref":"#/components/schemas/RulePassagesBlock"},{"type":"null"}]},"dme_mac":{"anyOf":[{"$ref":"#/components/schemas/DmeMacBlock-Output"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ReceiptBlocks"},"ReceiptMeta":{"properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generated At"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"crosswalk":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Crosswalk"},"filtered_out":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Filtered Out"},"filters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Filters"},"denial":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Denial"},"claim_item":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Claim Item"},"claim_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Type"},"claim_format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Format"},"claim_type_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Type Status"},"claim_type_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Type Reason"},"claim_types":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Claim Types"}},"additionalProperties":true,"type":"object","title":"ReceiptMeta","description":"crosswalk: the scope the block labels read and what they are (each\nblock's `crosswalk` is a Verzi Health label, never CMS text).\nfiltered_out: every block a use / claim_item / denial filter left out\n(empty when none was). filters: the filters given. denial: the denial\nrow a denial filter names, with its outcome (returned | denied | check).\nclaim_item: the field-map row a claim_item filter names, with its status.\nclaim_type, claim_format: the claim type the answer is for and its\nclaim_format, derived per payer scope (claim_type_param.py).\nclaim_type_status: filled | in_progress | not_started | partial; a\nnot_started answer carries no receipts. claim_type_reason says why an\nanswer is not complete. claim_types: one entry per claim type asked for\n(claim_type, claim_format, status, served, rows_tagged, rows_filled,\nreason)."},"ReceiptQuery":{"properties":{"hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hcpcs"},"companion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Companion"},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi"},"ordering_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ordering Npi"},"payer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payer"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"cba":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cba"},"rural":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rural"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"modifier2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier2"},"beneficiary_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary State"}},"additionalProperties":true,"type":"object","title":"ReceiptQuery"},"ReceiptResponse":{"properties":{"query":{"anyOf":[{"$ref":"#/components/schemas/ReceiptQuery"},{"type":"null"}]},"provider_context":{"anyOf":[{"$ref":"#/components/schemas/ProviderContext"},{"type":"null"}]},"receipts":{"anyOf":[{"$ref":"#/components/schemas/ReceiptBlocks-Output"},{"type":"null"}]},"confidence":{"anyOf":[{"$ref":"#/components/schemas/ConfidenceSummary"},{"type":"null"}]},"usable_for":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Usable For"},"usable_for_claim_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Usable For Claim Types"},"payer":{"anyOf":[{"$ref":"#/components/schemas/PayerBlock"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/ReceiptMeta"},{"type":"null"}]},"attestation":{"anyOf":[{"$ref":"#/components/schemas/Attestation"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ReceiptResponse","description":"GET /rules/receipt: one object per receipt, each with its own fact and\nreceipt, or an honest gap state. No cross-receipt boolean."},"RequiredWhen":{"properties":{"row":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row"},"at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"At"},"passages":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Passages"},"pending_bounds":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pending Bounds"},"label_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label Status"}},"additionalProperties":true,"type":"object","title":"RequiredWhen","description":"receipts.modifiers.required_when: where CMS states when a modifier is\nrequired (crosswalk row D6), as pointers into receipts.rule_passages (no\nsecond copy of the words): each passage's ref, status and, for the code's\nArticles, the document, version and section citations. pending_bounds\nnames the narrower passage a coder has to bound; label_status is\npending_coder_label while any is open."},"RuleCitation":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"}},"additionalProperties":true,"type":"object","title":"RuleCitation","description":"The receipt on a parsed-rules fact (PTP, MUE, fee cell)."},"RulePassage":{"properties":{"ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref"},"cite":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cite"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"paragraph":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paragraph"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"answers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Answers"},"number_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number Basis"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"reason_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason Detail"},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Heading"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"redactions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Redactions"},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"version_in_force":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Version In Force"},"receipt":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Receipt"},"chain":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Chain"},"basis":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Basis"},"documents":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Documents"}},"additionalProperties":true,"type":"object","title":"RulePassage","description":"One section reference resolved on the DOS. kind: cfr | manual |\ncode_article_text | unsectioned | not_held. status: served (text is the\nwhole section, or the CFR paragraph named, verbatim) | deleted | not_held\n(no version in force on the DOS, with the archive's reason, or not held\nat all) | unknown (held, not located or not servable: reason such as\nsection_not_found, section_end_not_source_note, heading_mismatch,\ntext_withheld, chapter_not_supported_yet,\nrendering_not_in_document_order) | not_linked (held, no section reader:\nno_section_reader). answers: the crosswalk rows it answers. receipt: the\nfile, version, hashes, span, quote_sha256 and source_proof. documents:\ncode_article_text only, one entry per Article with its sections."},"RulePassagesBlock":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"rows":{"anyOf":[{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Rows"},"counts":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Counts"},"passages":{"anyOf":[{"items":{"$ref":"#/components/schemas/RulePassage"},"type":"array"},{"type":"null"}],"title":"Passages"},"pending_bounds":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pending Bounds"}},"additionalProperties":true,"type":"object","title":"RulePassagesBlock","description":"receipts.rule_passages: the CMS section that decides each crosswalk\nrow (denial ids D2 to D46, CMS-1500 items such as '11'), quoted whole from\nthe version in force on the DOS. rows: row id -> passage refs. status: ok\n(at least one passage serves) | unknown (no_passage_served) |\nnot_yet_available. counts: passages per status. pending_bounds: places\nwhere the rule is narrower than a section and a coder must set the\nbounds; none is approved. Never weighed in the confidence rollup."},"SamExclusionRecord":{"properties":{"sam_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sam Number"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification"},"active_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active Date"},"termination_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Text"},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Date"},"exclusion_program":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusion Program"},"excluding_agency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excluding Agency"},"exclusion_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusion Type"},"ct_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ct Code"},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Status"},"additional_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Comments"}},"additionalProperties":true,"type":"object","title":"SamExclusionRecord"},"SendOTPRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"SendOTPRequest"},"SigningKeyResponse":{"properties":{"alg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alg"},"kid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kid"},"canonicalization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonicalization"},"public_key_b64url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key B64Url"},"public_key_pem":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key Pem"},"verify":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verify"}},"additionalProperties":true,"type":"object","title":"SigningKeyResponse","description":"GET /rules/receipt/signing-key: the public key and the verify recipe."},"Span":{"properties":{"start":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"}},"additionalProperties":true,"type":"object","title":"Span"},"StandingEnrollment-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"enrollments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EnrollmentRow"},"type":"array"},{"type":"null"}],"title":"Enrollments"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingEnrollment","description":"status: unknown | ok. coverage here is a STRING (dense | sparse)."},"StandingEnrollment-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"enrollments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EnrollmentRow"},"type":"array"},{"type":"null"}],"title":"Enrollments"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingEnrollment","description":"status: unknown | ok. coverage here is a STRING (dense | sparse)."},"StandingExclusion-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/ExclusionCoverage"},{"type":"null"}]},"excluded_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Excluded On Dos"},"records":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExclusionRecord"},"type":"array"},{"type":"null"}],"title":"Records"},"waiver_present":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Waiver Present"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/ExclusionReceipt"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"StandingExclusion","description":"LEIE exclusion on the DOS, with the snapshot receipt. excluded_on_dos is\nnull with status \"unknown\" and a reason when the archive cannot prove the\nanswer (spec §3.2, principle 7)."},"StandingExclusion-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"coverage":{"anyOf":[{"$ref":"#/components/schemas/ExclusionCoverage"},{"type":"null"}]},"excluded_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Excluded On Dos"},"records":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExclusionRecord"},"type":"array"},{"type":"null"}],"title":"Records"},"waiver_present":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Waiver Present"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/ExclusionReceipt"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"additionalProperties":true,"type":"object","title":"StandingExclusion","description":"LEIE exclusion on the DOS, with the snapshot receipt. excluded_on_dos is\nnull with status \"unknown\" and a reason when the archive cannot prove the\nanswer (spec §3.2, principle 7)."},"StandingLicense":{"properties":{"as_of_available":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"As Of Available"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"see":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"See"},"current_state":{"anyOf":[{"$ref":"#/components/schemas/LicenseCurrentState"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingLicense"},"StandingListReceipt":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"source_list":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source List"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"snapshot_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snapshot Date"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"StandingListReceipt","description":"The receipt of a parsed list (SAM.gov exclusions, Medicare opt-outs).\nsource_list names the list a hit came from, so a caller never reads it as\nan OIG LEIE answer."},"StandingMedicareOptOut":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"source_list":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source List"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"opted_out_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Opted Out On Dos"},"records":{"anyOf":[{"items":{"$ref":"#/components/schemas/OptOutRecord"},"type":"array"},{"type":"null"}],"title":"Records"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/StandingListReceipt"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"coverage_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage Note"}},"additionalProperties":true,"type":"object","title":"StandingMedicareOptOut","description":"Medicare opt-out on the DOS. status unknown carries a reason."},"StandingOrderReferring-Input":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"eligibility":{"anyOf":[{"$ref":"#/components/schemas/OrderReferringEligibility"},{"type":"null"}]},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingOrderReferring","description":"status: unknown | ok. coverage is a STRING (dense | sparse)."},"StandingOrderReferring-Output":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Found"},"eligibility":{"anyOf":[{"$ref":"#/components/schemas/OrderReferringEligibility"},{"type":"null"}]},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/EditionReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingOrderReferring","description":"status: unknown | ok. coverage is a STRING (dense | sparse)."},"StandingResponse":{"properties":{"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingExclusion-Output"},{"type":"null"}]},"supplier_directory":{"anyOf":[{"$ref":"#/components/schemas/StandingSupplierDirectory"},{"type":"null"}]},"enrollment":{"anyOf":[{"$ref":"#/components/schemas/StandingEnrollment-Output"},{"type":"null"}]},"sam_exclusion":{"anyOf":[{"$ref":"#/components/schemas/StandingSamExclusion"},{"type":"null"}]},"medicare_opt_out":{"anyOf":[{"$ref":"#/components/schemas/StandingMedicareOptOut"},{"type":"null"}]},"order_referring":{"anyOf":[{"$ref":"#/components/schemas/StandingOrderReferring-Output"},{"type":"null"}]},"license":{"anyOf":[{"$ref":"#/components/schemas/StandingLicense"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingResponse","description":"GET /provider/{npi}/standing: one block per fact, each with its own\nreceipt. No single boolean."},"StandingSamExclusion":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"source_list":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source List"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"listed_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Listed On Dos"},"records":{"anyOf":[{"items":{"$ref":"#/components/schemas/SamExclusionRecord"},"type":"array"},{"type":"null"}],"title":"Records"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/StandingListReceipt"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage"},"coverage_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coverage Note"}},"additionalProperties":true,"type":"object","title":"StandingSamExclusion","description":"SAM.gov exclusion on the DOS. status unknown carries a reason."},"StandingSupplierDirectory":{"properties":{"present_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Present On Dos"},"resolvable_by_npi":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resolvable By Npi"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/SupplierReceipt"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"StandingSupplierDirectory"},"SubscriptionCreate":{"properties":{"channel":{"type":"string","enum":["email","webhook"],"title":"Channel"},"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}],"title":"Email","description":"Required when channel=email"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Webhook Url","description":"Required when channel=webhook (https only)"},"codes":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Codes","description":"HCPCS codes to watch; omit for no code filter"},"source_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Source Ids","description":"Archive source ids to watch; omit for all public sources"}},"type":"object","required":["channel"],"title":"SubscriptionCreate"},"SupplierReceipt":{"properties":{"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"member_file_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Member File Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"snapshot_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snapshot Date"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"boundary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Boundary"}},"additionalProperties":true,"type":"object","title":"SupplierReceipt"},"TimelyFilingBlock-Input":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"regulation":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingQuote-Input"},{"type":"null"}]},"manual":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingQuote-Input"},{"type":"null"}]},"manual_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manual Reason"}},"additionalProperties":true,"type":"object","title":"TimelyFilingBlock","description":"receipts.timely_filing: CMS's words for the claim filing time limit. It\nquotes the rule; it states no deadline date and never says a claim is on\ntime. status: ok | unknown | not_yet_available. reason (unknown): the\narchive's as-of reason when no eCFR version is in force\n(before_first_stated_start, after_last_stated_end,\ngap_between_stated_windows, not_observed_on_date, no_versions,\nonly_defective_versions), or\nno_version_in_force, rendering_not_held, section_not_found (the heading\nor the (a) paragraph moved), text_not_servable (the license rule or the\ndocument-order rule refuses the quote). manual_reason (ok, no manual\nquote): manual_not_held, section_not_found, before_stated_effective,\ntext_not_servable. No\nnon-ok block is weighed in the confidence rollup."},"TimelyFilingBlock-Output":{"properties":{"receipt_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Kind"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"regulation":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingQuote-Output"},{"type":"null"}]},"manual":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingQuote-Output"},{"type":"null"}]},"manual_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manual Reason"}},"additionalProperties":true,"type":"object","title":"TimelyFilingBlock","description":"receipts.timely_filing: CMS's words for the claim filing time limit. It\nquotes the rule; it states no deadline date and never says a claim is on\ntime. status: ok | unknown | not_yet_available. reason (unknown): the\narchive's as-of reason when no eCFR version is in force\n(before_first_stated_start, after_last_stated_end,\ngap_between_stated_windows, not_observed_on_date, no_versions,\nonly_defective_versions), or\nno_version_in_force, rendering_not_held, section_not_found (the heading\nor the (a) paragraph moved), text_not_servable (the license rule or the\ndocument-order rule refuses the quote). manual_reason (ok, no manual\nquote): manual_not_held, section_not_found, before_stated_effective,\ntext_not_servable. No\nnon-ok block is weighed in the confidence rollup."},"TimelyFilingQuote-Input":{"properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"text_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text As Of"},"revision":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingRevision"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"TimelyFilingQuote","description":"CMS's words, a slice of a stored rendering: text[span.start:span.end] ==\nquote. section is Verzi's label of where the words sit. as_of is the\narchive's answer for the DOS (regulation only). text_as_of is set for an\nannual CFR edition: the text in force on that one date."},"TimelyFilingQuote-Output":{"properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"version_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Id"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"render_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Render Sha256"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"as_of":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"As Of"},"text_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text As Of"},"revision":{"anyOf":[{"$ref":"#/components/schemas/TimelyFilingRevision"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"TimelyFilingQuote","description":"CMS's words, a slice of a stored rendering: text[span.start:span.end] ==\nquote. section is Verzi's label of where the words sit. as_of is the\narchive's answer for the DOS (regulation only). text_as_of is set for an\nannual CFR edition: the text in force on that one date."},"TimelyFilingRevision":{"properties":{"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote"},"span":{"anyOf":[{"$ref":"#/components/schemas/Span"},{"type":"null"}]},"stated_effective":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stated Effective"}},"additionalProperties":true,"type":"object","title":"TimelyFilingRevision","description":"The section's own revision line, quoted, and the date it states."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerifyOTPRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"code":{"type":"string","title":"Code"}},"type":"object","required":["email","code"],"title":"VerifyOTPRequest"},"WatchlistCreate":{"properties":{"name":{"type":"string","title":"Name"},"portfolio_id":{"type":"integer","title":"Portfolio Id"},"conditions":{"additionalProperties":true,"type":"object","title":"Conditions"},"notify_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notify Email"}},"type":"object","required":["name","portfolio_id","conditions"],"title":"WatchlistCreate"}},"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","description":"Your Verzi API key. Get a free key at https://docs.verzi.health/signup.","in":"header","name":"X-API-Key"},"BearerApiKey":{"type":"http","description":"The same Verzi API key sent as Authorization: Bearer","scheme":"bearer"}}}}