{"info":{"title":"HANK_CODESETS API","version":"2026.8.13+build.05a79f7","description":"JSON API over the HANK_CODESETS library - look up CPT / ICD / HCPCS / modifier / HCC codes, check rules, walk crosswalks, browse the DB.\n\n**Authentication.** This API is token-based - there is **no login or session**. Get an access token at [console.hank.ai](https://console.hank.ai) and send it as `Authorization: Bearer <token>` on **every** request. On this page, click **Authorize** (top-right), paste just the token, and *Try it out* will send it for you. (Auth is enforced only when the server runs with `HANK_CODESETS_AUTH_REQUIRED=1`.)\n\n**Base URL.** Production requests go through the metered Hank edge at `https://api.hank.ai/v1/codesets` - calling the backend host directly bypasses metering and the edge auth path.\n\n**Rate limiting.** A 429 carries `Retry-After` (delta-seconds) plus the `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset` (unix epoch) family so a client can back off without parsing prose. The ScrapeGuard limit is **coverage-based** (distinct codes per rolling window, not request rate), so `Limit` is that coverage threshold and `Remaining` is what's left before it trips. Control-plane rate/credit refusals return 429/402 and include `Retry-After` when the back-off is known. On MCP (`/mcp`) the same back-off rides the tool error message as `retry_after_s=<n>`."},"paths":{"/api/info":{"get":{"tags":["system"],"summary":"Info","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Info Api Info Get","additionalProperties":true}}},"description":"Successful Response"}},"operationId":"info_api_info_get"}},"/api/nubc":{"get":{"tags":["medicaid","nubc"],"summary":"Nubc Code Sets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Nubc Code Sets Api Nubc Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"The UB-04 code sets this backend carries, plus the full declared vocabulary -\nthe enumeration a caller needs before addressing /api/nubc/{code_set}. Set NAMES\nonly (no AHA content), so it is not license-gated.","operationId":"nubc_code_sets_api_nubc_get"}},"/api/groups":{"get":{"tags":["groups"],"summary":"List Groups","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response List Groups Api Groups Get","additionalProperties":true}}},"description":"Successful Response"}},"operationId":"list_groups_api_groups_get"}},"/api/health":{"get":{"tags":["system"],"summary":"Health","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Health Api Health Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Cheap data-presence check. Returns 200 either way; ``status`` is the signal.","operationId":"health_api_health_get"}},"/api/search":{"get":{"tags":["search"],"summary":"Search","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Search Api Search Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"q","schema":{"type":"string","title":"Q","maxLength":200,"minLength":1,"description":"Free-text query"},"required":true,"description":"Free-text query"},{"in":"query","name":"types","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Types","description":"Comma-separated codeset filter: CPT,ICD,MOD,HCC,RBCS"},"required":false,"description":"Comma-separated codeset filter: CPT,ICD,MOD,HCC,RBCS"},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":20,"maximum":100,"minimum":1},"required":false},{"in":"query","name":"rerank","schema":{"type":"boolean","title":"Rerank","default":true,"description":"Cross-encoder precision rerank of the top-K (default on; ~17ms warm)."},"required":false,"description":"Cross-encoder precision rerank of the top-K (default on; ~17ms warm)."},{"in":"query","name":"suggest","schema":{"type":"boolean","title":"Suggest","default":false,"description":"Typeahead/as-you-type mode: skips the cross-encoder rerank (~halves latency) for a fast, recall-oriented suggest. Use per-keystroke; the Redis result-cache makes repeats ~1ms."},"required":false,"description":"Typeahead/as-you-type mode: skips the cross-encoder rerank (~halves latency) for a fast, recall-oriented suggest. Use per-keystroke; the Redis result-cache makes repeats ~1ms."}],"description":"Rank-ordered free-text search across CPT / ICD / MOD / HCC / RBCS.","operationId":"search_api_search_get"}},"/api/hcc/raf":{"post":{"tags":["hcc"],"summary":"Compute Raf","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Compute Raf Api Hcc Raf Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Compute and itemize a CMS-HCC RAF score. 422 on a bad segment/sex/inputs;\na deterministic ``{available: false}`` shell when the multi-segment HCC\ntables aren't deployed on this backend (never a 500). The\n``X-Hank-Availability`` header mirrors the shell; ``?strict`` makes a\nnot_deployed answer a 503.","operationId":"compute_raf_api_hcc_raf_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RafRequest"}}},"required":true}}},"/api/version":{"get":{"tags":["system"],"summary":"Version","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Version Api Version Get","additionalProperties":true}}},"description":"Successful Response"}},"operationId":"version_api_version_get"}},"/api/coverage":{"get":{"tags":["system"],"summary":"Coverage","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Coverage Api Coverage Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"counts","schema":{"type":"boolean","title":"Counts","default":true,"description":"Include row counts per served dataset. A count is an exact COUNT(*) served from a per-process TTL cache (HANK_CODESETS_COVERAGE_COUNT_TTL_S, default 900s), so it can be that old: read counted_at / count_age_s on each entry and the envelope's counts block. Pass false to skip the reads entirely."},"required":false,"description":"Include row counts per served dataset. A count is an exact COUNT(*) served from a per-process TTL cache (HANK_CODESETS_COVERAGE_COUNT_TTL_S, default 900s), so it can be that old: read counted_at / count_age_s on each entry and the envelope's counts block. Pass false to skip the reads entirely."}],"description":"The coverage attestation: every domain this library names, in one of four\ndispositions - ``served`` (with counts + vintages), ``built_to_ready``\n(awaiting data or a license, or gated for this caller), ``out_of_scope``\n(another system owns it), or ``permanent_gap`` (settled, do not re-open).\n\nDerived entirely from the dataset registry, the license terms, and the\nstructured coverage dispositions - no coverage claim is hand-written.\n``attestation_version`` is the registry content hash; it matches the\ncommitted ``docs/coverage/attestation.html`` when this deployment runs the\nregistry that receipt attests to.\n\nA row count covers that entry's OWN tables. Two entries can share a physical\ntable (``cpt`` and ``hcpcs``), so do not sum ``row_count`` across entries.\nCounts are exact ``COUNT(*)`` reads served from a per-process TTL cache, so a\nreseed applied elsewhere is not visible until it lapses: every entry carries\n``counted_at`` and ``count_age_s``, and the envelope's ``counts`` block names\nthe TTL.","operationId":"coverage_api_coverage_get"}},"/api/rag/push":{"post":{"tags":["rag"],"summary":"Rag Push","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rag Push Api Rag Push Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Accept a some-or-all push and run it ASYNCHRONOUSLY.\n\n``confirm: true`` is mandatory: without it the request is rejected here\nBEFORE the store or manager is touched. On accept, this validates + writes\nthe ``started`` ledger rows in-request (fast, provider-free) and returns 202\nwith the push ids IMMEDIATELY; the multi-MB regenerate->upload runs on a\nbackground executor and flips each ledger row as it completes. Poll\n``GET /api/rag/status`` (rows surface as ``in_progress``) to watch it land.","operationId":"rag_push_api_rag_push_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushIn"}}},"required":true}}},"/api/changelog":{"get":{"tags":["system"],"summary":"Changelog","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Successful Response"}},"description":"The API-consumer changelog + deprecation policy, served as raw Markdown.\n\nPublic (allowlisted in the auth middleware) and not metered: it is\ndocumentation, like ``/api/version``. The OpenAPI schema at ``/openapi.json``\nstays the contract of record; this narrates the changes to it.","operationId":"changelog_api_changelog_get"}},"/api/freshness":{"get":{"tags":["system"],"summary":"Freshness","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Freshness Api Freshness Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Per-dataset data freshness (consumer-safe). Each entry: ``key``,\n``version`` (vintage label), ``as_of`` (last applied), ``checked_at``,\n``cadence``, ``auto`` (self-refreshes?), and a single ``stale`` bool\n(overdue / failed / alarming). Top level carries the ``data_version``\nchange-stamp, the newest ``as_of``, and ``degraded`` (freshness state itself\nunreadable). Degrades to an empty board on a backend without the updater\ntables rather than erroring.","operationId":"freshness_api_freshness_get"}},"/api/rag/retry":{"post":{"tags":["rag"],"summary":"Rag Retry","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rag Retry Api Rag Retry Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Retry a SINGLE store = a push scoped to exactly one (code_type, provider).\n\nSame confirm gate + editor auth as /rag/push. A new ``started`` ledger row is\nwritten for that one store and the regenerate->upload runs on the background\nexecutor; the store's drift warning clears only when THIS retry lands\n``succeeded`` (a ``started`` or ``failed`` retry never clears it, because the\ndrift baseline reads the last ``succeeded`` row). Unknown pair -> 422.","operationId":"rag_retry_api_rag_retry_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryIn"}}},"required":true}}},"/api/rxhcc/raf":{"post":{"tags":["hcc"],"summary":"Compute Rxhcc Raf","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Compute Rxhcc Raf Api Rxhcc Raf Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Compute and itemize a per-member RxHCC (Part-D) RAF score. Serves the\ncontinuing-enrollee ``Rx_CE_*`` segments and the ``Rx_NE_*`` new-enrollee\ngrids (pass ``esrd`` for a member with ESRD status in the payment year; a\nnew-enrollee segment needs no categories). 422 on a bad segment/sex/input -\nincluding an ESRD-HCC or HHS-HCC input this model does not own; a\ndeterministic ``{available: false}`` shell when the RxHCC RAF tables aren't\ndeployed on this backend (never a 500).","operationId":"compute_rxhcc_raf_api_rxhcc_raf_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanionRafRequest"}}},"required":true}}},"/api/hhshcc/raf":{"post":{"tags":["hcc"],"summary":"Compute Hhshcc Raf","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Compute Hhshcc Raf Api Hhshcc Raf Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Compute and itemize a per-member HHS-HCC (commercial/ACA marketplace) RAF\nscore. All three V08 models compute - Adult (21+), Child (2-20) and Infant\n(0-1) - selected by the segment, with the member's age required to match it\n(a mismatch is a 422, never a silent mis-score). The Adult model adds the RXC\nprescription-drug factors, the HCC_ED enrollment-duration factors and the CSR\nmultiplier (``csr_factor`` / ``csr_adjusted_raf``; ``raf`` stays the additive\nsum). ``warnings`` names any leg the request left unapplied - a\nfully-specified request returns ``[]``. 422 on a bad segment/sex/age/input; a\nnot_deployed shell when the HHS-HCC RAF tables aren't deployed here.","operationId":"compute_hhshcc_raf_api_hhshcc_raf_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HhsRafRequest"}}},"required":true}}},"/api/opps/group":{"post":{"tags":["opps"],"summary":"Opps Group","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Opps Group Api Opps Group Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Group one outpatient encounter (the OPPS/APC grouper). 422 on no lines /\na blank HCPCS / an over-long claim; a deterministic ``{available: false}``\nshell when the grouper tables aren't deployed (never a 500). The payment\nfigure is a coarse national estimate (see ``OppsGroupResult``).","operationId":"opps_group_api_opps_group_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OppsGroupRequest"}}},"required":true}}},"/api/prior-auth":{"get":{"tags":["reference"],"summary":"Prior Auth Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Prior Auth Codes Api Prior Auth Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"program","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program","description":"dmepos | opd"},"required":false,"description":"dmepos | opd"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"Every code requiring prior authorization as of `dos` (optionally one\nprogram). Bulk enumeration the profile can't express.","operationId":"prior_auth_codes_api_prior_auth_get"}},"/api/rag/status":{"get":{"tags":["rag"],"summary":"Rag Status","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rag Status Api Rag Status Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Per-store drift for the console (no manager, no provider touched).","operationId":"rag_status_api_rag_status_get"}},"/api/rvu/{code}":{"get":{"tags":["codes"],"summary":"Rvu Detail","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rvu Detail Api Rvu  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"rvu_detail_api_rvu__code__get"}},"/api/scope/best":{"get":{"tags":["groups"],"summary":"Best Scope","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Best Scope Api Scope Best Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"text","schema":{"type":"string","title":"Text","maxLength":500,"minLength":1},"required":true},{"in":"query","name":"prefer_specific","schema":{"type":"boolean","title":"Prefer Specific","default":true},"required":false}],"operationId":"best_scope_api_scope_best_get"}},"/api/aoc/orphans":{"post":{"tags":["codes"],"summary":"Aoc Orphans","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Aoc Orphans Api Aoc Orphans Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Flag add-on codes billed without an eligible primary (the 'add-on orphan'\ndenial). For each add-on code on the claim, checks whether an acceptable\nprimary is also present; Type 2 (contractor discretion) is surfaced, not\nguessed. 422 over the 200-code cap; not_deployed when the AOC table is absent.","operationId":"aoc_orphans_api_aoc_orphans_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AocOrphansRequest"}}},"required":true}}},"/api/auth/whoami":{"get":{"tags":["auth"],"summary":"Whoami","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Whoami Api Auth Whoami Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Identity + tab permissions for the current request.\n\nThe SPA calls this on load to gate the top tabs (and reveal the logout\nbutton). When auth is disabled, reports ``auth_required: false`` and all\ntabs show - there's nothing to gate.","operationId":"whoami_api_auth_whoami_get"}},"/api/carc/{code}":{"get":{"tags":["reverse-lookup"],"summary":"Carc Record","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Carc Record Api Carc  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CARC code"},"required":true,"description":"CARC code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The CARC record active as of `dos` (deactivation-date-exact). 403 if not\nX12-entitled; 404 if unknown.","operationId":"carc_record_api_carc__code__get"}},"/api/ccsr/search":{"get":{"tags":["ccsr"],"summary":"Ccsr Search","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Search Api Ccsr Search Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"q","schema":{"type":"string","title":"Q","minLength":2,"description":"ICD description substring (wildcards escaped)"},"required":true,"description":"ICD description substring (wildcards escaped)"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":50,"maximum":500,"minimum":1},"required":false}],"description":"Case-insensitive search on ICD description; returns matching codes with\ntheir default CCSR category.","operationId":"ccsr_search_api_ccsr_search_get"}},"/api/ccsr/{code}":{"get":{"tags":["ccsr"],"summary":"Ccsr Lookup","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Lookup Api Ccsr  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"ICD-10-CM diagnosis code, e.g. E1122"},"required":true,"description":"ICD-10-CM diagnosis code, e.g. E1122"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"CCSR profile for an ICD-10-CM code: description, default category, and\nevery category it maps to (CCSR is multi-category, up to six).","operationId":"ccsr_lookup_api_ccsr__code__get"}},"/api/codes/batch":{"post":{"tags":["codes"],"summary":"Get Codes Batch","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Get Codes Batch Api Codes Batch Post","additionalProperties":{"$ref":"#/components/schemas/CodeProfile"}}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"operationId":"get_codes_batch_api_codes_batch_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodesBatchRequest"}}},"required":true}}},"/api/esrdhcc/raf":{"post":{"tags":["hcc"],"summary":"Compute Esrdhcc Raf","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Compute Esrdhcc Raf Api Esrdhcc Raf Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Compute and itemize a per-member ESRD-HCC (dialysis/transplant) RAF score.\nServes the dialysis (DI), functioning-graft (GFA/GFN/GNPA/GNPN/GI) and\nnew-enrollee (DNE/GNE) segments. ``dual_status`` / ``lti`` /\n``originally_esrd`` drive the status demographic terms, and\n``months_since_transplant`` the graft duration add-on (months 1-3 = the flat\nkidney-transplant factors) - without it a graft segment says so in\n``warnings``. 422 on bad inputs (including another model's input); a\nnot_deployed shell when the ESRD-HCC RAF tables aren't deployed here.","operationId":"compute_esrdhcc_raf_api_esrdhcc_raf_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanionRafRequest"}}},"required":true}}},"/api/rag/dry-run":{"post":{"tags":["rag"],"summary":"Rag Dry Run","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rag Dry Run Api Rag Dry Run Post","additionalProperties":true}}},"description":"Successful Response"}},"description":"Preview the push: drift + per-store corpus doc counts. No manager.","operationId":"rag_dry_run_api_rag_dry_run_post"}},"/api/rag/history":{"get":{"tags":["rag"],"summary":"Rag History","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rag History Api Rag History Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":20,"maximum":100,"minimum":1},"required":false}],"description":"The last ``limit`` ledger rows per store, newest first (bounded 1..100;\nout-of-range -> 422). Surfaces failed/started attempts + their credential-free\ndetail for operator hardening. No manager, no provider touched.","operationId":"rag_history_api_rag_history_get"}},"/api/rarc/{code}":{"get":{"tags":["reverse-lookup"],"summary":"Rarc Record","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rarc Record Api Rarc  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"RARC code"},"required":true,"description":"RARC code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The RARC record active as of `dos` (deactivation-date-exact). 403 if not\nX12-entitled; 404 if unknown.","operationId":"rarc_record_api_rarc__code__get"}},"/api/rbcs/{code}":{"get":{"tags":["codes"],"summary":"Rbcs Detail","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Detail Api Rbcs  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true}],"operationId":"rbcs_detail_api_rbcs__code__get"}},"/api/rules/check":{"post":{"tags":["rules"],"summary":"Rules Check","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rules Check Api Rules Check Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Returns ``{code: 1 | 0 | [swap_codes]}``. 1=passes, 0=violated/no swap, list=swap suggestions.\n\nReturns 503 if the ``code_rules`` table is missing or unreadable - that's\na data-state problem (seeder didn't run / older DB), not a request problem.","operationId":"rules_check_api_rules_check_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleCheckRequest"}}},"required":true}}},"/api/scopes/best":{"get":{"tags":["codes"],"summary":"Scope Best","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Scope Best Api Scopes Best Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"text","schema":{"type":"string","title":"Text","description":"Natural-language scope description, e.g. 'colonoscopy anesthesia'"},"required":true,"description":"Natural-language scope description, e.g. 'colonoscopy anesthesia'"},{"in":"query","name":"prefer_specific","schema":{"type":"boolean","title":"Prefer Specific","default":true},"required":false}],"description":"Best-matching classification scope for a natural-language description.","operationId":"scope_best_api_scopes_best_get"}},"/api/capabilities":{"get":{"tags":["codes"],"summary":"Capabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Capabilities Api Capabilities Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"The dataset registry catalog with live three-state availability - every\ncode/scope/section the framework knows, present OR planned. Each entry is\nannotated with ``entitled`` for the calling identity (the license gate).","operationId":"capabilities_api_capabilities_get"}},"/api/codes/{code}":{"get":{"tags":["codes"],"summary":"Identify Code","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeIdentity"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"Any code - returns which types it is + links"},"required":true,"description":"Any code - returns which types it is + links"},{"in":"query","name":"expand","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expand","description":"`all` to inline a profile per matched type"},"required":false,"description":"`all` to inline a profile per matched type"},{"in":"query","name":"detail","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","description":"inlined-profile depth when expanding: summary | standard | full. Defaults to full for ?expand=all (the 'tell me everything' verb returns everything)."},"required":false,"description":"inlined-profile depth when expanding: summary | standard | full. Defaults to full for ?expand=all (the 'tell me everything' verb returns everything)."},{"in":"query","name":"include","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include","description":"extra sections to enrich (comma list), or 'all': ahrq_qi, apr_drg_weights, asa_rules, cdps, cdps_rx, cdt_editorial, clfs, crosswalks, dmepos, eapg_weights, elixhauser, esrd_comorbidity, fee_schedule, frequency, gems, guidance, hac, hedis_value_sets, hh_pdgm, icd10cm_notes, icd10cm_snomed, icd_index, ioce_proc_demographics, ipf_comorbidity, irf_comorbidity, lab_ncd, mce, medicaid_eob, memberships, mips, moldx_dex_tests, mue, nadac, ncci, ncci_add_on, ndc_rxnorm, nlcd, nucc_specialty, orange_book, preventive, prior_auth, procedure_concept, purple_book, relationships, snomed_icd10cm_map, telehealth, tos, vaccine. The default detail='standard' returns only crosswalks; pass detail='full' (or list sections here) for the rest."},"required":false,"description":"extra sections to enrich (comma list), or 'all': ahrq_qi, apr_drg_weights, asa_rules, cdps, cdps_rx, cdt_editorial, clfs, crosswalks, dmepos, eapg_weights, elixhauser, esrd_comorbidity, fee_schedule, frequency, gems, guidance, hac, hedis_value_sets, hh_pdgm, icd10cm_notes, icd10cm_snomed, icd_index, ioce_proc_demographics, ipf_comorbidity, irf_comorbidity, lab_ncd, mce, medicaid_eob, memberships, mips, moldx_dex_tests, mue, nadac, ncci, ncci_add_on, ndc_rxnorm, nlcd, nucc_specialty, orange_book, preventive, prior_auth, procedure_concept, purple_book, relationships, snomed_icd10cm_map, telehealth, tos, vaccine. The default detail='standard' returns only crosswalks; pass detail='full' (or list sections here) for the rest."},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"Discovery: which code types this string is a member of, with links to the\ntyped resources. Fixed schema (always CodeIdentity) - a router, not data.\n``?expand=all`` inlines a CodeProfile per matched type, fully enriched by\ndefault (``detail='full'`` - explicit ``detail`` overrides); a bare discovery\ncall without expand stays light.","operationId":"identify_code_api_codes__code__get"}},"/api/ms-drg/group":{"post":{"tags":["ms-drg"],"summary":"Ms Drg Group","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ms Drg Group Api Ms Drg Group Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Assign an MS-DRG for one coded inpatient encounter (the grouper, distinct\nfrom the reference lookups). 422 on a missing principal Dx; a deterministic\n``{available: false}`` shell when the grouper tables aren't deployed (never a\n500). The payment figure is a national estimate (see ``DrgGroupResult``).","operationId":"ms_drg_group_api_ms_drg_group_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrgGroupRequest"}}},"required":true}}},"/api/scope/expand":{"post":{"tags":["groups"],"summary":"Expand Scope","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Expand Scope Api Scope Expand Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"operationId":"expand_scope_api_scope_expand_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpandRequest"}}},"required":true}}},"/api/icd/conflicts":{"post":{"tags":["codes"],"summary":"Icd Conflicts","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd Conflicts Api Icd Conflicts Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Excludes1 mutual-exclusion scan over a set of ICD-10-CM diagnoses - the\ndiagnosis-side coding-rule primitive. Returns every Excludes1-conflicting\npair (both directions) among the supplied codes, with the triggering tabular\nnote(s). 422 over the 100-code cap; a ``not_deployed`` availability (empty\nconflicts) when the tabular-notes table isn't on this backend.","operationId":"icd_conflicts_api_icd_conflicts_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcdConflictsRequest"}}},"required":true}}},"/api/ms-drg/search":{"get":{"tags":["ms-drg"],"summary":"Ms Drg Search","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ms Drg Search Api Ms Drg Search Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"q","schema":{"type":"string","title":"Q","minLength":2,"description":"Title substring (wildcards escaped)"},"required":true,"description":"Title substring (wildcards escaped)"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":25,"maximum":200,"minimum":1},"required":false}],"description":"Case-insensitive title search; returns matching DRGs with weight + MDC.","operationId":"ms_drg_search_api_ms_drg_search_get"}},"/api/ms-drg/{code}":{"get":{"tags":["ms-drg"],"summary":"Ms Drg Lookup","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ms Drg Lookup Api Ms Drg  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"MS-DRG code, e.g. 470"},"required":true,"description":"MS-DRG code, e.g. 470"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Fiscal year; defaults to current"},"required":false,"description":"Fiscal year; defaults to current"}],"description":"Full reference row for an MS-DRG: title, MDC, type, and relative weight.","operationId":"ms_drg_lookup_api_ms_drg__code__get"}},"/api/rbcs/families":{"get":{"tags":["groups"],"summary":"Rbcs Families","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Families Api Rbcs Families Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"subcat","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcat"},"required":false}],"operationId":"rbcs_families_api_rbcs_families_get"}},"/api/x12/{x12_set}":{"get":{"tags":["medicaid","x12"],"summary":"X12 Set List","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response X12 Set List Api X12  X12 Set  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"x12_set","schema":{"type":"string","title":"X12 Set","description":"group-codes | claim-status | claim-status-category | plb | service-type | service-type-descriptor | insurance-business-process-application-error | error-reason | industry-specific-remark | insurance-descriptor"},"required":true,"description":"group-codes | claim-status | claim-status-category | plb | service-type | service-type-descriptor | insurance-business-process-application-error | error-reason | industry-specific-remark | insurance-descriptor"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service - excludes codes deactivated on or before this date from date-bearing sets (the carc/rarc rule; start dates are not filtered). Default: the loaded snapshot"},"required":false,"description":"date of service - excludes codes deactivated on or before this date from date-bearing sets (the carc/rarc rule; start dates are not filtered). Default: the loaded snapshot"}],"description":"List an enumerable X12 set (group-codes plus every leaf ECL). The two 277\nsets are large and require a code (-> 422 here). 403 if not X12-entitled.","operationId":"x12_set_list_api_x12__x12_set__get"}},"/api/asa/guidelines":{"get":{"tags":["medicaid","asa"],"summary":"Asa Guidelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Asa Guidelines Api Asa Guidelines Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"RVG edition year (default: newest loaded)"},"required":false,"description":"RVG edition year (default: newest loaded)"}],"description":"The RVG's code-INDEPENDENT guidelines for one edition: the billing policies\n(physical-status units, the field-avoidance minimum base, the multiple-procedure\nrule, the anesthesia-time definition, modifier applicability) and the Summary of\nChanges.\n\nThese vary by EDITION, never by code. They used to ride the per-code asa_rules\nsection, where they were 88% of every payload and identical on every code - about\n5.5 MB repeated across a 500-code batch. Per-CODE rules still ride asa_rules.\n\nGATED (ASA-licensed): a non-entitled caller is 403'd, never side-doored.","operationId":"asa_guidelines_api_asa_guidelines_get"}},"/api/cpt/{code}/rvu":{"get":{"tags":["codes"],"summary":"Cpt Rvu","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt Rvu Api Cpt  Code  Rvu Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"cpt_rvu_api_cpt__code__rvu_get"}},"/api/guidance/stats":{"get":{"tags":["guidance"],"summary":"Guidance Stats","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Guidance Stats Api Guidance Stats Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Per-kind corpus counts (active vs tombstoned) - the panel header.","operationId":"guidance_stats_api_guidance_stats_get"}},"/api/hac/categories":{"get":{"tags":["reverse-lookup"],"summary":"Hac Categories","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Hac Categories Api Hac Categories Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The CMS HAC category catalog (number + label + code count).","operationId":"hac_categories_api_hac_categories_get"}},"/api/ccsr/meta/years":{"get":{"tags":["ccsr"],"summary":"Ccsr Years","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Years Api Ccsr Meta Years Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Years present in the CCSR table.","operationId":"ccsr_years_api_ccsr_meta_years_get"}},"/api/gpci/localities":{"get":{"tags":["codes"],"summary":"Gpci Localities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Gpci Localities Api Gpci Localities Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"GPCI year; latest if omitted"},"required":false,"description":"GPCI year; latest if omitted"}],"description":"The CMS GPCI locality picker list (national row first). Feeds the\nfee-schedule locality selector; pass a returned 7-digit ``locality`` as\n``?locality=`` on a code lookup to get geographically-adjusted MPFS fees.","operationId":"gpci_localities_api_gpci_localities_get"}},"/api/guidance/{kind}":{"get":{"tags":["guidance"],"summary":"Guidance Search","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Guidance Search Api Guidance  Kind  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"kind","schema":{"type":"string","title":"Kind","description":"cpt | icd | cpt-icd"},"required":true,"description":"cpt | icd | cpt-icd"},{"in":"query","name":"q","schema":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Q","description":"Code prefix or guidance substring; omit to page through the whole kind"},"required":false,"description":"Code prefix or guidance substring; omit to page through the whole kind"},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":50,"maximum":200,"minimum":1},"required":false},{"in":"query","name":"offset","schema":{"type":"integer","title":"Offset","default":0,"maximum":1000000,"minimum":0},"required":false},{"in":"query","name":"sort","schema":{"type":"string","title":"Sort","default":"code","pattern":"^(code|added)$","description":"code = key order; added = newest first"},"required":false,"description":"code = key order; added = newest first"},{"in":"query","name":"include_inactive","schema":{"type":"boolean","title":"Include Inactive","default":false},"required":false}],"description":"Browse/search one kind's corpus.\n\nWith ``q``: code-prefix or guidance-substring filter. Without ``q``: the\nfull sorted key listing. Both are paginated (``limit``/``offset``) and\nreturn ``total`` plus a per-key preview of the current serving merge.","operationId":"guidance_search_api_guidance__kind__get"}},"/api/icd/{code}/hccs":{"get":{"tags":["codes"],"summary":"Icd Hccs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd Hccs Api Icd  Code  Hccs Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"icd_hccs_api_icd__code__hccs_get"}},"/api/nubc/{code_set}":{"get":{"tags":["medicaid","nubc"],"summary":"Nubc List","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Nubc List Api Nubc  Code Set  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code_set","schema":{"type":"string","title":"Code Set","description":"A UB-04 code set name"},"required":true,"description":"A UB-04 code set name"}],"description":"Every code in one UB-04 code set. 403 if not license-entitled.","operationId":"nubc_list_api_nubc__code_set__get"}},"/api/nucc/taxonomies":{"get":{"tags":["reverse-lookup"],"summary":"Nucc Taxonomies","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Nucc Taxonomies Api Nucc Taxonomies Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"medicare_specialty_code","schema":{"type":"string","title":"Medicare Specialty Code"},"required":true},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":500,"minimum":1},"required":false}],"description":"The NUCC taxonomy codes mapped to a Medicare specialty code (reverse).","operationId":"nucc_taxonomies_api_nucc_taxonomies_get"}},"/api/rbcs/categories":{"get":{"tags":["groups"],"summary":"Rbcs Categories","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Categories Api Rbcs Categories Get","additionalProperties":true}}},"description":"Successful Response"}},"operationId":"rbcs_categories_api_rbcs_categories_get"}},"/api/ms-drg/mdc/{mdc}":{"get":{"tags":["ms-drg"],"summary":"Ms Drg By Mdc","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ms Drg By Mdc Api Ms Drg Mdc  Mdc  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"mdc","schema":{"type":"string","title":"Mdc","description":"Major Diagnostic Category, e.g. 05"},"required":true,"description":"Major Diagnostic Category, e.g. 05"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"All MS-DRG codes within a Major Diagnostic Category.","operationId":"ms_drg_by_mdc_api_ms_drg_mdc__mdc__get"}},"/api/rvu/{code}/value":{"get":{"tags":["codes"],"summary":"Rvu Value","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rvu Value Api Rvu  Code  Value Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"mod","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mod","description":"Modifier: 26 (professional) or TC (technical)"},"required":false,"description":"Modifier: 26 (professional) or TC (technical)"},{"in":"query","name":"rvutype","schema":{"type":"string","title":"Rvutype","default":"work","description":"work | facility | nonfacility"},"required":false,"description":"work | facility | nonfacility"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"The single scalar RVU value by component (the most-used RVU call).","operationId":"rvu_value_api_rvu__code__value_get"}},"/api/hcc/model-version":{"get":{"tags":["codes"],"summary":"Hcc Model Version","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Hcc Model Version Api Hcc Model Version Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Year (resolves the CMS model version; omit = latest)"},"required":false,"description":"Year (resolves the CMS model version; omit = latest)"}],"description":"The CMS HCC model version (V24/V28/...) for a year - no code needed.","operationId":"hcc_model_version_api_hcc_model_version_get"}},"/api/licensing/request":{"post":{"tags":["licensing"],"summary":"Request Access","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Request Access Api Licensing Request Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Request access to a license-restricted corpus. Records a pending request a\nHank admin can approve (which writes the grant so your next call is entitled),\ncaptures the license attestation, and notifies Hank (email + best-effort\nwebhook). This is the actionable path off a 403/redaction.","operationId":"request_access_api_licensing_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRequestBody"}}},"required":true}}},"/api/mac-jurisdictions":{"get":{"tags":["medicaid","mac"],"summary":"Mac Jurisdiction States","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Mac Jurisdiction States Api Mac Jurisdictions Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Every state/territory in the MAC map with its contractors - the enumeration\nthat says which ``{state}`` values the lookup below answers for. Empty list when\nthe table isn't deployed. Same posture as /api/medicaid-programs: a ~60-row\njurisdiction enumeration carrying no medical codes, so it is not ScrapeGuard'd.","operationId":"mac_jurisdiction_states_api_mac_jurisdictions_get"}},"/api/medicaid-programs":{"get":{"tags":["medicaid"],"summary":"Medicaid Programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Medicaid Programs Api Medicaid Programs Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"The state Medicaid source programs (jurisdictions) currently loaded, with\nper-program edit counts. Empty list when the crosswalk isn't deployed.\n\nNOT ScrapeGuard'd: this is a ~6-row jurisdiction enumeration carrying no\ncodes, so there is nothing for a coverage-based guard to count. Same posture\nas the sibling enumerations (/api/nubc/{code_set},\n/api/mac-jurisdiction/{state}); the code-bearing surfaces - the per-CODE\nlookups AND the /api/x12/{set} full lists - are guarded.","operationId":"medicaid_programs_api_medicaid_programs_get"}},"/api/ms-drg/meta/years":{"get":{"tags":["ms-drg"],"summary":"Ms Drg Years","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ms Drg Years Api Ms Drg Meta Years Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"Fiscal years present in the MS-DRG table.","operationId":"ms_drg_years_api_ms_drg_meta_years_get"}},"/api/ncci/{code}/edits":{"get":{"tags":["reference"],"summary":"Ncci Edits","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ncci Edits Api Ncci  Code  Edits Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code (column_1 of the PTP pair)"},"required":true,"description":"CPT/HCPCS code (column_1 of the PTP pair)"},{"in":"query","name":"category","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"filter to one service category"},"required":false,"description":"filter to one service category"}],"description":"Active NCCI PTP edits where this code is column_1 (the raw getter shape,\nincl. the `type` column the profile's NCCI section drops, both-direction-free).\nThe /codes/{type}/{code}/ncci SECTION is a both-direction, capped, type-less\nsuperset - this is the faithful column_1 list.","operationId":"ncci_edits_api_ncci__code__edits_get"}},"/api/prior-auth/{code}":{"get":{"tags":["reference"],"summary":"Prior Auth For Code","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Prior Auth For Code Api Prior Auth  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The Medicare prior-authorization requirement(s) for a code, active as of\n`dos` (dos-EXACT; the PriorAuth profile section drops `code`/`year`).","operationId":"prior_auth_for_code_api_prior_auth__code__get"}},"/api/wage-index/{cbsa}":{"get":{"tags":["medicaid","wage-index"],"summary":"Wage Index","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Wage Index Api Wage Index  Cbsa  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cbsa","schema":{"type":"string","title":"Cbsa","description":"CBSA code - 2-digit statewide rural or 5-digit urban"},"required":true,"description":"CBSA code - 2-digit statewide rural or 5-digit urban"},{"in":"query","name":"fy","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy","description":"Fiscal year (default: newest loaded; resolves at-or-before)"},"required":false,"description":"Fiscal year (default: newest loaded; resolves at-or-before)"}],"description":"CMS IPPS wage index / GAF for a labor-market area (CBSA), by fiscal year.\nReturns every state leg (a CBSA can span multiple state rows). Reference data\nonly - the wage index is an input to IPPS payment, which lives in Hank PP Man.\n404 if the CBSA has no row (or the table isn't deployed).","operationId":"wage_index_api_wage_index__cbsa__get"}},"/api/ahrq-qi/indicators":{"get":{"tags":["reverse-lookup"],"summary":"Ahrq Qi Indicators","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ahrq Qi Indicators Api Ahrq Qi Indicators Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The AHRQ Quality-Indicator catalog (module + id + name + code count).","operationId":"ahrq_qi_indicators_api_ahrq_qi_indicators_get"}},"/api/concepts/shoppable":{"get":{"tags":["codes"],"summary":"Shoppable Services","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Shoppable Services Api Concepts Shoppable Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"The CMS 70 shoppable services (45 CFR 180.60(d)(2)) mapped to procedure\nconcepts (#163): mapped rows carry concept_key(s); unmapped rows carry a\ndocumented gap_reason. The enumeration entry point for consumer catalogs.","operationId":"shoppable_services_api_concepts_shoppable_get"}},"/api/cpt/{code}/details":{"get":{"tags":["codes"],"summary":"Cpt Details","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt Details Api Cpt  Code  Details Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"modifiers","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifiers","description":"Comma-separated modifiers (e.g. 26,TC) - change the RVU component"},"required":false,"description":"Comma-separated modifiers (e.g. 26,TC) - change the RVU component"},{"in":"query","name":"base_unit_source","schema":{"type":"string","title":"Base Unit Source","default":"CMS","description":"Anesthesia base-unit source: CMS | ASA"},"required":false,"description":"Anesthesia base-unit source: CMS | ASA"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"Core CPT details incl. anesthesia base units (get_cpt_details).\n\n403 without the CMS ``rvu`` + AMA ``cpt`` entitlements. The ASA legs\n(``rvg_bu``, ``cw``, ``cw_row``) are ASA-licensed and are WITHHELD rather than\n403'd for a caller with no ASA entitlement - the response then carries\n``withheld`` + ``license_note`` naming what was removed and how to request it.","operationId":"cpt_details_api_cpt__code__details_get"}},"/api/groups/code/{code}":{"get":{"tags":["groups"],"summary":"Groups For Code","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Groups For Code Api Groups Code  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true}],"operationId":"groups_for_code_api_groups_code__code__get"}},"/api/guidance/proposals":{"get":{"tags":["guidance"],"summary":"List Proposals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response List Proposals Api Guidance Proposals Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"status","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"pending|approved|denied|changes_requested|superseded|applied"},"required":false,"description":"pending|approved|denied|changes_requested|superseded|applied"},{"in":"query","name":"kind","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind","description":"cpt|icd|cpt-icd"},"required":false,"description":"cpt|icd|cpt-icd"},{"in":"query","name":"limit","schema":{"type":"integer","title":"Limit","default":100,"maximum":500,"minimum":1},"required":false},{"in":"query","name":"offset","schema":{"type":"integer","title":"Offset","default":0,"minimum":0},"required":false}],"description":"The review queue (editors + admins only, enforced server-side).","operationId":"list_proposals_api_guidance_proposals_get"},"post":{"tags":["guidance"],"summary":"Create Proposal","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","title":"Response Create Proposal Api Guidance Proposals Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"POST a row-level guidance change proposal (scope guidance:propose).","operationId":"create_proposal_api_guidance_proposals_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalIn"}}},"required":true}}},"/api/hac/{number}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Hac Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Hac Codes Api Hac  Number  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"number","schema":{"type":"integer","title":"Number","description":"HAC category number"},"required":true,"description":"HAC category number"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The ICD-10-CM codes in a HAC category (reverse).","operationId":"hac_codes_api_hac__number__codes_get"}},"/api/mue/{code}/entries":{"get":{"tags":["reference"],"summary":"Mue Entries","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Mue Entries Api Mue  Code  Entries Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The MUE rows for a code AS OF a date of service - the raw, QUARTER-EXACT\ngetter (the /mue profile section is year-granular; MUE values change quarterly,\nso a mid-year dos must pick that quarter's value, not the year-end one).","operationId":"mue_entries_api_mue__code__entries_get"}},"/api/ncci-add-on/{code}":{"get":{"tags":["reference"],"summary":"Ncci Add On","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ncci Add On Api Ncci Add On  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS add-on code"},"required":true,"description":"CPT/HCPCS add-on code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The NCCI Add-On edits for a code AS OF a date of service - the raw,\nDATE-EXACT, UNCAPPED getter (the ncci_add_on profile section is year-granular\nand capped). entries + the derived primary_codes / edit_type.","operationId":"ncci_add_on_api_ncci_add_on__code__get"}},"/api/rbcs/subcategories":{"get":{"tags":["groups"],"summary":"Rbcs Subcategories","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Subcategories Api Rbcs Subcategories Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"cat","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cat"},"required":false}],"operationId":"rbcs_subcategories_api_rbcs_subcategories_get"}},"/api/snomed-map/{sctid}":{"get":{"tags":["medicaid","snomed"],"summary":"Snomed Map Forward","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Snomed Map Forward Api Snomed Map  Sctid  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"sctid","schema":{"type":"string","title":"Sctid","description":"a SNOMED CT concept id (referencedComponentId)"},"required":true,"description":"a SNOMED CT concept id (referencedComponentId)"}],"description":"Forward SNOMED CT -> ICD-10-CM ExtendedMap (refset 6011000124106): a SNOMED\nconcept's reimbursement-map rows, ORDERED by (map_group, map_priority) - the\norder is semantic - each with its MAPRULE/MAPADVICE condition/advice. GATED\n(SNOMED-licensed): a non-entitled caller is 403'd, never side-doored. Empty\nentries when the concept has no map row / the table isn't deployed. The reverse\ndirection (which SNOMED concepts map TO an ICD) rides the .snomed_icd10cm_map\nprofile section on the ICD profile.","operationId":"snomed_map_forward_api_snomed_map__sctid__get"}},"/api/anesthesia/validate":{"get":{"tags":["crosswalk"],"summary":"Validate Crosswalk","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Validate Crosswalk Api Anesthesia Validate Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"cpt","schema":{"type":"string","title":"Cpt"},"required":true},{"in":"query","name":"asa","schema":{"type":"string","title":"Asa"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"customer","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"Is this CPT/ASA pairing valid in the ASA Crosswalk (both directions)?\n\nASA-licensed (the ASA Crosswalk): **403** for a caller with no ASA\nentitlement - a probe-per-pair would otherwise rebuild the mapping.","operationId":"validate_crosswalk_api_anesthesia_validate_get"}},"/api/asa/physical-status":{"get":{"tags":["medicaid","asa"],"summary":"Asa Physical Status","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Asa Physical Status Api Asa Physical Status Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"ps_class","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ps Class","description":"P1|P2|P3|P4|P5|P6|E (default: the whole grid)"},"required":false,"description":"P1|P2|P3|P4|P5|P6|E (default: the whole grid)"},{"in":"query","name":"population","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Population","description":"adult|pediatric|obstetric|definition"},"required":false,"description":"adult|pediatric|obstetric|definition"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"RVG edition year (default: newest loaded; resolves at-or-before)"},"required":false,"description":"RVG edition year (default: newest loaded; resolves at-or-before)"}],"description":"The ASA Physical Status classification grid: each class's definition and the\nASA's own adult / pediatric / obstetric examples. The classification a P1-P6\nmodifier reports, and the basis for the physical-status unit add-ons (the unit\nVALUES are guideline policies and are served by /api/asa/guidelines, not this\nroute -- they vary by edition, never by code).\n\nGATED (ASA-licensed): a non-entitled caller is 403'd, never side-doored.\n\nAn unknown ps_class, population or year is a 422 naming the valid set - a typo\nused to come back as count:0, which reads as \"we hold it and it is empty\".","operationId":"asa_physical_status_api_asa_physical_status_get"}},"/api/codes/{type}/{code}":{"get":{"tags":["codes"],"summary":"Get Code","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeProfile"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"type","schema":{"$ref":"#/components/schemas/CodeType","description":"cpt|hcpcs|icd|icdpcs|modifier|hcc (+ planned: ndc)"},"required":true,"description":"cpt|hcpcs|icd|icdpcs|modifier|hcc (+ planned: ndc)"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"The code value (bare alphanumeric/dot token)"},"required":true,"description":"The code value (bare alphanumeric/dot token)"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"YYYY-MM-DD; overrides year"},"required":false,"description":"YYYY-MM-DD; overrides year"},{"in":"query","name":"detail","schema":{"type":"string","title":"Detail","default":"standard","description":"summary | standard | full"},"required":false,"description":"summary | standard | full"},{"in":"query","name":"include","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include","description":"extra sections to enrich (comma list), or 'all': ahrq_qi, apr_drg_weights, asa_rules, cdps, cdps_rx, cdt_editorial, clfs, crosswalks, dmepos, eapg_weights, elixhauser, esrd_comorbidity, fee_schedule, frequency, gems, guidance, hac, hedis_value_sets, hh_pdgm, icd10cm_notes, icd10cm_snomed, icd_index, ioce_proc_demographics, ipf_comorbidity, irf_comorbidity, lab_ncd, mce, medicaid_eob, memberships, mips, moldx_dex_tests, mue, nadac, ncci, ncci_add_on, ndc_rxnorm, nlcd, nucc_specialty, orange_book, preventive, prior_auth, procedure_concept, purple_book, relationships, snomed_icd10cm_map, telehealth, tos, vaccine. The default detail='standard' returns only crosswalks; pass detail='full' (or list sections here) for the rest."},"required":false,"description":"extra sections to enrich (comma list), or 'all': ahrq_qi, apr_drg_weights, asa_rules, cdps, cdps_rx, cdt_editorial, clfs, crosswalks, dmepos, eapg_weights, elixhauser, esrd_comorbidity, fee_schedule, frequency, gems, guidance, hac, hedis_value_sets, hh_pdgm, icd10cm_notes, icd10cm_snomed, icd_index, ioce_proc_demographics, ipf_comorbidity, irf_comorbidity, lab_ncd, mce, medicaid_eob, memberships, mips, moldx_dex_tests, mue, nadac, ncci, ncci_add_on, ndc_rxnorm, nlcd, nucc_specialty, orange_book, preventive, prior_auth, procedure_concept, purple_book, relationships, snomed_icd10cm_map, telehealth, tos, vaccine. The default detail='standard' returns only crosswalks; pass detail='full' (or list sections here) for the rest."},{"in":"query","name":"exclude","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude","description":"sections to drop (comma list)"},"required":false,"description":"sections to drop (comma list)"},{"in":"query","name":"locality","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality","description":"7-digit CMS GPCI locality (e.g. 0111205); adds locality-adjusted MPFS fees to the rvu section. National if omitted."},"required":false,"description":"7-digit CMS GPCI locality (e.g. 0111205); adds locality-adjusted MPFS fees to the rvu section. National if omitted."},{"in":"query","name":"zip","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip","description":"5-digit ZIP - resolved to a locality via the CMS ZIP-to-carrier-locality crosswalk (locality wins if both given)."},"required":false,"description":"5-digit ZIP - resolved to a locality via the CMS ZIP-to-carrier-locality crosswalk (locality wins if both given)."},{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"operationId":"get_code_api_codes__type___code__get"}},"/api/elixhauser/measures":{"get":{"tags":["reverse-lookup"],"summary":"Elixhauser Measures","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Elixhauser Measures Api Elixhauser Measures Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The AHRQ Elixhauser comorbidity-measure catalog.","operationId":"elixhauser_measures_api_elixhauser_measures_get"}},"/api/groups/{name}/codes":{"get":{"tags":["groups"],"summary":"Codes In Group","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Codes In Group Api Groups  Name  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"name","schema":{"type":"string","title":"Name"},"required":true}],"operationId":"codes_in_group_api_groups__name__codes_get"}},"/api/icd/{code}/siblings":{"get":{"tags":["codes"],"summary":"Icd Siblings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd Siblings Api Icd  Code  Siblings Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"icd_siblings_api_icd__code__siblings_get"}},"/api/lab-ncd/{ncd}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Lab Ncd Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Lab Ncd Codes Api Lab Ncd  Ncd  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"ncd","schema":{"type":"string","title":"Ncd"},"required":true},{"in":"query","name":"resolution","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Resolution","description":"1 covered | 2 denied | 3 non-supporting"},"required":false,"description":"1 covered | 2 denied | 3 non-supporting"}],"description":"The ICD-10-CM codes governed by a Lab-NCD (190.x), optionally one resolution.","operationId":"lab_ncd_codes_api_lab_ncd__ncd__codes_get"}},"/api/cpt/{code}/neighbors":{"get":{"tags":["codes"],"summary":"Cpt Neighbors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt Neighbors Api Cpt  Code  Neighbors Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT code"},"required":true,"description":"CPT code"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"The sequentially-adjacent CPT codes (getBeforeAndAfter).","operationId":"cpt_neighbors_api_cpt__code__neighbors_get"}},"/api/x12/{x12_set}/{code}":{"get":{"tags":["medicaid","x12"],"summary":"X12 Code","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response X12 Code Api X12  X12 Set   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"x12_set","schema":{"type":"string","title":"X12 Set","description":"group-codes | claim-status | claim-status-category | plb | service-type | service-type-descriptor | insurance-business-process-application-error | error-reason | industry-specific-remark | insurance-descriptor"},"required":true,"description":"group-codes | claim-status | claim-status-category | plb | service-type | service-type-descriptor | insurance-business-process-application-error | error-reason | industry-specific-remark | insurance-descriptor"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"the X12 code within that set"},"required":true,"description":"the X12 code within that set"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service - excludes codes deactivated on or before this date from date-bearing sets (the carc/rarc rule; start dates are not filtered). Default: the loaded snapshot"},"required":false,"description":"date of service - excludes codes deactivated on or before this date from date-bearing sets (the carc/rarc rule; start dates are not filtered). Default: the loaded snapshot"}],"description":"One X12 supporting code (group / 277 claim-status / category / leaf ECL).\n403 if not X12-entitled; 404 if unknown or the tables aren't deployed.","operationId":"x12_code_api_x12__x12_set___code__get"}},"/api/ahrq-qi/{qi_id}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Ahrq Qi Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ahrq Qi Codes Api Ahrq Qi  Qi Id  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"qi_id","schema":{"type":"string","title":"Qi Id"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The codes belonging to an AHRQ Quality Indicator (reverse).","operationId":"ahrq_qi_codes_api_ahrq_qi__qi_id__codes_get"}},"/api/anesthesia/flag/{cpt}":{"get":{"tags":["crosswalk"],"summary":"Asa Flag","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Asa Flag Api Anesthesia Flag  Cpt  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cpt","schema":{"type":"string","title":"Cpt"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"customer","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"The ASA Crosswalk flag for a surgical CPT.\n\nASA-licensed (the ASA Crosswalk): **403** for a caller with no ASA\nentitlement.","operationId":"asa_flag_api_anesthesia_flag__cpt__get"}},"/api/frequency/icd-cpt-asa":{"get":{"tags":["frequency"],"summary":"Frequency Icd Cpt Asa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Frequency Icd Cpt Asa Api Frequency Icd Cpt Asa Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"cpt","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpt","description":"CPT/HCPCS code (anesthesia seed)"},"required":false,"description":"CPT/HCPCS code (anesthesia seed)"},{"in":"query","name":"asa","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asa","description":"ASA code"},"required":false,"description":"ASA code"},{"in":"query","name":"cpt_modifier","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpt Modifier"},"required":false},{"in":"query","name":"asa_modifier","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asa Modifier"},"required":false},{"in":"query","name":"min_count","schema":{"type":"integer","title":"Min Count","default":0,"minimum":0},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"Anesthesia-seed CPT/ASA -> primary-ICD frequency rows (the raw\n``frequency_icd_cpt_asa`` corpus, NOT merged with radiology).","operationId":"frequency_icd_cpt_asa_api_frequency_icd_cpt_asa_get"}},"/api/frequency/{code}/icds":{"get":{"tags":["frequency"],"summary":"Frequency Icds","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Frequency Icds Api Frequency  Code  Icds Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The FULL ranked ICD co-occurrence distribution for a CPT/HCPCS code\n(uncapped - the merged anesthesia + radiology corpora). The ``frequency``\nprofile section is a top-N summary; this is the complete list.","operationId":"frequency_icds_api_frequency__code__icds_get"}},"/api/groups/{name}/parents":{"get":{"tags":["groups"],"summary":"Group Parents","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Group Parents Api Groups  Name  Parents Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"name","schema":{"type":"string","title":"Name"},"required":true}],"operationId":"group_parents_api_groups__name__parents_get"}},"/api/guidance/{kind}/{key}":{"get":{"tags":["guidance"],"summary":"Guidance Resource","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Guidance Resource Api Guidance  Kind   Key  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"kind","schema":{"type":"string","title":"Kind","description":"cpt | icd | cpt-icd"},"required":true,"description":"cpt | icd | cpt-icd"},{"in":"path","name":"key","schema":{"type":"string","title":"Key","description":"CPT/ICD code, or (cpt-icd) a code OR group name"},"required":true,"description":"CPT/ICD code, or (cpt-icd) a code OR group name"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD) - filters authored effectivity windows"},"required":false,"description":"Date of service (YYYY-MM-DD) - filters authored effectivity windows"},{"in":"query","name":"include_inactive","schema":{"type":"boolean","title":"Include Inactive","default":false,"description":"Also return tombstoned (removed) history rows"},"required":false,"description":"Also return tombstoned (removed) history rows"},{"in":"query","name":"scope","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Specialty scope for the merged text: anesthesia|radiology|surgical|em|gi. Omit for the global rules only; a scope returns global + that lane's rules. An unknown scope is a 422."},"required":false,"description":"Specialty scope for the merged text: anesthesia|radiology|surgical|em|gi. Omit for the global rules only; a scope returns global + that lane's rules. An unknown scope is a 422."}],"description":"Merged guidance text + row-granular detail from the canonical guidance corpus.","operationId":"guidance_resource_api_guidance__kind___key__get"}},"/api/icd/{code}/laterality":{"get":{"tags":["codes"],"summary":"Icd Laterality","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd Laterality Api Icd  Code  Laterality Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"icd_laterality_api_icd__code__laterality_get"}},"/api/cpt/icd-guidance/batch":{"post":{"tags":["rules"],"summary":"Cpt Icd Guidance Batch","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt Icd Guidance Batch Api Cpt Icd Guidance Batch Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Batch CPT->ICD pairing guidance. Reads the AMA-licensed ``cpt`` table, so it\ncarries the same 403 as its single-code twin - without it a zero-permission\ncaller could batch-read 500 codes of exactly what ``/api/cpt/{code}/icd-guidance``\nrefuses one at a time.","operationId":"cpt_icd_guidance_batch_api_cpt_icd_guidance_batch_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CptIcdGuidanceBatchRequest"}}},"required":true}}},"/api/frequency-corpus/{cpt}":{"get":{"tags":["frequency","frequency-corpus"],"summary":"Frequency Corpus","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Frequency Corpus Api Frequency Corpus  Cpt  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cpt","schema":{"type":"string","title":"Cpt","description":"A CPT/HCPCS code, or a CPT combo as its '|'-joined members (order irrelevant - the answer echoes the canonical sorted key)."},"required":true,"description":"A CPT/HCPCS code, or a CPT combo as its '|'-joined members (order irrelevant - the answer echoes the canonical sorted key)."},{"in":"query","name":"corpus","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Corpus","description":"Narrow to one opaque corpus id (corpus_A / corpus_B). Cross-corpus policy rows are kept, since they apply to every corpus."},"required":false,"description":"Narrow to one opaque corpus id (corpus_A / corpus_B). Cross-corpus policy rows are kept, since they apply to every corpus."},{"in":"query","name":"min_pct","schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Pct","description":"Floor the served pct on both distributions."},"required":false,"description":"Floor the served pct on both distributions."},{"in":"query","name":"kinds","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kinds","description":"Comma-separated distribution kinds: primary, cooccurrence (default both)."},"required":false,"description":"Comma-separated distribution kinds: primary, cooccurrence (default both)."},{"in":"query","name":"include_icd_rules","schema":{"type":"boolean","title":"Include Icd Rules","default":false,"description":"Attach the curated action-bearing ICD-10 rules (ICD-keyed, never filtered by cpt)."},"required":false,"description":"Attach the curated action-bearing ICD-10 rules (ICD-keyed, never filtered by cpt)."}],"description":"The mined CPT->ICD frequency knowledge for a CPT or CPT combo: primary-ICD\nand per-accession co-occurrence distributions (COMPLETE, never capped), the\ncombo-level support/lift/marginals, the derived allowed ICD shortlist and the\nincidental-finding demote list.\n\nEach corpus is a specialty-scoped drop (radiology today) identified only by an\nOPAQUE id - corpus_A / corpus_B and nothing else. 422 on a malformed kind; 404\nsplits \"dataset never seeded\" from \"no data for this CPT\" (the wage-index\nconvention) so an operator can tell them apart without a capabilities\nround-trip.","operationId":"frequency_corpus_api_frequency_corpus__cpt__get"}},"/api/groups/{name}/children":{"get":{"tags":["groups"],"summary":"Group Children","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Group Children Api Groups  Name  Children Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"name","schema":{"type":"string","title":"Name"},"required":true}],"operationId":"group_children_api_groups__name__children_get"}},"/api/groups/{name}/friendly":{"get":{"tags":["groups"],"summary":"Friendly Name","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Friendly Name Api Groups  Name  Friendly Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"name","schema":{"type":"string","title":"Name"},"required":true}],"operationId":"friendly_name_api_groups__name__friendly_get"}},"/api/mue/{code}/units-check":{"get":{"tags":["codes"],"summary":"Mue Units Check","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Mue Units Check Api Mue  Code  Units Check Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"units","schema":{"type":"integer","title":"Units","minimum":0,"description":"Billed units to adjudicate"},"required":true,"description":"Billed units to adjudicate"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD)"},"required":false,"description":"Date of service (YYYY-MM-DD)"}],"description":"Adjudicate billed units against the MUE - per service type, whether the\nunits exceed the cap and the MAI-aware remediation (line-split vs per-day\nabsolute vs clinical-appeal). not_deployed when the MUE table is absent.","operationId":"mue_units_check_api_mue__code__units_check_get"}},"/api/nubc/{code_set}/{code}":{"get":{"tags":["medicaid","nubc"],"summary":"Nubc Code","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Nubc Code Api Nubc  Code Set   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code_set","schema":{"type":"string","title":"Code Set","description":"revenue|tob|discharge_status|condition|occurrence|occurrence_span|value"},"required":true,"description":"revenue|tob|discharge_status|condition|occurrence|occurrence_span|value"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"The UB-04 code within that set"},"required":true,"description":"The UB-04 code within that set"}],"description":"One UB-04 institutional code, disambiguated by code_set. 403 if the caller\nisn't license-entitled to AHA NUBC data; 404 if unknown / not deployed.","operationId":"nubc_code_api_nubc__code_set___code__get"}},"/api/rbcs/search/categories":{"get":{"tags":["reverse-lookup"],"summary":"Rbcs Search Categories","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Search Categories Api Rbcs Search Categories Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"query","name":"q","schema":{"type":"string","title":"Q","minLength":1},"required":true}],"description":"RBCS category/subcategory/family rows whose descriptions match a text query\n(match_category_text). (3-segment path to avoid the /rbcs/{code} capture.)","operationId":"rbcs_search_categories_api_rbcs_search_categories_get"}},"/api/vaccine/cvx/{cvx_code}":{"get":{"tags":["reverse-lookup"],"summary":"Vaccine Cvx","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Vaccine Cvx Api Vaccine Cvx  Cvx Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cvx_code","schema":{"type":"string","title":"Cvx Code"},"required":true}],"description":"A CDC CVX vaccine record by CVX code (404 when unknown).","operationId":"vaccine_cvx_api_vaccine_cvx__cvx_code__get"}},"/api/vaccine/mvx/{mvx_code}":{"get":{"tags":["reverse-lookup"],"summary":"Vaccine Mvx","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Vaccine Mvx Api Vaccine Mvx  Mvx Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"mvx_code","schema":{"type":"string","title":"Mvx Code"},"required":true}],"description":"A CDC MVX manufacturer record by MVX code (404 when unknown).","operationId":"vaccine_mvx_api_vaccine_mvx__mvx_code__get"}},"/api/cpt/{code}/icd-guidance":{"get":{"tags":["codes"],"summary":"Cpt Icd Guidance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt Icd Guidance Api Cpt  Code  Icd Guidance Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"cpt_icd_guidance_api_cpt__code__icd_guidance_get"}},"/api/frequency/{code}/cobill":{"get":{"tags":["frequency"],"summary":"Frequency Cobill","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Frequency Cobill Api Frequency  Code  Cobill Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"min_support","schema":{"type":"integer","title":"Min Support","default":2,"minimum":0},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"Co-billing CPT combos containing this code (support >= min_support).","operationId":"frequency_cobill_api_frequency__code__cobill_get"}},"/api/icd10cm-notes/conflicts":{"post":{"tags":["reverse-lookup"],"summary":"Icd10Cm Conflicts","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd10Cm Conflicts Api Icd10Cm Notes Conflicts Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"description":"Whether two ICD-10-CM codes are an Excludes1 conflict (checked both\ndirections). Returns the conflicting note rows ([] when compatible).","operationId":"icd10cm_conflicts_api_icd10cm_notes_conflicts_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_ConflictRequest"}}},"required":true}}},"/api/lab-ncd/icd/{icd}/edits":{"get":{"tags":["reference"],"summary":"Lab Ncd Icd Edits","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Lab Ncd Icd Edits Api Lab Ncd Icd  Icd  Edits Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"icd","schema":{"type":"string","title":"Icd","description":"ICD-10-CM diagnosis code"},"required":true,"description":"ICD-10-CM diagnosis code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The Lab-NCDs governing a diagnosis AS OF a dos (raw, DATE-EXACT getter -\nicd_eff is date-filtered, so the year-granular section diverges mid-year).","operationId":"lab_ncd_icd_edits_api_lab_ncd_icd__icd__edits_get"}},"/api/snomed/{code}/icd-codes":{"get":{"tags":["reverse-lookup"],"summary":"Snomed Icd Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Snomed Icd Codes Api Snomed  Code  Icd Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true}],"description":"The ICD-10-CM codes a SNOMED concept maps to (reverse). GATED (SNOMED\nlicense) -> 403 for a non-entitled caller.","operationId":"snomed_icd_codes_api_snomed__code__icd_codes_get"}},"/api/zip-locality/{zip_code}":{"get":{"tags":["reference"],"summary":"Zip Locality","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Zip Locality Api Zip Locality  Zip Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"zip_code","schema":{"type":"string","title":"Zip Code","description":"5-digit ZIP"},"required":true,"description":"5-digit ZIP"}],"description":"Resolve a 5-digit ZIP to its CMS locality/state/carrier/rural flag. 404 when\nthe ZIP isn't on the locality file.","operationId":"zip_locality_api_zip_locality__zip_code__get"}},"/api/ccsr/category/{category}":{"get":{"tags":["ccsr"],"summary":"Ccsr By Category","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr By Category Api Ccsr Category  Category  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"category","schema":{"type":"string","title":"Category","description":"CCSR category code, e.g. END003"},"required":true,"description":"CCSR category code, e.g. END003"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"ICD-10-CM codes whose DEFAULT CCSR category matches (use the code lookup\nfor a single code's full multi-category mapping).","operationId":"ccsr_by_category_api_ccsr_category__category__get"}},"/api/lab-ncd/cpt/{code}/edits":{"get":{"tags":["reference"],"summary":"Lab Ncd Cpt Edits","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Lab Ncd Cpt Edits Api Lab Ncd Cpt  Code  Edits Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"lab CPT/HCPCS code"},"required":true,"description":"lab CPT/HCPCS code"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The Lab-NCDs governing a lab procedure AS OF a dos (raw, DATE-EXACT getter).","operationId":"lab_ncd_cpt_edits_api_lab_ncd_cpt__code__edits_get"}},"/api/mac-jurisdiction/{state}":{"get":{"tags":["medicaid","mac"],"summary":"Mac Jurisdiction","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Mac Jurisdiction Api Mac Jurisdiction  State  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"state","schema":{"type":"string","title":"State","description":"2-letter state/territory code (e.g. CA) or full name"},"required":true,"description":"2-letter state/territory code (e.g. CA) or full name"}],"description":"Which Medicare MAC processes claims for a service state: the A/B, HH+H, and\nDME MAC (+ jurisdiction ids). The state->MAC join key for the MAC-indexed\nnlcd coverage data. 404 if the state is unknown (or the table isn't deployed).","operationId":"mac_jurisdiction_api_mac_jurisdiction__state__get"}},"/api/proc-demographics/{code}":{"get":{"tags":["codes"],"summary":"Proc Demographic Verdict","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Proc Demographic Verdict Api Proc Demographics  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS procedure code"},"required":true,"description":"CPT/HCPCS procedure code"},{"in":"query","name":"age","schema":{"anyOf":[{"type":"integer","maximum":130,"minimum":0},{"type":"null"}],"title":"Age","description":"Patient age in years"},"required":false,"description":"Patient age in years"},{"in":"query","name":"sex","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sex","description":"Patient sex: M/F or male/female"},"required":false,"description":"Patient sex: M/F or male/female"},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD)"},"required":false,"description":"Date of service (YYYY-MM-DD)"}],"description":"Adjudicate a procedure code against its demographic restrictions (the\nI/OCE age band + the Hank-curated sex overlay). Returns a verdict with\n``ok`` + any ``conflicts`` (each tagged ``origin`` so a sex conflict reads as\nHank policy, not a CMS fact). 422 on a bad sex token; a ``not_deployed``\navailability (no verdict asserted) when the I/OCE tables aren't here.","operationId":"proc_demographic_verdict_api_proc_demographics__code__get"}},"/api/rxnorm/{rxcui}/ndc-codes":{"get":{"tags":["reverse-lookup"],"summary":"Rxnorm Ndc Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rxnorm Ndc Codes Api Rxnorm  Rxcui  Ndc Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"rxcui","schema":{"type":"string","title":"Rxcui"},"required":true}],"description":"The NDCs that map to an RxNorm RXCUI (reverse of the NDC<->RxNorm crosswalk).","operationId":"rxnorm_ndc_codes_api_rxnorm__rxcui__ndc_codes_get"}},"/api/icd11-map/{system}/{code}":{"get":{"tags":["medicaid","icd11"],"summary":"Icd11 Map Forward","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd11 Map Forward Api Icd11 Map  System   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"system","schema":{"$ref":"#/components/schemas/Icd11MapSystem","description":"icd10 | icd11 (the code's own system)"},"required":true,"description":"icd10 | icd11 (the code's own system)"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"the source code (a WHO ICD-10 code, or an ICD-11 MMS code)"},"required":true,"description":"the source code (a WHO ICD-10 code, or an ICD-11 MMS code)"}],"description":"Forward WHO ICD-10 <-> ICD-11 mapping: a code -> its counterparts in the\nother revision, with WHO's map relation (one-category or multiple-categories)\nand each side's class kind and depth. WHO's single best target\n(``one_category``) sorts FIRST. The ICD-10 side accepts the code dotted or\ndotless (``A00.9`` = ``A009``).\n\nGATED (WHO CC BY-ND 3.0 IGO): a non-entitled caller is 403'd, never\nside-doored. The gate is the **icd11** corpus - one grant covers the code\ntype, the icd11 scope and this route - so the 403 below names the corpus the\ngate really checks. The ICD-11 -> ICD-10 direction also rides the\n``icd10_equivalents`` field on an icd11 profile, under that same grant.\n\nNOTE the ICD-10 side is WHO ICD-10, NOT the US ICD-10-CM. Empty mappings\nwhen the code has no WHO map row or the table is not deployed.","operationId":"icd11_map_forward_api_icd11_map__system___code__get"}},"/api/wage-index/zip/{zip_code}":{"get":{"tags":["medicaid","wage-index"],"summary":"Wage Index By Zip","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Wage Index By Zip Api Wage Index Zip  Zip Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"zip_code","schema":{"type":"string","title":"Zip Code","description":"5-digit ZIP code (a ZIP+4 suffix is accepted and ignored)"},"required":true,"description":"5-digit ZIP code (a ZIP+4 suffix is accepted and ignored)"},{"in":"query","name":"fy","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy","description":"Fiscal year (default: newest loaded; resolves at-or-before)"},"required":false,"description":"Fiscal year (default: newest loaded; resolves at-or-before)"}],"description":"CMS IPPS wage index for a ZIP CODE. The wage index is published by CBSA, but\nevery real consumer holds a ZIP, so this resolves the ZIP through the zip_cbsa\ncrosswalk and returns EVERY labor-market area it touches with that area's ratio\nweight - a ZIP that straddles a boundary belongs to more than one, and nothing\nis collapsed to a single answer. ``legs`` also carries the untouched OMB\ngeography (CBSA + title), so \"what CBSA is this ZIP in?\" stays answerable.\nReference data only - the wage index is an input to IPPS payment, which lives in\nHank PP Man. 422 on a malformed ZIP; 404 splits five ways (crosswalk not\ndeployed / ZIP off-file / wage-index dataset not deployed / a territory ZIP\nwith no IPPS labor-market area / no wage-index row for the ZIP's areas).","operationId":"wage_index_by_zip_api_wage_index_zip__zip_code__get"}},"/api/mips/measures/{measure_id}":{"get":{"tags":["reverse-lookup"],"summary":"Mips Measure","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Mips Measure Api Mips Measures  Measure Id  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"measure_id","schema":{"type":"string","title":"Measure Id"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"A CMS MIPS quality measure by id (404 when unknown).","operationId":"mips_measure_api_mips_measures__measure_id__get"}},"/api/telehealth/supported-years":{"get":{"tags":["reverse-lookup"],"summary":"Telehealth Supported Years","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Telehealth Supported Years Api Telehealth Supported Years Get","additionalProperties":true}}},"description":"Successful Response"}},"description":"The calendar years the Medicare telehealth list is loaded for.","operationId":"telehealth_supported_years_api_telehealth_supported_years_get"}},"/api/codes/{type}/{code}/summary":{"get":{"tags":["codes"],"summary":"Get Code Summary","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Get Code Summary Api Codes  Type   Code  Summary Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"type","schema":{"$ref":"#/components/schemas/CodeType"},"required":true},{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false},{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"operationId":"get_code_summary_api_codes__type___code__summary_get"}},"/api/concepts/{code_type}/{code}":{"get":{"tags":["codes"],"summary":"Procedure Concept Siblings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Procedure Concept Siblings Api Concepts  Code Type   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code_type","schema":{"type":"string","title":"Code Type","description":"cpt | hcpcs | msdrg | icdpcs"},"required":true,"description":"cpt | hcpcs | msdrg | icdpcs"},{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true}],"description":"Cross-setting procedure siblings (#149): the procedure concept(s) this code\nbelongs to + its sibling code forms across CPT/MS-DRG/APR-DRG/APC. Works\nforward (CPT→DRG/APC) and reverse (DRG→CPT). The verb is `siblings`, but the\nroute is `/concepts` because `/icd/{code}/siblings` is ICD laterality.","operationId":"procedure_concept_siblings_api_concepts__code_type___code__get"}},"/api/gems/{source_system}/{code}":{"get":{"tags":["medicaid","gems"],"summary":"Gems Forward","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Gems Forward Api Gems  Source System   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"source_system","schema":{"$ref":"#/components/schemas/GemsSystem","description":"icd10cm | icd10pcs | icd9cm | icd9pcs (the code's own system)"},"required":true,"description":"icd10cm | icd10pcs | icd9cm | icd9pcs (the code's own system)"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"the source code, dotted or dotless"},"required":true,"description":"the source code, dotted or dotless"}],"description":"Forward GEMs: a code -> its equivalents in the other ICD version, with the\napproximate/no_map/combination flags. The ICD-9 side (icd9cm/icd9pcs - not a\ntop-level code type) is reachable only here; the ICD-10 forward+reverse also\nrides the .gems profile section. PUBLIC DOMAIN, frozen FY2018 (no license\ngate). Empty mappings when the code has no GEMs row / the table isn't\ndeployed.","operationId":"gems_forward_api_gems__source_system___code__get"}},"/api/icd/{code}/billable-options":{"get":{"tags":["codes"],"summary":"Icd Billable Options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Icd Billable Options Api Icd  Code  Billable Options Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"operationId":"icd_billable_options_api_icd__code__billable_options_get"}},"/api/rbcs/categories/{cat}/codes":{"get":{"tags":["groups"],"summary":"Rbcs Codes By Category","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Codes By Category Api Rbcs Categories  Cat  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cat","schema":{"type":"string","title":"Cat"},"required":true}],"operationId":"rbcs_codes_by_category_api_rbcs_categories__cat__codes_get"}},"/api/scopes/{type}/{scope}/codes":{"get":{"tags":["codes"],"summary":"Expand Scope","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Expand Scope Api Scopes  Type   Scope  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"type","schema":{"$ref":"#/components/schemas/ScopeType","description":"rbcs|group|ccsr|mdc|hcc|vsac|rxhcc|loinc-class|cdt-category|specialty|ccsr-pcs|procedure-class"},"required":true,"description":"rbcs|group|ccsr|mdc|hcc|vsac|rxhcc|loinc-class|cdt-category|specialty|ccsr-pcs|procedure-class"},{"in":"path","name":"scope","schema":{"type":"string","title":"Scope","description":"The classification id (e.g. an RBCS subcategory, HCC number, MDC)"},"required":true,"description":"The classification id (e.g. an RBCS subcategory, HCC number, MDC)"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"limit","schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Limit","description":"Max codes (default 1000, hard cap 5000); page with offset."},"required":false,"description":"Max codes (default 1000, hard cap 5000); page with offset."},{"in":"query","name":"offset","schema":{"type":"integer","title":"Offset","default":0,"minimum":0},"required":false},{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"Expand a classification scope to its member codes (capped + paged). A\nplanned/undeployed scope type returns an empty ``not_deployed`` page; a gated\nscope (loinc-class/cdt-category) is 403'd for a non-entitled caller.","operationId":"expand_scope_api_scopes__type___scope__codes_get"}},"/api/anesthesia/{code}/base-units":{"get":{"tags":["crosswalk"],"summary":"Base Units","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Base Units Api Anesthesia  Code  Base Units Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"query","name":"source","schema":{"enum":["default","CMS","ASA"],"type":"string","title":"Source","default":"default"},"required":false},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"Anesthesia base units for a code (CMS or ASA source).\n\nASA-licensed (the ASA Relative Value Guide): **403** for a caller with no ASA\nentitlement - these are the same numbers the ``anesthesia`` profile section\nwithholds.","operationId":"base_units_api_anesthesia__code__base_units_get"}},"/api/ccsr/keyword/{keyword}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Ccsr Keyword Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Keyword Codes Api Ccsr Keyword  Keyword  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"keyword","schema":{"type":"string","title":"Keyword"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"ICD-10-CM codes whose description matches a keyword (the full getter list,\nuncapped - distinct from the playground's capped /ccsr/search).","operationId":"ccsr_keyword_codes_api_ccsr_keyword__keyword__codes_get"}},"/api/anesthesia/anes-to-surg/{asa}":{"get":{"tags":["crosswalk"],"summary":"Asa To Cpts","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Asa To Cpts Api Anesthesia Anes To Surg  Asa  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"asa","schema":{"type":"string","title":"Asa"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"customer","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"ASA anesthesia code -> every surgical CPT that crosswalks to it.\n\nASA-licensed (the ASA Crosswalk): **403** for a caller with no ASA\nentitlement. Iterating this route reproduces the whole Crosswalk, which is\nwhy it is gated exactly like the ``crosswalks`` profile section.","operationId":"asa_to_cpts_api_anesthesia_anes_to_surg__asa__get"}},"/api/anesthesia/surg-to-anes/{cpt}":{"get":{"tags":["crosswalk"],"summary":"Cpt To Asa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Cpt To Asa Api Anesthesia Surg To Anes  Cpt  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"cpt","schema":{"type":"string","title":"Cpt"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"customer","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false}],"description":"Surgical CPT -> the ASA anesthesia code(s) that bill with it.\n\nASA-licensed (the ASA Crosswalk): **403** for a caller with no ASA\nentitlement, naming the corpus to request.","operationId":"cpt_to_asa_api_anesthesia_surg_to_anes__cpt__get"}},"/api/codes/{type}/{code}/{section}":{"get":{"tags":["codes"],"summary":"Get Code Section","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Get Code Section Api Codes  Type   Code   Section  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"type","schema":{"$ref":"#/components/schemas/CodeType"},"required":true},{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true},{"in":"path","name":"section","schema":{"type":"string","title":"Section","description":"one of: ahrq_qi | anesthesia | apr_drg_weights | asa_rules | asc_payment | asp | cdps | cdps_rx | cdt_editorial | clfs | crosswalks | dmepos | eapg_weights | elixhauser | esrd_comorbidity | fee_schedule | frequency | gems | groups | guidance | hac | hcc | hedis_value_sets | hh_pdgm | icd | icd10cm_notes | icd10cm_snomed | icd_index | icdpcs | ioce_proc_demographics | ipf_comorbidity | irf_comorbidity | lab_ncd | mce | medicaid_eob | memberships | mips | modifier_payment | moldx_dex_tests | mue | nadac | ncci | ncci_add_on | ndc | ndc_rxnorm | nlcd | nucc_specialty | opps_payment | orange_book | preventive | prior_auth | procedure_concept | purple_book | rbcs | relationships | rvu | snomed_icd10cm_map | telehealth | tos | vaccine"},"required":true,"description":"one of: ahrq_qi | anesthesia | apr_drg_weights | asa_rules | asc_payment | asp | cdps | cdps_rx | cdt_editorial | clfs | crosswalks | dmepos | eapg_weights | elixhauser | esrd_comorbidity | fee_schedule | frequency | gems | groups | guidance | hac | hcc | hedis_value_sets | hh_pdgm | icd | icd10cm_notes | icd10cm_snomed | icd_index | icdpcs | ioce_proc_demographics | ipf_comorbidity | irf_comorbidity | lab_ncd | mce | medicaid_eob | memberships | mips | modifier_payment | moldx_dex_tests | mue | nadac | ncci | ncci_add_on | ndc | ndc_rxnorm | nlcd | nucc_specialty | opps_payment | orange_book | preventive | prior_auth | procedure_concept | purple_book | rbcs | relationships | rvu | snomed_icd10cm_map | telehealth | tos | vaccine"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"required":false},{"in":"query","name":"locality","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality","description":"7-digit CMS GPCI locality (e.g. 0111205); adds locality-adjusted MPFS fees to the rvu section. National if omitted."},"required":false,"description":"7-digit CMS GPCI locality (e.g. 0111205); adds locality-adjusted MPFS fees to the rvu section. National if omitted."},{"in":"query","name":"zip","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip","description":"5-digit ZIP - resolved to a locality via the CMS ZIP-to-carrier-locality crosswalk (locality wins if both given)."},"required":false,"description":"5-digit ZIP - resolved to a locality via the CMS ZIP-to-carrier-locality crosswalk (locality wins if both given)."},{"in":"query","name":"strict","schema":{"type":"boolean","title":"Strict","default":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."},"required":false,"description":"Flip a not_deployed answer to HTTP 503 so a naive raise_for_status() client throws (present_empty / not_applicable / present_with_data answers stay 200)."}],"description":"One enrichment section on demand. Three-state: ``not_applicable`` (section\ndoesn't apply to this type), ``not_deployed`` (data absent / planned), else\n``available`` reflects whether this code carries content. Unknown section -> 422.","operationId":"get_code_section_api_codes__type___code___section__get"}},"/api/nlcd/{code}/coverage-articles":{"get":{"tags":["reference"],"summary":"Nlcd Coverage Articles","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Nlcd Coverage Articles Api Nlcd  Code  Coverage Articles Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"CPT/HCPCS code"},"required":true,"description":"CPT/HCPCS code"},{"in":"query","name":"as_of","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of","description":"as-of date YYYY-MM-DD"},"required":false,"description":"as-of date YYYY-MM-DD"}],"description":"The raw NCD/LCD coverage-article rows for a code (the /nlcd profile section\nENRICHES these into per-MAC NlcdMAC entries via a multi-table join, so it is\nnot a 1:1 of the getter - this route is the raw getter).","operationId":"nlcd_coverage_articles_api_nlcd__code__coverage_articles_get"}},"/api/elixhauser/{comorbidity}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Elixhauser Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Elixhauser Codes Api Elixhauser  Comorbidity  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"comorbidity","schema":{"type":"string","title":"Comorbidity"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The ICD-10-CM codes flagged for an Elixhauser comorbidity (reverse).","operationId":"elixhauser_codes_api_elixhauser__comorbidity__codes_get"}},"/api/medicaid-edit/{program}/{edit}":{"get":{"tags":["medicaid"],"summary":"Medicaid Edit","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Medicaid Edit Api Medicaid Edit  Program   Edit  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"program","schema":{"type":"string","title":"Program","description":"source_program slug, e.g. va_dmas"},"required":true,"description":"source_program slug, e.g. va_dmas"},{"in":"path","name":"edit","schema":{"type":"string","title":"Edit","description":"the state's MMIS/EOB/error/RAD edit code"},"required":true,"description":"the state's MMIS/EOB/error/RAD edit code"}],"description":"Forward: a state Medicaid edit -> its national codes + resolution. 404 if\nthe program/edit pair isn't in the crosswalk (or the tables aren't deployed).","operationId":"medicaid_edit_api_medicaid_edit__program___edit__get"}},"/api/risk-models/hcc/icd/{icd}/hccs":{"get":{"tags":["risk-models"],"summary":"Hcc For Icd","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Hcc For Icd Api Risk Models Hcc Icd  Icd  Hccs Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"icd","schema":{"type":"string","title":"Icd","description":"ICD-10-CM code"},"required":true,"description":"ICD-10-CM code"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"},{"in":"query","name":"with_scores","schema":{"type":"boolean","title":"With Scores","default":false,"description":"include each HCC's RAF score"},"required":false,"description":"include each HCC's RAF score"}],"description":"The HCC(s) an ICD-10-CM code maps to, per model year (a {year:[hcc]} map; a\nflat list when `year`/`dos` pins one year). With ``with_scores`` each entry is\n{hcc, score, year} (getHCCsAndScoresForCode).","operationId":"hcc_for_icd_api_risk_models_hcc_icd__icd__hccs_get"}},"/api/ccsr/body-system/{system}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Ccsr Body System Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Body System Codes Api Ccsr Body System  System  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"system","schema":{"type":"string","title":"System"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"ICD-10-CM codes in a CCSR body system.","operationId":"ccsr_body_system_codes_api_ccsr_body_system__system__codes_get"}},"/api/rbcs/group/{group_name}/summary":{"get":{"tags":["reverse-lookup"],"summary":"Rbcs Group Summary","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Group Summary Api Rbcs Group  Group Name  Summary Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"group_name","schema":{"type":"string","title":"Group Name"},"required":true}],"description":"The RBCS category/subcategory code-count summary for a CPTGrouper group.","operationId":"rbcs_group_summary_api_rbcs_group__group_name__summary_get"}},"/api/risk-models/hcc/{hcc}/crosswalk":{"get":{"tags":["risk-models"],"summary":"Hcc Crosswalk","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Hcc Crosswalk Api Risk Models Hcc  Hcc  Crosswalk Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"hcc","schema":{"type":"string","title":"Hcc","description":"HCC category number"},"required":true,"description":"HCC category number"},{"in":"query","name":"direction","schema":{"type":"string","title":"Direction","default":"v24_to_v28","description":"v24_to_v28 | v28_to_v24"},"required":false,"description":"v24_to_v28 | v28_to_v24"}],"description":"The CMS-HCC V24<->V28 crosswalk for an HCC (shared-ICD-evidence map).","operationId":"hcc_crosswalk_api_risk_models_hcc__hcc__crosswalk_get"}},"/api/guidance/proposals/{proposal_id}":{"get":{"tags":["guidance"],"summary":"Get Proposal","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Get Proposal Api Guidance Proposals  Proposal Id  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"proposal_id","schema":{"type":"string","title":"Proposal Id"},"required":true}],"description":"One proposal + the code's CURRENT corpus rows (the review diff context).","operationId":"get_proposal_api_guidance_proposals__proposal_id__get"}},"/api/medicaid-edits/{code_kind}/{code}":{"get":{"tags":["reference"],"summary":"Medicaid Edits For Code","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Medicaid Edits For Code Api Medicaid Edits  Code Kind   Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"code_kind","schema":{"type":"string","title":"Code Kind","description":"carc | rarc"},"required":true,"description":"carc | rarc"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"national CARC/RARC code"},"required":true,"description":"national CARC/RARC code"},{"in":"query","name":"per_program","schema":{"type":"integer","title":"Per Program","default":40,"minimum":1,"description":"per-jurisdiction sample cap"},"required":false,"description":"per-jurisdiction sample cap"}],"description":"The state Medicaid MMIS edits that map to a national CARC/RARC code (the\nreverse crosswalk, per-program-sampled). Public-domain → ungated.","operationId":"medicaid_edits_for_code_api_medicaid_edits__code_kind___code__get"}},"/api/rbcs/subcategories/{subcat}/codes":{"get":{"tags":["groups"],"summary":"Rbcs Codes By Subcategory","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Codes By Subcategory Api Rbcs Subcategories  Subcat  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"subcat","schema":{"type":"string","title":"Subcat"},"required":true}],"operationId":"rbcs_codes_by_subcategory_api_rbcs_subcategories__subcat__codes_get"}},"/api/risk-models/{model}/model-version":{"get":{"tags":["risk-models"],"summary":"Model Version","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Model Version Api Risk Models  Model  Model Version Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"model","schema":{"type":"string","title":"Model"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"The model version in effect (HCC resolves V24/V28 by year; the companion\nmodels are constant).","operationId":"model_version_api_risk_models__model__model_version_get"}},"/api/ccsr/any-category/{category}/codes":{"get":{"tags":["reverse-lookup"],"summary":"Ccsr Any Category Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Ccsr Any Category Codes Api Ccsr Any Category  Category  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"category","schema":{"type":"string","title":"Category"},"required":true},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false}],"description":"ICD-10-CM codes that map to a CCSR category in ANY slot (not just default).","operationId":"ccsr_any_category_codes_api_ccsr_any_category__category__codes_get"}},"/api/rbcs/families/{subcat}/{fam}/codes":{"get":{"tags":["groups"],"summary":"Rbcs Codes By Family","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Codes By Family Api Rbcs Families  Subcat   Fam  Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"subcat","schema":{"type":"string","title":"Subcat"},"required":true},{"in":"path","name":"fam","schema":{"type":"string","title":"Fam"},"required":true}],"operationId":"rbcs_codes_by_family_api_rbcs_families__subcat___fam__codes_get"}},"/api/risk-models/{model}/supported-years":{"get":{"tags":["risk-models"],"summary":"Supported Years","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Supported Years Api Risk Models  Model  Supported Years Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"model","schema":{"type":"string","title":"Model"},"required":true}],"description":"The model years loaded for this risk model.","operationId":"supported_years_api_risk_models__model__supported_years_get"}},"/api/guidance/proposals/{proposal_id}/apply":{"post":{"tags":["guidance"],"summary":"Retry Apply","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Retry Apply Api Guidance Proposals  Proposal Id  Apply Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"proposal_id","schema":{"type":"string","title":"Proposal Id"},"required":true}],"description":"Re-run the commit-back for an APPROVED proposal whose apply queued or\nfailed (e.g. the write token was unarmed at approve time).","operationId":"retry_apply_api_guidance_proposals__proposal_id__apply_post"}},"/api/guidance/proposals/{proposal_id}/decide":{"post":{"tags":["guidance"],"summary":"Decide Proposal","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Decide Proposal Api Guidance Proposals  Proposal Id  Decide Post","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"proposal_id","schema":{"type":"string","title":"Proposal Id"},"required":true}],"description":"Approve / deny / request-changes under the proposal-row lock. Stale\ntargets -> 409 (the proposal stays pending; re-propose against current rows).\nAn approve MAY carry reviewer ``amendments`` (edit-then-approve); a bad\namendment -> 422 and nothing is decided. ``request_changes`` bounces the\nproposal back with the required note to a distinct ``changes_requested``\nstate (no apply). Approval applies the change to the canonical guidance\ncorpus and the proposal reaches 'applied' once the resulting rows are\nobserved serving; an unavailable write transport queues the approval LOUDLY.","operationId":"decide_proposal_api_guidance_proposals__proposal_id__decide_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideIn"}}},"required":true}}},"/api/rbcs/group/{group_name}/classifications":{"get":{"tags":["reverse-lookup"],"summary":"Rbcs Group Classifications","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Rbcs Group Classifications Api Rbcs Group  Group Name  Classifications Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"group_name","schema":{"type":"string","title":"Group Name"},"required":true}],"description":"Per-code RBCS classifications for every CPT in a CPTGrouper group (the\ncross-service get_rbcs_for_group rollup), as records.","operationId":"rbcs_group_classifications_api_rbcs_group__group_name__classifications_get"}},"/api/risk-models/{model}/{code}/member-codes":{"get":{"tags":["risk-models"],"summary":"Member Codes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Member Codes Api Risk Models  Model   Code  Member Codes Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"model","schema":{"type":"string","title":"Model","description":"hcc | rxhcc | esrdhcc | hhshcc"},"required":true,"description":"hcc | rxhcc | esrdhcc | hhshcc"},{"in":"path","name":"code","schema":{"type":"string","title":"Code","description":"risk-category id (HHS-HCC ids are strings)"},"required":true,"description":"risk-category id (HHS-HCC ids are strings)"},{"in":"query","name":"year","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"required":false},{"in":"query","name":"dos","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"date of service YYYY-MM-DD"},"required":false,"description":"date of service YYYY-MM-DD"}],"description":"The member ICD-10-CM codes of a risk category as {year: [icds]}. HCC honors\nyear/dos; the companions return all loaded years.","operationId":"member_codes_api_risk_models__model___code__member_codes_get"}},"/api/scopes/{scope_type}/{scope}/contains/{code}":{"get":{"tags":["codes"],"summary":"Scope Contains","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","title":"Response Scope Contains Api Scopes  Scope Type   Scope  Contains  Code  Get","additionalProperties":true}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"parameters":[{"in":"path","name":"scope_type","schema":{"type":"string","title":"Scope Type","description":"group | rbcs"},"required":true,"description":"group | rbcs"},{"in":"path","name":"scope","schema":{"type":"string","title":"Scope","description":"CPTGrouper group name OR RBCS subcategory"},"required":true,"description":"CPTGrouper group name OR RBCS subcategory"},{"in":"path","name":"code","schema":{"type":"string","title":"Code"},"required":true}],"description":"Membership test: is `code` in the given group / RBCS subcategory?","operationId":"scope_contains_api_scopes__scope_type___scope__contains__code__get"}}},"openapi":"3.1.0","servers":[{"url":"https://api.hank.ai/v1/codesets","description":"Production - Hank edge (metered, token-validated)"},{"url":"http://localhost:8765","description":"Local dev (direct backend)"}],"security":[{"HankAccessToken":[]}],"components":{"schemas":{"PushIn":{"type":"object","title":"PushIn","properties":{"confirm":{"type":"boolean","title":"Confirm","default":false},"providers":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":10},{"type":"null"}],"title":"Providers"},"code_types":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":50},{"type":"null"}],"title":"Code Types"}}},"NlcdMAC":{"type":"object","title":"NlcdMAC","required":["contractor_number","contractor_name","article_id","article_version","article_url"],"properties":{"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State identifier - the FIPS code string (e.g. '42' for PA) from the native article_contractors.state_id (INTEGER). Operator/UI maps FIPS → 2-letter postal as needed."},"lcd_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lcd Id"},"lcd_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lcd Url"},"lcd_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lcd Title"},"article_id":{"type":"integer","title":"Article Id"},"lcd_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lcd Status"},"article_url":{"type":"string","title":"Article Url"},"article_version":{"type":"integer","title":"Article Version"},"contractor_name":{"type":"string","title":"Contractor Name"},"contractor_number":{"type":"integer","title":"Contractor Number"}},"description":"One MAC x article entry covering a code (the NCD/LCD coverage section).\n\n`article_url` / `lcd_url` are built locally from the IDs - no fetch needed.\nThe URL format and the active-date predicate mirror the legacy\nclaim-cleaner NCD_LCD_Edits recipe (kept for cross-repo parity), but the\nDATA is now read from codesets' OWN native NLCD tables (the §10 move-home)."},"RetryIn":{"type":"object","title":"RetryIn","required":["code_type","provider"],"properties":{"confirm":{"type":"boolean","title":"Confirm","default":false},"provider":{"type":"string","title":"Provider","maxLength":50,"minLength":1},"code_type":{"type":"string","title":"Code Type","maxLength":100,"minLength":1}}},"CodeType":{"enum":["cpt","hcpcs","icd","modifier","hcc","icdpcs","icd11","ndc","msdrg","pos","nucc","rxhcc","hhshcc","esrdhcc","carc","rarc","srdr","cdt","sopt","hipps","aprdrg","eapg","ncpdp-reject","moldx-dex","rxnorm","loinc","atc"],"type":"string","title":"CodeType"},"DecideIn":{"type":"object","title":"DecideIn","required":["action"],"properties":{"note":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Note"},"action":{"enum":["approve","deny","request_changes"],"type":"string","title":"Action"},"amendments":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/AmendmentIn"},"maxItems":500},{"type":"null"}],"title":"Amendments"}}},"HacEntry":{"type":"object","title":"HacEntry","properties":{"cc_mcc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cc Mcc"},"dx_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dx Role"},"hac_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hac Category"},"hac_category_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Hac Category Number"}},"description":"One CMS Hospital-Acquired Condition mapping for an ICD-10-CM code: the\nHAC category (+ its number), the code's CC/MCC severity flag, and the\ndiagnosis role (e.g. principal / secondary) within the HAC definition."},"MueEntry":{"type":"object","title":"MueEntry","properties":{"qtr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qtr"},"mue_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mue Value"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"service_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Type"},"adjudication_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adjudication Indicator"}},"description":"One Medically Unlikely Edit row (max units of service)."},"NCCIEdit":{"type":"object","title":"NCCIEdit","required":["other_code","position","modifier_indicator"],"properties":{"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"position":{"type":"string","title":"Position"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"other_code":{"type":"string","title":"Other Code"},"deletion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletion Date"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"modifier_indicator":{"type":"integer","title":"Modifier Indicator"}},"description":"One NCCI procedure-to-procedure edit row for a code.\n\n`position` is which side of the (column_1, column_2) pair this code sits on.\n`modifier_indicator`: 0 = never bill together; 1 = modifier can override; 9 = N/A."},"TosEntry":{"type":"object","title":"TosEntry","required":["tos_code"],"properties":{"tos_code":{"type":"string","title":"Tos Code"},"tos_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tos Description"}},"description":"One CMS Type-of-Service indicator for a CPT/HCPCS code: the TOS code\n(e.g. '1' medical care, '2' surgery, 'D' ambulance) and its description."},"HippsAxis":{"type":"object","title":"HippsAxis","required":["position","name","value"],"properties":{"name":{"type":"string","title":"Name"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"known":{"type":"boolean","title":"Known","default":true},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"value":{"type":"string","title":"Value"},"detail":{"type":"object","title":"Detail","additionalProperties":true},"position":{"type":"string","title":"Position"}},"description":"One decoded axis of a HIPPS rate code.\n\n``position`` is the 1-based character position or span the axis occupies\n(\"1\", \"2-3\", \"4-5\"); ``value`` is the literal character(s) taken from the\ncode. ``label`` is the decoded meaning and is None when the value could not\nbe resolved -- ``known`` is then False and ``note`` says WHY (either a\ndocumented CMS publication gap, or a value outside the published table for\nthat position). An axis is emitted only when it APPLIES: an atypical IRF\ncase mix group has no Rehabilitation Impairment Category, so that axis is\nabsent rather than present-and-unknown."},"MipsEntry":{"type":"object","title":"MipsEntry","required":["measure_id","role"],"properties":{"role":{"type":"string","title":"Role"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"code_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Type"},"measure_id":{"type":"string","title":"Measure Id"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"role_meaning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Meaning"}},"description":"One CMS MIPS Quality measure that references a code, and the ROLE the code\nplays. ``role`` in {denominator, numerator, exclusion, exception} (verbatim\nfrom the QPP optionType - never collapsed). ``code_type`` is the stored side\nthe match came from (cpt/hcpcs/icd10)."},"ScopeType":{"enum":["rbcs","group","ccsr","mdc","hcc","vsac","hedis","rxhcc","icd11","loinc-class","cdt-category","specialty","ccsr-pcs","procedure-class"],"type":"string","title":"ScopeType"},"AtcProfile":{"type":"object","title":"AtcProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"standard":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard"},"atc_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Atc Class"}},"description":"WHO ATC drug-classification section: the ATC code, its name, the ATC level\n(atc_class), and standard-concept flag. GATED (WHO license)."},"CdtProfile":{"type":"object","title":"CdtProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"long_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Long Description"}},"description":"CDT (ADA Current Dental Terminology) section: the dental D-code + its\nofficial descriptor, derived from the CMS HCPCS file's ADA descriptors."},"CptProfile":{"type":"object","title":"CptProfile","properties":{"description_long":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Long"},"description_short":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Short"},"description_medium":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Medium"},"description_consumer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Consumer"},"description_clinician":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Clinician"}},"description":"CPT/HCPCS-specific section: the AMA descriptor variants.\n\nThe top-level CodeProfile.description is the LONGEST (full) descriptor; this\nblock exposes the shorter AMA forms a coder needs for different surfaces -\n``description_short`` (≤28 char, claim/EHR fields), ``description_medium``,\n``description_long`` (the full clinical descriptor), plus the SNOMED-mapped\n``description_clinician`` and the plain-language ``description_consumer``.\nAny form may be ``None`` for a code whose AMA descriptor file didn't carry it\n(e.g. a brand-new CMS-only HCPCS with only the short PPRRVU descriptor)."},"EapgWeight":{"type":"object","title":"EapgWeight","properties":{"eapg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eapg"},"payer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payer"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"scale_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Scale Factor"},"service_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Line"},"scaled_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Scaled Weight"},"source_format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Format"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"grouper_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grouper Version"},"national_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"National Weight"},"normalization_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Normalization Factor"}},"description":"One payer-published EAPG weight row. The fixed-width payer file publishes\nonly ``scaled_weight``; the national weight, scale factor, and normalization\nfactor come from the payer's companion workbook and are None otherwise."},"GemMapping":{"type":"object","title":"GemMapping","required":["source_system","source_code"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"no_map":{"type":"integer","title":"No Map","default":0},"scenario":{"type":"integer","title":"Scenario","default":0},"approximate":{"type":"integer","title":"Approximate","default":0},"choice_list":{"type":"integer","title":"Choice List","default":0},"combination":{"type":"integer","title":"Combination","default":0},"source_code":{"type":"string","title":"Source Code"},"target_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Code"},"source_system":{"type":"string","title":"Source System"}},"description":"One CMS General Equivalence Mapping row: a source code in one ICD version\nmapped to a target code in the other, with the five GEMs flags. Frozen at\nFY2018 (CMS's final GEMs). ``target_code`` is None for a no_map row (the\nsource has no valid equivalent in the other version)."},"GemsSystem":{"enum":["icd10cm","icd10pcs","icd9cm","icd9pcs"],"type":"string","title":"GemsSystem","description":"The four GEMs source systems (the code's own ICD version/side). Restricts\nthe /api/gems path param so an unknown system 422s deterministically."},"HacProfile":{"type":"object","title":"HacProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/HacEntry"},"title":"Entries","default":[]}},"description":"CMS Hospital-Acquired Condition categories an ICD-10-CM diagnosis maps to,\nfrom the codesets ``hac_icd`` table. When such a diagnosis is not\nPresent-On-Admission it is excluded from increasing MS-DRG payment. Distinct\nfrom the POA-exempt coding list. Empty when the code is in no HAC category."},"HccProfile":{"type":"object","title":"HccProfile","required":["hcc"],"properties":{"hcc":{"type":"integer","title":"Hcc"},"trumps":{"type":"array","items":{"type":"integer"},"title":"Trumps","default":[]},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"},"risk_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Score"},"trumped_by":{"type":"array","items":{"type":"integer"},"title":"Trumped By","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"member_icds":{"type":"array","items":{"type":"string"},"title":"Member Icds","default":[]},"model_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version"},"score_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Score Segment"},"member_icd_count":{"type":"integer","title":"Member Icd Count","default":0},"members_truncated":{"type":"boolean","title":"Members Truncated","default":false},"scores_by_segment":{"type":"object","title":"Scores By Segment","default":{},"additionalProperties":{"type":"number"}},"version_crosswalk":{"type":"array","items":{"$ref":"#/components/schemas/HccCrosswalkEntry"},"title":"Version Crosswalk","default":[]}},"description":"Forward profile for an HCC *category* (the bucket), not the reverse\nICD→HCC mapping (that's IcdHccMapping inside IcdProfile).\n\nThe HCC source data spans CMS model versions (V24/V28) keyed only on the\nbare integer, so this profile is built **model-year-coherent**: members are\ntaken from a SINGLE resolved model year (never unioned across versions), and\n``description``/``risk_score`` are best-effort and may be ``None`` for model\nversions whose label files aren't ingested yet. Validity is by MEMBERSHIP\n(the HCC has member ICDs), not by whether a description exists - half of all\nHCCs (the V28 400-series) carry mappings but no label. The full, paged member\nlist is served by ``GET /scopes/hcc/{code}/codes`` (single source of truth);\n``member_icds`` here is a capped sample."},"IcdProfile":{"type":"object","title":"IcdProfile","properties":{"ccsr":{"anyOf":[{"$ref":"#/components/schemas/CcsrProfile"},{"type":"null"}]},"hccs":{"type":"array","items":{"$ref":"#/components/schemas/IcdHccMapping"},"title":"Hccs","default":[]},"pdpm":{"anyOf":[{"$ref":"#/components/schemas/PdpmProfile"},{"type":"null"}]},"billable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Billable"},"guidance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Guidance"},"poa_exempt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Poa Exempt"},"cc_mcc_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cc Mcc Status"},"description_long":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Long"},"description_short":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Short"},"description_medium":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Medium"},"effective_date_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date End"},"effective_date_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date Start"}},"description":"ICD-10-CM-specific enrichment: billable status, CCSR class, HCC mappings.\n\nThis is what makes get_code_profile() polymorphic - an ICD code returns\ndiagnosis-relevant data (not an empty CPT shell). hccs is the latest model\nyear's mappings; tuples for cache immutability (see GroupsProfile docstring)."},"MceIcdRule":{"type":"object","title":"MceIcdRule","required":["rule"],"properties":{"rule":{"type":"string","title":"Rule"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin"}},"description":"One Medicare Code Editor (MCE) demographic/structural rule an ICD-10-CM\ncode appears under (e.g. ``age_maternity``, ``sex_female_only``,\n``unacceptable_principal``)."},"Membership":{"type":"object","title":"Membership","required":["taxonomy_key","group_id"],"properties":{"level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Level"},"group_id":{"type":"string","title":"Group Id"},"authority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authority"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"qualifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qualifier"},"group_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Label"},"license_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Note"},"taxonomy_key":{"type":"string","title":"Taxonomy Key"},"descriptor_license":{"type":"string","title":"Descriptor License","default":"free"}},"description":"One code-group membership in a single classification taxonomy.\n\nThe uniform record the unified resolver (CODES.resolve_memberships) emits for\nevery grouping axis a code touches - AMA CPT section, anesthesia region,\nHCPCS-L2 category, CPTGrouper, RBCS/BETOS, ICD-10-CM chapter, ICD-10-PCS\nfacets, CCSR, HCC, Elixhauser, HAC, AHRQ-QI, TOS, DMEPOS - so a consumer can\niterate every membership without knowing each taxonomy's bespoke shape.\n``authority`` is public provenance (safe to serialize), NOT an internal tag.\n\nPer-row license, redact-not-block: ``descriptor_license`` names the license of\nthe ``group_label`` descriptor TEXT (free for every Phase-1 axis; a gated axis\nsuch as LOINC/CDT/ATC/SNOMED carries its own). For a non-entitled caller the\negress gate NULLS ``group_label`` and stamps ``license_note`` while the\nstructural fields (``group_id``/``level``/``parent_id``/``qualifier``/\n``authority``/``taxonomy_key``) stay served, so a code's group membership stays\ndiscoverable even when the descriptor text is withheld."},"MueProfile":{"type":"object","title":"MueProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/MueEntry"},"title":"Entries","default":[]}},"description":"NCCI MUE (max units of service) for a code - one entry per service\nsetting (practitioner / outpatient hospital / DME), from the NATIVE\ncodesets ``mue`` table (quarterly CMS NCCI MUE files). DOS-aware: each\nentry is the latest quarter <= the profile's resolved year-end (exact-date\nselection lives on ``MUE.get_entries(code, dos=...)``)."},"NadacEntry":{"type":"object","title":"NadacEntry","properties":{"otc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Otc"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"as_of_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"pricing_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pricing Unit"},"pharmacy_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pharmacy Type"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"nadac_per_unit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Nadac Per Unit"},"explanation_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explanation Code"},"generic_effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generic Effective Date"},"generic_nadac_per_unit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Generic Nadac Per Unit"}},"description":"One weekly NADAC snapshot for an NDC: what retail pharmacies actually paid\nto acquire it, per ``pricing_unit`` (EA/ML/GM), as of ``as_of_date``.\n\nA survey-based ACQUISITION-cost benchmark, not a payment rate: it is what the\npharmacy paid, not what a payer allows (that is the ASP section for Part-B\ndrugs). One entry per calendar year - the latest snapshot of that year."},"NdcProfile":{"type":"object","title":"NdcProfile","properties":{"ndc11":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ndc11"},"route":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Route"},"dosage_form":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dosage Form"},"product_ndc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Ndc"},"dea_schedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dea Schedule"},"labeler_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Labeler Name"},"package_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Size"},"product_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Type"},"billing_hcpcs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Hcpcs"},"billing_units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Units"},"ndc_segmented":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ndc Segmented"},"pharm_classes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pharm Classes"},"package_quantity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Quantity"},"proprietary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proprietary Name"},"application_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Number"},"marketing_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marketing Category"},"nonproprietary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nonproprietary Name"},"package_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Description"},"billing_units_package":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Units Package"}},"description":"NDC-specific section: the FDA drug-product facts for a National Drug Code.\n\nThe matched record is keyed on the package NDC; ``ndc11`` is the normalized\n11-digit billing form and ``ndc_segmented`` the FDA dashed directory form."},"PosProfile":{"type":"object","title":"PosProfile","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"description":"Place-of-Service-specific section: the facility name + description."},"ProposalIn":{"type":"object","title":"ProposalIn","required":["kind","code_or_key","changes"],"properties":{"kind":{"enum":["cpt","icd","cpt-icd","cpt_icd"],"type":"string","title":"Kind"},"origin":{"enum":["askkrac","ui","api"],"type":"string","title":"Origin","default":"api"},"changes":{"type":"array","items":{"$ref":"#/components/schemas/ProposalChangeIn"},"title":"Changes","maxItems":500,"minItems":1},"sources":{"anyOf":[{},{"type":"null"}],"title":"Sources"},"rationale":{"anyOf":[{"type":"string","maxLength":8000},{"type":"null"}],"title":"Rationale"},"origin_ref":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Origin Ref"},"code_or_key":{"type":"string","title":"Code Or Key","maxLength":100,"minLength":1},"proposed_by":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Proposed By","description":"Attribution fallback; the server-derived identity wins when present"},"corroboration_status":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Corroboration Status"}}},"RVUProfile":{"type":"object","title":"RVUProfile","properties":{"mac":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mac"},"opps":{"anyOf":[{"$ref":"#/components/schemas/OPPSProfile"},{"type":"null"}]},"work":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Work"},"co_surg":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Co Surg"},"gpci_mp":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gpci Mp"},"gpci_pe":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gpci Pe"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality"},"asst_surg":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Asst Surg"},"endo_base":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endo Base","description":"CPT-code reference for endoscopic base procedure (e.g. '0652T'). Look this up as a separate CPT to retrieve the base RVU."},"gpci_work":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gpci Work"},"mult_proc":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mult Proc"},"team_surg":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Team Surg"},"bilat_surg":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bilat Surg"},"conv_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Conv Factor"},"facility_pe":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facility Pe"},"malpractice":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Malpractice"},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Code"},"fee_facility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Facility"},"global_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Period"},"nonfacility_pe":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Nonfacility Pe"},"pctc_indicator":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pctc Indicator"},"total_facility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Facility"},"fee_nonfacility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Nonfacility"},"calculation_flag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculation Flag"},"pricing_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pricing Indicator"},"total_nonfacility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Nonfacility"},"status_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Description"},"global_period_split":{"anyOf":[{"$ref":"#/components/schemas/GlobalPeriodProfile"},{"type":"null"}]},"nonfac_pe_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nonfac Pe Indicator"},"locality_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality Description"},"not_used_for_payment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Used For Payment"},"facility_pe_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Facility Pe Indicator"},"fee_facility_locality":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Facility Locality"},"physician_supervision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Physician Supervision"},"fee_nonfacility_locality":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Nonfacility Locality"},"diagnostic_imaging_family":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diagnostic Imaging Family"}},"description":"Relative Value Unit breakdown for a CPT code."},"RafRequest":{"type":"object","title":"RafRequest","required":["age","sex"],"properties":{"age":{"type":"integer","title":"Age","maximum":130,"minimum":0},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"sex":{"type":"string","title":"Sex","description":"'M' or 'F'"},"hccs":{"type":"array","items":{"type":"integer"},"title":"Hccs","maxItems":500,"description":"HCC category numbers present on the beneficiary"},"icds":{"type":"array","items":{"type":"string"},"title":"Icds","maxItems":500,"description":"ICD-10-CM codes (resolved to HCCs for the year)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"segment":{"type":"string","title":"Segment","default":"CNA","description":"CNA/CND/CPA/CPD/CFA/CFD (community), INS (institutional), NE/SNPNE (new-enrollee)"},"disabled":{"type":"boolean","title":"Disabled","default":false,"description":"Currently disabled - drives the DISABLED_* interactions"},"medicaid":{"type":"boolean","title":"Medicaid","default":false,"description":"Medicaid (dual) status - the NE/SNPNE grid axis. CMS-HCC and RxHCC accept it; esrdhcc (which expresses that axis as dual_status) and hhshcc (no medicaid axis at all) reject it with a 422 rather than ignore it"},"orig_disabled":{"type":"boolean","title":"Orig Disabled","default":false,"description":"Originally entitled by disability (OREC 1). On the NE/SNPNE grids CMS age-gates its own flag (NE_ORIGDS = (AGEF>=65)*(OREC='1')), so an under-65 member scores the not-originally-disabled cell rather than nothing"}},"description":"One beneficiary's HCC profile + demographics for a RAF computation.\n\nCMS-HCC has no model-specific member inputs beyond the shared demographic\nset - the RxHCC / ESRD-HCC / HHS-HCC eligibility fields (``esrd``,\n``dual_status``, ``rxcs``, ``csr_indicator``, …) live on those models' own\nrequest bodies, so a stray one here is a 422 from the schema itself.","additionalProperties":false},"TosProfile":{"type":"object","title":"TosProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/TosEntry"},"title":"Entries","default":[]}},"description":"The CMS Type-of-Service indicator(s) a CPT/HCPCS code carries, from the\nNATIVE codesets ``hcpcs_tos`` table (the CMS HCPCS file). A code may carry\nseveral TOS values. Empty when the code carries none."},"AhrqQiEntry":{"type":"object","title":"AhrqQiEntry","required":["qi_module","qi_id"],"properties":{"qi_id":{"type":"string","title":"Qi Id"},"qi_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qi Name"},"set_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Set Name"},"set_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Set Role"},"code_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Type"},"qi_module":{"type":"string","title":"Qi Module"}},"description":"One AHRQ Quality Indicator value-set membership for a code: the indicator\n(module + id + name), the AHRQ value-set acronym, the code's role in it\n(numerator / denominator / exclusion), and the code_type the membership came\nfrom (icd10cm diagnosis vs icd10pcs procedure)."},"AmendmentIn":{"type":"object","title":"AmendmentIn","required":["change_index","new_guidance"],"properties":{"change_index":{"type":"integer","title":"Change Index","minimum":0},"new_guidance":{"type":"string","title":"New Guidance","maxLength":20000}}},"AsaRulePair":{"type":"object","title":"AsaRulePair","required":["relation","direction","subject_code"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"match":{"type":"string","title":"Match","default":"exact"},"relation":{"type":"string","title":"Relation"},"direction":{"type":"string","title":"Direction"},"object_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Object Code"},"source_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Page"},"subject_code":{"type":"string","title":"Subject Code"},"condition_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Condition Text"},"source_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Section"},"counterpart_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterpart Code"}},"description":"One ASA Relative Value Guide code relation touching the queried code.\n\n``relation`` is a CLOSED vocabulary and is what a consumer branches on:\n\n* ``do_not_report_with``  -- a hard conflict; the two codes may not both be\n  reported for the same anesthetic.\n* ``report_instead``      -- in the stated circumstance this code is the wrong\n  one and ``counterpart_code`` is the right one.\n* ``excludes_use_instead``-- the counterpart's work is excluded from this code\n  and bills to the counterpart.\n* ``see_codes``           -- a pointer to the codes that cover a related\n  procedure. NOT a conflict.\n* ``includes``            -- the named work is already inside this code's base\n  units, so billing it as a separate line is unbundling. These rows have no\n  counterpart code; the work is named in ``condition_text``.\n\n``direction`` says whose comment this is: ``subject`` = the book states the\nrule ON the queried code, ``object`` = another code's rule points AT it.\n``match`` is ``range`` when the queried code fell inside a printed range such\nas ``01916-01933`` rather than being named outright.\n\n``condition_text`` is the circumstance the rule applies under and must be read\nbefore acting: several relations only hold for a stated clinical situation."},"CarcProfile":{"type":"object","title":"CarcProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"last_modified":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Modified"},"deactivation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deactivation Date"}},"description":"X12 Claim Adjustment Reason Code section: the national denial/adjustment\nreason on the 835 remittance, with the triannual-cycle dates. ``type`` is the\nX12 type column (empty for CARC today - carried for symmetry with RARC and so\nthe full record round-trips)."},"CcsrProfile":{"type":"object","title":"CcsrProfile","properties":{"body_system":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body System"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"all_categories":{"type":"array","items":{"type":"string"},"title":"All Categories","default":[]},"default_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Category"}},"description":"AHRQ CCSR clinical classification for an ICD-10-CM diagnosis."},"CdpsProfile":{"type":"object","title":"CdpsProfile","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CdpsCategory"},"title":"Categories","default":[]}},"description":"CDPS Medicaid risk-adjustment category(ies) for an ICD-10-CM code, from\nthe codesets ``cdps_icd`` table. The Medicaid analog to the Medicare HCC/\nRxHCC/ESRD/HHS risk models. LICENSE-GATED: CDPS is a paid UC San Diego\nlicense (descriptor_license='cdps', redistributable=False) - the shipped\ncompact is a small labeled FIXTURE, not the licensed crosswalk."},"ClfsProfile":{"type":"object","title":"ClfsProfile","properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"on_clfs":{"type":"boolean","title":"On Clfs","default":false},"status_meaning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Meaning"}},"description":"Clinical Laboratory Fee Schedule membership for a CPT/HCPCS code, from the\nNATIVE codesets ``clfs_status`` table. ``on_clfs`` is True when the code is a\nCLFS-priced clinical-lab test (vs MPFS pathology). Dollar amounts are out of\nscope (pricing lives in Hank PP Man) - this is a membership/status flag only."},"CodeProfile":{"type":"object","title":"CodeProfile","required":["code","year","code_type","is_valid"],"properties":{"atc":{"anyOf":[{"$ref":"#/components/schemas/AtcProfile"},{"type":"null"}]},"cdt":{"anyOf":[{"$ref":"#/components/schemas/CdtProfile"},{"type":"null"}]},"cpt":{"anyOf":[{"$ref":"#/components/schemas/CptProfile"},{"type":"null"}]},"hac":{"anyOf":[{"$ref":"#/components/schemas/HacProfile"},{"type":"null"}]},"hcc":{"anyOf":[{"$ref":"#/components/schemas/HccProfile"},{"type":"null"}]},"icd":{"anyOf":[{"$ref":"#/components/schemas/IcdProfile"},{"type":"null"}]},"mce":{"anyOf":[{"$ref":"#/components/schemas/MceIcdRulesProfile"},{"type":"null"}]},"mue":{"anyOf":[{"$ref":"#/components/schemas/MueProfile"},{"type":"null"}]},"ndc":{"anyOf":[{"$ref":"#/components/schemas/NdcProfile"},{"type":"null"}]},"pos":{"anyOf":[{"$ref":"#/components/schemas/PosProfile"},{"type":"null"}]},"rvu":{"anyOf":[{"$ref":"#/components/schemas/RVUProfile"},{"type":"null"}]},"tos":{"anyOf":[{"$ref":"#/components/schemas/TosProfile"},{"type":"null"}]},"carc":{"anyOf":[{"$ref":"#/components/schemas/CarcProfile"},{"type":"null"}]},"cdps":{"anyOf":[{"$ref":"#/components/schemas/CdpsProfile"},{"type":"null"}]},"clfs":{"anyOf":[{"$ref":"#/components/schemas/ClfsProfile"},{"type":"null"}]},"code":{"type":"string","title":"Code"},"eapg":{"anyOf":[{"$ref":"#/components/schemas/EapgProfile"},{"type":"null"}]},"gems":{"anyOf":[{"$ref":"#/components/schemas/GemsProfile"},{"type":"null"}]},"mips":{"anyOf":[{"$ref":"#/components/schemas/MipsProfile"},{"type":"null"}]},"ncci":{"anyOf":[{"$ref":"#/components/schemas/NCCIProfile"},{"type":"null"}]},"nlcd":{"anyOf":[{"$ref":"#/components/schemas/NlcdProfile"},{"type":"null"}]},"nucc":{"anyOf":[{"$ref":"#/components/schemas/NuccProfile"},{"type":"null"}]},"rarc":{"anyOf":[{"$ref":"#/components/schemas/RarcProfile"},{"type":"null"}]},"rbcs":{"anyOf":[{"$ref":"#/components/schemas/RBCSProfile"},{"type":"null"}]},"sopt":{"anyOf":[{"$ref":"#/components/schemas/SoptProfile"},{"type":"null"}]},"srdr":{"anyOf":[{"$ref":"#/components/schemas/SrdrProfile"},{"type":"null"}]},"year":{"type":"integer","title":"Year"},"hipps":{"anyOf":[{"$ref":"#/components/schemas/HippsProfile"},{"type":"null"}]},"icd11":{"anyOf":[{"$ref":"#/components/schemas/Icd11Profile"},{"type":"null"}]},"loinc":{"anyOf":[{"$ref":"#/components/schemas/LoincProfile"},{"type":"null"}]},"msdrg":{"anyOf":[{"$ref":"#/components/schemas/MSdrgProfile"},{"type":"null"}]},"nadac":{"anyOf":[{"$ref":"#/components/schemas/NadacProfile"},{"type":"null"}]},"rxhcc":{"anyOf":[{"$ref":"#/components/schemas/RxHccProfile"},{"type":"null"}]},"dmepos":{"anyOf":[{"$ref":"#/components/schemas/DmeposProfile"},{"type":"null"}]},"groups":{"anyOf":[{"$ref":"#/components/schemas/GroupsProfile"},{"type":"null"}]},"hhshcc":{"anyOf":[{"$ref":"#/components/schemas/HhsHccProfile"},{"type":"null"}]},"icdpcs":{"anyOf":[{"$ref":"#/components/schemas/Icd10PcsProfile"},{"type":"null"}]},"rxnorm":{"anyOf":[{"$ref":"#/components/schemas/RxnormProfile"},{"type":"null"}]},"ahrq_qi":{"anyOf":[{"$ref":"#/components/schemas/AhrqQiProfile"},{"type":"null"}]},"apr_drg":{"anyOf":[{"$ref":"#/components/schemas/AprDrgProfile"},{"type":"null"}]},"cdps_rx":{"anyOf":[{"$ref":"#/components/schemas/CdpsRxProfile"},{"type":"null"}]},"esrdhcc":{"anyOf":[{"$ref":"#/components/schemas/EsrdHccProfile"},{"type":"null"}]},"hh_pdgm":{"anyOf":[{"$ref":"#/components/schemas/HhPdgmProfile"},{"type":"null"}]},"lab_ncd":{"anyOf":[{"$ref":"#/components/schemas/LabNcdProfile"},{"type":"null"}]},"vaccine":{"anyOf":[{"$ref":"#/components/schemas/VaccineProfile"},{"type":"null"}]},"guidance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Guidance"},"is_valid":{"type":"boolean","title":"Is Valid"},"modifier":{"anyOf":[{"$ref":"#/components/schemas/ModifierProfile"},{"type":"null"}]},"asa_rules":{"anyOf":[{"$ref":"#/components/schemas/AsaRulesProfile"},{"type":"null"}]},"code_type":{"type":"string","title":"Code Type"},"icd_index":{"anyOf":[{"$ref":"#/components/schemas/IcdIndexProfile"},{"type":"null"}]},"moldx_dex":{"anyOf":[{"$ref":"#/components/schemas/MoldxDexProfile"},{"type":"null"}]},"anesthesia":{"anyOf":[{"$ref":"#/components/schemas/AnesthesiaProfile"},{"type":"null"}]},"crosswalks":{"anyOf":[{"$ref":"#/components/schemas/CrosswalksProfile"},{"type":"null"}]},"elixhauser":{"anyOf":[{"$ref":"#/components/schemas/ElixhauserProfile"},{"type":"null"}]},"ndc_rxnorm":{"anyOf":[{"$ref":"#/components/schemas/NdcRxnormProfile"},{"type":"null"}]},"preventive":{"anyOf":[{"$ref":"#/components/schemas/PreventiveProfile"},{"type":"null"}]},"prior_auth":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthProfile"},{"type":"null"}]},"telehealth":{"anyOf":[{"$ref":"#/components/schemas/TelehealthProfile"},{"type":"null"}]},"asc_payment":{"anyOf":[{"$ref":"#/components/schemas/AscPaymentProfile"},{"type":"null"}]},"asp_pricing":{"anyOf":[{"$ref":"#/components/schemas/AspPricingProfile"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"max_minutes":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Minutes"},"memberships":{"anyOf":[{"$ref":"#/components/schemas/MembershipsProfile"},{"type":"null"}]},"ncci_add_on":{"anyOf":[{"$ref":"#/components/schemas/NCCIAddOnProfile"},{"type":"null"}]},"orange_book":{"anyOf":[{"$ref":"#/components/schemas/OrangeBookProfile"},{"type":"null"}]},"purple_book":{"anyOf":[{"$ref":"#/components/schemas/PurpleBookProfile"},{"type":"null"}]},"valid_years":{"type":"array","items":{"type":"integer"},"title":"Valid Years","default":[]},"availability":{"type":"string","title":"Availability","default":"present_with_data","description":"Dataset-level three-state availability of this code TYPE on this backend: 'present_with_data' | 'present_empty' | 'not_deployed'. Distinct from is_valid (which is about this specific code) - a planned/undeployed type reports 'not_deployed' here while is_valid stays False."},"eapg_weights":{"anyOf":[{"$ref":"#/components/schemas/EapgWeightsProfile"},{"type":"null"}]},"fee_schedule":{"anyOf":[{"$ref":"#/components/schemas/FeeScheduleProfile"},{"type":"null"}]},"license_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Note","description":"Set when licensed content was withheld for the caller: an actionable reason + the grantable corpus key (request access via POST /api/licensing/request). Never echoes the redacted text."},"medicaid_eob":{"anyOf":[{"$ref":"#/components/schemas/MedicaidEobProfile"},{"type":"null"}]},"ncpdp_reject":{"anyOf":[{"$ref":"#/components/schemas/NcpdpRejectProfile"},{"type":"null"}]},"opps_payment":{"anyOf":[{"$ref":"#/components/schemas/OppsPaymentProfile"},{"type":"null"}]},"cdt_editorial":{"anyOf":[{"$ref":"#/components/schemas/CdtEditorialProfile"},{"type":"null"}]},"co_occurrence":{"anyOf":[{"$ref":"#/components/schemas/CoOccurrenceProfile"},{"type":"null"}]},"icd10cm_notes":{"anyOf":[{"$ref":"#/components/schemas/Icd10cmNotesProfile"},{"type":"null"}]},"relationships":{"anyOf":[{"$ref":"#/components/schemas/RelationshipsProfile"},{"type":"null"}]},"data_freshness":{"anyOf":[{"$ref":"#/components/schemas/DataFreshnessProfile"},{"type":"null"}]},"icd10cm_snomed":{"anyOf":[{"$ref":"#/components/schemas/Icd10cmSnomedProfile"},{"type":"null"}]},"apr_drg_weights":{"anyOf":[{"$ref":"#/components/schemas/AprDrgWeightsProfile"},{"type":"null"}]},"ipf_comorbidity":{"anyOf":[{"$ref":"#/components/schemas/IpfComorbidityProfile"},{"type":"null"}]},"irf_comorbidity":{"anyOf":[{"$ref":"#/components/schemas/IrfComorbidityProfile"},{"type":"null"}]},"moldx_dex_tests":{"anyOf":[{"$ref":"#/components/schemas/MoldxDexTestsProfile"},{"type":"null"}]},"cpt_icd_guidance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpt Icd Guidance"},"esrd_comorbidity":{"anyOf":[{"$ref":"#/components/schemas/EsrdComorbidityProfile"},{"type":"null"}]},"hedis_value_sets":{"anyOf":[{"$ref":"#/components/schemas/HedisValueSetsProfile"},{"type":"null"}]},"procedure_concept":{"anyOf":[{"$ref":"#/components/schemas/ProcedureConceptProfile"},{"type":"null"}]},"effective_date_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date End"},"medicare_specialty":{"anyOf":[{"$ref":"#/components/schemas/MedicareSpecialtyProfile"},{"type":"null"}]},"sections_available":{"type":"array","items":{"type":"string"},"title":"Sections Available","default":[],"description":"Optional enrichment sections that APPLY to this code type but were NOT loaded at the requested detail - the in-band 'more is available' hint (re-request with include=<name> or detail=full). Entitlement-filtered: never advertises a license-restricted section the caller could not receive. Empty when everything applicable was loaded."},"snomed_icd10cm_map":{"anyOf":[{"$ref":"#/components/schemas/SnomedIcd10cmMapProfile"},{"type":"null"}]},"availability_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Availability Detail","description":"Human-readable reason for a non-'present_with_data' availability (e.g. \"code type 'rxnorm' is not deployed on this backend\"). None when the type is deployed with data."},"effective_date_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date Start"},"section_availability":{"type":"object","title":"Section Availability","description":"Per-section three-state availability for the sections this profile loaded (+ any applicable-but-undeployed section): section key -> 'present_with_data' | 'present_empty' | 'not_deployed'. Distinguishes 'backend has no table' from 'no data for this code'. Empty on detail=summary.","additionalProperties":{"type":"string"}},"ioce_proc_demographics":{"anyOf":[{"$ref":"#/components/schemas/IoceProcDemographicsProfile"},{"type":"null"}]}},"description":"Unified enriched profile for any code - polymorphic by code_type.\n\nReturned by CODES.get_code_profile(). The populated sections depend on\ncode_type: CPT/HCPCS get rvu/groups/anesthesia/crosswalks; ICD-10-CM gets\nthe `icd` block (billable/CCSR/HCC); modifiers get description + validity.\nShared fields (code/year/code_type/is_valid/description) are always present.\n\nFrozen: instances are immutable to prevent LRU cache corruption.\nCallers who need to modify data should use model_dump() first."},"DmeposEntry":{"type":"object","title":"DmeposEntry","properties":{"qtr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qtr"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"modifier2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier2"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction"}},"description":"One CMS DMEPOS fee-schedule INDICATOR row for a HCPCS - the code-\naddressable columns only (pricing is out of scope, Hank PP Man owns it).\n``modifier``/``modifier2`` are None when the row carries no modifier."},"EapgProfile":{"type":"object","title":"EapgProfile","required":["eapg"],"properties":{"eapg":{"type":"string","title":"Eapg"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"description":"EAPG (Solventum) group block: the 4-digit group number, its title, and the\ngrouper version. The outpatient sibling of APR-DRG. LICENSE-GATED."},"GemsProfile":{"type":"object","title":"GemsProfile","properties":{"forward":{"type":"array","items":{"$ref":"#/components/schemas/GemMapping"},"title":"Forward","default":[]},"reverse":{"type":"array","items":{"$ref":"#/components/schemas/GemMapping"},"title":"Reverse","default":[]}},"description":"ICD-9 <-> ICD-10 General Equivalence Mappings for a code (ICD-10-CM or\nICD-10-PCS): the ``forward`` crosswalk to the other version and the\n``reverse`` (codes in the other version that map TO this one). Public-domain\nCMS data, frozen at the final FY2018 release. From the NATIVE codesets\n``gems`` table."},"GroupDetail":{"type":"object","title":"GroupDetail","required":["name"],"properties":{"name":{"type":"string","title":"Name"},"subset_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subset Of"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"icd_guidance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd Guidance"},"friendly_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Friendly Name"}},"description":"One CPTGrouper group with its human-facing name + description, so a UI\ncan show \"ANESTHESIA → Anesthesia → Anesthesia CPT Codes for Type of\nService\" instead of a bare, cryptic group slug."},"HippsDecode":{"type":"object","title":"HippsDecode","required":["code","payment_system","structure","structure_label","revenue_code"],"properties":{"axes":{"type":"array","items":{"$ref":"#/components/schemas/HippsAxis"},"title":"Axes","default":[]},"code":{"type":"string","title":"Code"},"notes":{"type":"array","items":{"type":"string"},"title":"Notes","default":[]},"structure":{"type":"string","title":"Structure"},"revenue_code":{"type":"string","title":"Revenue Code"},"fully_decoded":{"type":"boolean","title":"Fully Decoded","default":true},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"payment_system":{"type":"string","title":"Payment System"},"is_default_code":{"type":"boolean","title":"Is Default Code","default":false},"structure_label":{"type":"string","title":"Structure Label"}},"description":"The positional decode of a HIPPS rate code.\n\n``structure`` names the coding structure in force for this code's vintage --\nthe same 5 characters mean different things in different eras, so the decode\nis always relative to a structure. ``revenue_code`` is the ONLY revenue code\nthe HIPPS code is valid alongside on a claim line, which makes it a hard\nvalidation rule rather than trivia. ``fully_decoded`` is False when any\nemitted axis could not be resolved; ``notes`` then explains."},"Icd10cmNote":{"type":"object","title":"Icd10cmNote","required":["icd_prefix","note_type"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"note_type":{"type":"string","title":"Note Type"},"icd_prefix":{"type":"string","title":"Icd Prefix"},"target_expr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Expr"},"target_prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Prefix"}},"description":"One ICD-10-CM tabular instructional note attached at/above this code:\nthe note's type, the raw target expression from the tabular, and the\nresolved target prefix (None when the prose target didn't resolve)."},"LabNcdEntry":{"type":"object","title":"LabNcdEntry","required":["ncd"],"properties":{"ncd":{"type":"string","title":"Ncd"},"denied":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Denied"},"covered":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Covered"},"icd_eff":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd Eff"},"icd_term":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd Term"},"resolution":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Resolution"},"non_supporting":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Non Supporting"},"ncd_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ncd Description"},"resolution_meaning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolution Meaning"}},"description":"One Medicare national Lab-NCD (190.x) reference for a code.\n\nOn an ICD profile this carries the diagnosis's three-state ``resolution``\nin the NCD (1 covered / 2 denied / 3 does-not-support-medical-necessity).\nOn a lab CPT/HCPCS profile it instead carries the NCD's ICD bucket sizes\n(``covered``/``denied``/``non_supporting``) - i.e. how many diagnoses fall\nin each resolution bucket for the lab code this NCD governs."},"MipsProfile":{"type":"object","title":"MipsProfile","required":["code","code_kind"],"properties":{"code":{"type":"string","title":"Code"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/MipsEntry"},"title":"Entries","default":[]},"code_kind":{"type":"string","title":"Code Kind"},"total_measures":{"type":"integer","title":"Total Measures","default":0}},"description":"The CMS MIPS Quality measures a code participates in, from the NATIVE\ncodesets ``mips_measures`` + ``mips_measure_codes`` tables (the QPP\nmeasures-data.json, CC0). ``code_kind`` is 'icd' (a diagnosis) or 'procedure'\n(a CPT/HCPCS). Claims-reportable Quality measures only (PI/IA/Cost carry no\ncode arrays)."},"NCCIProfile":{"type":"object","title":"NCCIProfile","properties":{"edits":{"type":"array","items":{"$ref":"#/components/schemas/NCCIEdit"},"title":"Edits","default":[]},"truncated":{"type":"boolean","title":"Truncated","default":false},"total_active":{"type":"integer","title":"Total Active","default":0}},"description":"Active NCCI PTP edits for a code, capped to a sane N.\n\nField semantics:\n  edits         - up to _NCCI_CAP NCCIEdit rows, ordered as the SQL returned them.\n  total_active  - when `truncated=False`, the exact count. When `truncated=True`,\n                  this is `len(edits) + 1` (the cap + the sentinel row that\n                  told us \"more exist\") - interpret as \"at least this many.\"\n                  For the exact unbounded count, use a future\n                  /api/cpt/{code}/ncci endpoint (Phase 2).\n  truncated     - True iff there are more active edits than `_NCCI_CAP`."},"NlcdProfile":{"type":"object","title":"NlcdProfile","properties":{"macs":{"type":"array","items":{"$ref":"#/components/schemas/NlcdMAC"},"title":"Macs","default":[]},"mac_count":{"type":"integer","title":"Mac Count","default":0},"truncated":{"type":"boolean","title":"Truncated","default":false},"article_count":{"type":"integer","title":"Article Count","default":0}},"description":"Distinct MAC x article entries covering a code (active dates only)."},"NuccProfile":{"type":"object","title":"NuccProfile","properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section"},"grouping":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grouping"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification"},"specialization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specialization"}},"description":"NUCC provider-taxonomy section: the Grouping -> Classification ->\nSpecialization hierarchy + the canonical definition."},"OPPSProfile":{"type":"object","title":"OPPSProfile","properties":{"mp_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mp Amount"},"nonfac_pe_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Nonfac Pe Amount"},"facility_pe_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Facility Pe Amount"}},"description":"OPPS (hospital Outpatient Prospective Payment System) PE/MP amounts used\nwhen this code is paid under the HOPD/ASC fee schedule rather than the MPFS -\na distinct payment path from the office/physician setting."},"PdpmProfile":{"type":"object","title":"PdpmProfile","properties":{"major_procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Major Procedure"},"clinical_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clinical Category"},"nta_comorbidities":{"type":"array","items":{"type":"string"},"title":"Nta Comorbidities","default":[]},"slp_comorbidities":{"type":"array","items":{"type":"string"},"title":"Slp Comorbidities","default":[]},"is_return_to_provider":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Return To Provider"}},"description":"PDPM (SNF) classification for an ICD-10-CM diagnosis.\n\n``clinical_category`` is the PDPM clinical category the diagnosis maps to\n(drives the SNF PT/OT/SLP case-mix when it's the primary dx);\n``is_return_to_provider`` flags a code that cannot be the primary SNF\ndiagnosis. ``nta_comorbidities`` / ``slp_comorbidities`` are the Non-Therapy\nAncillary (points-based) and Speech-Language Pathology comorbidity groups\nthis diagnosis belongs to."},"RBCSProfile":{"type":"object","title":"RBCSProfile","properties":{"family":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"},"major_ind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Major Ind"},"family_desc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family Desc"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory"},"category_desc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Desc"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"ever_reassigned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ever Reassigned"},"subcategory_desc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory Desc"},"analysis_end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analysis End Date"},"assignment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Method"},"analysis_start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analysis Start Date"},"is_latest_assignment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Latest Assignment"},"first_rbcs_release_year":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Rbcs Release Year"}},"description":"RBCS (BETOS 2.0) classification for a HCPCS/CPT code, plus the CMS\nassignment audit trail (effective window, methodology, reassignment history)\nfor compliance/scholarly review."},"RarcProfile":{"type":"object","title":"RarcProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"last_modified":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Modified"},"deactivation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deactivation Date"}},"description":"X12 Remittance Advice Remark Code section: the M/N-series remark that\nsupplements a CARC adjustment. ``type`` is supplemental or informational."},"RelatedCode":{"type":"object","title":"RelatedCode","required":["relationship_type","system","code"],"properties":{"code":{"type":"string","title":"Code"},"rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rank"},"rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate"},"system":{"type":"string","title":"System"},"specialty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specialty"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"support_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Support Tier"},"place_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Place Of Service"},"relationship_type":{"type":"string","title":"Relationship Type"}},"description":"One ranked related code (an edge in the code_relationships table).\n\n``rate`` is the directional conditional frequency P(this code | the anchor)\nwithin scope; ``rank`` is its position among the anchor's related codes;\n``support_tier`` is a coarse confidence band (raw counts are never served).\n``specialty`` / ``place_of_service`` are optional SEGMENT labels - which\nclinical segment the edge was computed within (e.g. an anesthesia-only or\noffice-radiology slice). They are NOT data provenance: the corpus `source`\ncolumn stays DB-internal and is never serialized."},"SoptProfile":{"type":"object","title":"SoptProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"description":"SOPT (Source of Payment Typology) section: the payer-type code, its\ndescription, and its ``parent`` typology code (the nesting prefix)."},"SrdrProfile":{"type":"object","title":"SrdrProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"last_modified":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Modified"},"deactivation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deactivation Date"}},"description":"X12 ECL 886 Service Review Decision Reason Code section: the prior-auth /\nutilization-management review-outcome reason carried in the 278 HCR segment,\nwith the triannual-cycle dates."},"AprDrgWeight":{"type":"object","title":"AprDrgWeight","properties":{"soi":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Soi"},"alos":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Alos"},"payer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payer"},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight"},"apr_drg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apr Drg"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"extra_field_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra Field 1"},"extra_field_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra Field 2"},"source_format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Format"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"grouper_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grouper Version"},"service_line_adult":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Line Adult"},"service_line_pediatric":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Line Pediatric"}},"description":"One payer-published APR-DRG weight row, keyed by Severity of Illness.\n\n``extra_field_1`` / ``extra_field_2`` are the two trailing 6-digit fields in\nthe Solventum-importable fixed-width weight file. No published field layout\ndescribes them, so they are carried VERBATIM rather than named or scaled."},"CdpsCategory":{"type":"object","title":"CdpsCategory","required":["category"],"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"category":{"type":"string","title":"Category"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"severity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity Level"}},"description":"One CDPS (Chronic Illness & Disability Payment System) clinical category\nan ICD-10-CM code maps to, with its severity level + model version."},"CodeIdentity":{"type":"object","title":"CodeIdentity","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"links":{"type":"object","title":"Links","additionalProperties":{"type":"string"}},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"profiles":{"anyOf":[{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CodeProfile"}},{"type":"null"}],"title":"Profiles"},"primary_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Type"},"matched_types":{"type":"array","items":{"type":"string"},"title":"Matched Types","default":[]}},"description":"Fixed-schema discovery index for the bare ``GET /codes/{code}``.\n\nNOT a profile - a router. It answers \"what is this string?\" by reporting\nevery code/scope type the literal value is actually a member of, plus\nready-to-use links to the typed resources. The schema is invariant (a\nconsumer always gets exactly this shape), which is the whole point: profiles\nare deterministic because the caller names the type; discovery is\ndeterministic because it never tries to be a profile.\n\n``matched_types`` are lowercase slugs (cpt|hcpcs|icd|modifier|hcc). ``links``\nmaps each matched type to its canonical resource path. ``profiles`` is filled\nonly when the caller asks ``?expand=all`` (one ``CodeProfile`` per match)."},"HippsProfile":{"type":"object","title":"HippsProfile","properties":{"decode":{"anyOf":[{"$ref":"#/components/schemas/HippsDecode"},{"type":"null"}]},"hipaa_valid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hipaa Valid"},"revenue_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revenue Code"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"other_vintages":{"type":"array","items":{"type":"string"},"title":"Other Vintages","default":[]},"payment_system":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment System"},"medicare_payable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Medicare Payable"},"effective_through":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Through"},"payment_system_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment System Label"},"medicare_payment_through":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Medicare Payment Through"}},"description":"HIPPS-specific section (None unless ``code_type == 'hipps'``).\n\nCarries the code's master-list facts plus its positional ``decode``.\n\nTWO end dates ride every row and they mean DIFFERENT things:\n``effective_through`` is the last date the code is valid under HIPAA on a\ntransaction; ``medicare_payment_through`` is the last date Medicare pays it,\nafter which OTHER payers may still use it. ``hipaa_valid`` and\n``medicare_payable`` answer both for the requested date of service and are\nNone when no date of service was supplied -- the question is not answerable\nwithout one."},"Icd11Profile":{"type":"object","title":"Icd11Profile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"is_leaf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Leaf"},"release":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Release"},"block_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Block Id"},"groupings":{"type":"array","items":{"type":"string"},"title":"Groupings","default":[]},"chapter_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chapter No"},"class_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class Kind"},"parent_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Uri"},"browser_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Browser Url"},"coding_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coding Note"},"is_residual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Residual"},"license_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Note"},"chapter_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chapter Title"},"depth_in_kind":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Depth In Kind"},"foundation_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foundation Uri"},"icd10_equivalents":{"type":"array","items":{"$ref":"#/components/schemas/Icd11MapEntry"},"title":"Icd10 Equivalents","default":[]},"linearization_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linearization Uri"},"primary_tabulation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Primary Tabulation"}},"description":"WHO ICD-11 MMS section (None unless ``code_type == 'icd11'``).\n\n``class_kind`` is ``category`` for a coded entity; ``chapter`` and ``block``\nare the groupings above it (a block bears no code). ``is_residual`` marks an\n\"other specified\" / \"unspecified\" category. ``groupings`` lists the WHO block\nids the entity sits under, outermost first - pass one to\n``/api/scopes/icd11/{block}/codes`` to expand it.\n\n``foundation_uri`` and ``linearization_uri`` are MANDATORY under the WHO\nlicense (clause 1.2.3: code, title and URI must travel together), and\n``license_note`` carries WHO's required citation. Do not strip them.\n\n``icd10_equivalents`` is WHO's own ICD-11 -> ICD-10 mapping for this code.\nThe ICD-10 side is WHO ICD-10, NOT the US ICD-10-CM."},"IcdIndexDrug":{"type":"object","title":"IcdIndexDrug","properties":{"icd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd"},"intent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intent"},"substance_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Substance Text"}},"description":"One ICD-10-CM Table-of-Drugs-&-Chemicals membership for a code: the\nsubstance and the intent column (poisoning_accidental | poisoning_intentional\n| poisoning_assault | poisoning_undetermined | adverse_effect | underdosing)\nwhose cell holds this T-code."},"LoincProfile":{"type":"object","title":"LoincProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"standard":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard"},"loinc_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Loinc Class"}},"description":"LOINC (Regenstrief) lab/observation section: the LOINC code, its name, the\nLOINC class, and standard-concept flag. GATED (Regenstrief license)."},"MSdrgProfile":{"type":"object","title":"MSdrgProfile","properties":{"mdc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mdc"},"drg_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drg Type"},"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity"},"mdc_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mdc Label"},"is_pre_mdc":{"type":"boolean","title":"Is Pre Mdc","default":false},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"},"drg_type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drg Type Label"},"severity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity Label"},"relative_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Relative Weight"},"mean_los_geometric":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mean Los Geometric"},"mean_los_arithmetic":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mean Los Arithmetic"}},"description":"MS-DRG-specific section: the inpatient payment classification facts.\n\nAn MS-DRG (Medicare-Severity Diagnosis Related Group) is the payment bucket\nan inpatient stay groups to. ``relative_weight`` drives reimbursement (× the\nhospital base rate); the two mean length-of-stay figures (arithmetic and\ngeometric) come straight off the CMS IPPS Final Rule Table 5. ``severity``\nis parsed from the title's WITH/WITHOUT MCC/CC suffix; ``mdc`` is the Major\nDiagnostic Category the DRG belongs to (``PRE`` for pre-MDC groups like\ntransplants). ``model_year`` is the fiscal year this row's data is for."},"NadacProfile":{"type":"object","title":"NadacProfile","properties":{"ndc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ndc"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/NadacEntry"},"title":"Entries","default":[]}},"description":"NADAC drug-acquisition-cost section (on ndc): the National Average Drug\nAcquisition Cost the Medicaid weekly survey reports for this NDC, newest year\nfirst. Empty when the survey does not price this NDC / not deployed."},"RxHccProfile":{"type":"object","title":"RxHccProfile","required":["rxhcc"],"properties":{"rxhcc":{"type":"integer","title":"Rxhcc"},"trumps":{"type":"array","items":{"type":"integer"},"title":"Trumps","default":[]},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"},"risk_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Score"},"trumped_by":{"type":"array","items":{"type":"integer"},"title":"Trumped By","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"member_icds":{"type":"array","items":{"type":"string"},"title":"Member Icds","default":[]},"model_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version"},"score_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Score Segment"},"member_icd_count":{"type":"integer","title":"Member Icd Count","default":0},"members_truncated":{"type":"boolean","title":"Members Truncated","default":false},"scores_by_segment":{"type":"object","title":"Scores By Segment","default":{},"additionalProperties":{"type":"number"}}},"description":"Forward profile for an RxHCC *category* (the Part-D risk-adjustment bucket).\n\nThe Rx analog of HccProfile: ``risk_score`` is the Rx_CE_NoLowAged reference\ncoefficient (Community, Non-Low-Income, Aged, Continuing Enrollee - the RxHCC\nanalog of CMS-HCC's CNA). ``member_icds`` is a capped sample."},"VaccineEntry":{"type":"object","title":"VaccineEntry","properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"cvx_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvx Code"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer"},"vaccine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vaccine Name"},"short_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Description"}},"description":"One CDC CVX vaccine a CPT/HCPCS code maps to: the CVX code, vaccine name +\nshort description, and VaccineStatus (verbatim). ``manufacturer`` is None\nhere - the CDC CVX/MVX/CPT files carry no per-CVX manufacturer link (query\nthe MVX set directly for that)."},"AhrqQiProfile":{"type":"object","title":"AhrqQiProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/AhrqQiEntry"},"title":"Entries","default":[]}},"description":"The AHRQ Quality Indicators (PQI/PSI/IQI/PDI) a code belongs to, from the\nNATIVE codesets ``ahrq_qi`` table - the standard public-domain inpatient\nquality measures. One entry per (indicator, value-set, role); a code can\ndrive several indicators and roles. Empty when the code is in no QI set."},"AprDrgProfile":{"type":"object","title":"AprDrgProfile","required":["drg"],"properties":{"drg":{"type":"string","title":"Drg"},"mdc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mdc"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"drg_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drg Type"},"long_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Long Description"}},"description":"APR-DRG (Solventum) base-DRG block: the DRG number, its title, the Major\nDiagnostic Category (published EMPTY in v43.0 - never inferred), the medical\nor surgical type, and the grouper version. LICENSE-GATED (Solventum)."},"CdpsRxProfile":{"type":"object","title":"CdpsRxProfile","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CdpsRxCategory"},"title":"Categories","default":[]}},"description":"CDPS/MRx pharmacy risk category(ies) for an NDC, from the codesets\n``cdps_ndc`` table - the PHARMACY leg of the authoritative CDPS 7.3 package\n(the shipped ``cdps_icd`` fixture is diagnosis-only and approximate).\nLICENSE-GATED (paid UC San Diego license); empty until the licensed pharmacy\nfile is dropped in."},"DmeposProfile":{"type":"object","title":"DmeposProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/DmeposEntry"},"title":"Entries","default":[]}},"description":"CMS DMEPOS fee-schedule INDICATORS for a HCPCS/CPT code, from the NATIVE\ncodesets ``dmepos_indicators`` table (the quarterly CMS DMEPOS file). NOT\npricing - dollar amounts are out of scope (Hank PP Man). LIST-valued: one\nentry per (modifier, modifier2, jurisdiction, category) row. DOS-aware via\neach entry's ``qtr``. Empty when the code is not on the DMEPOS schedule."},"ExpandRequest":{"type":"object","title":"ExpandRequest","required":["source","identifier"],"properties":{"source":{"enum":["rbcs","cptgrouper"],"type":"string","title":"Source"},"identifier":{"type":"string","title":"Identifier"}}},"GroupsProfile":{"type":"object","title":"GroupsProfile","properties":{"cpt_group_names":{"type":"array","items":{"type":"string"},"title":"Cpt Group Names","default":[]},"cpt_groups_detail":{"type":"array","items":{"$ref":"#/components/schemas/GroupDetail"},"title":"Cpt Groups Detail","default":[]},"cpt_group_category":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cpt Group Category"}},"description":"CPTGrouper group memberships for a code.\n\nNote: cpt_group_names is a tuple (not list) because frozen=True prevents\nreassignment but NOT in-place mutation of contained lists. A tuple is\ngenuinely immutable - protects cached profile integrity (M-NEW-6)."},"HhPdgmProfile":{"type":"object","title":"HhPdgmProfile","properties":{"code_first":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Code First"},"subchapter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subchapter"},"interactions":{"type":"array","items":{"$ref":"#/components/schemas/HhPdgmInteraction"},"title":"Interactions","default":[]},"manifestation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Manifestation"},"clinical_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clinical Group"},"low_comorbidity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Low Comorbidity"},"comorbidity_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comorbidity Group"},"grouper_version_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grouper Version To"},"clinical_group_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clinical Group Label"},"functional_low_point":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Functional Low Point"},"grouper_version_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grouper Version From"},"functional_high_point":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Functional High Point"},"comorbidity_group_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comorbidity Group Label"},"acceptable_principal_diagnosis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Acceptable Principal Diagnosis"},"unspecified_principal_diagnosis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unspecified Principal Diagnosis"},"unacceptable_principal_diagnosis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unacceptable Principal Diagnosis"}},"description":"Home Health PDGM classification for an ICD-10-CM code.\n\n``clinical_group`` is the group this diagnosis assigns when reported as the\nPRINCIPAL diagnosis. A value of ``NA`` (``clinical_group_label`` \"No Group\nAssigned\") means the diagnosis CANNOT be a principal home-health diagnosis --\nthat is an answer, not a missing value.\n\n``comorbidity_group`` is the subgroup the diagnosis falls into as a\nSECONDARY diagnosis. ``low_comorbidity`` marks a subgroup that earns the LOW\nadjustment on its own; ``interactions`` lists the pairings that earn the\nHIGH adjustment.\n\nAnswers are version-ranged: ``grouper_version_from`` / ``_to`` are the date\nwindow of the grouper version that produced them (``_to`` None means the\nwindow is still open)."},"HhsHccProfile":{"type":"object","title":"HhsHccProfile","required":["hhshcc"],"properties":{"hhshcc":{"type":"string","title":"Hhshcc"},"trumps":{"type":"array","items":{"type":"string"},"title":"Trumps","default":[]},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"},"risk_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Score"},"trumped_by":{"type":"array","items":{"type":"string"},"title":"Trumped By","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"member_icds":{"type":"array","items":{"type":"string"},"title":"Member Icds","default":[]},"model_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version"},"score_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Score Segment"},"member_icd_count":{"type":"integer","title":"Member Icd Count","default":0},"members_truncated":{"type":"boolean","title":"Members Truncated","default":false},"scores_by_segment":{"type":"object","title":"Scores By Segment","default":{},"additionalProperties":{"type":"number"}}},"description":"Forward profile for an HHS-HCC *category* (commercial/ACA risk adjustment).\n\nLike HccProfile/RxHccProfile, but the category id is ALPHANUMERIC (e.g.\n``35_1``). ``risk_score`` is the Adult-model silver-level coefficient."},"HhsRafRequest":{"type":"object","title":"HhsRafRequest","required":["age","sex"],"properties":{"age":{"type":"integer","title":"Age","maximum":130,"minimum":0},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"sex":{"type":"string","title":"Sex","description":"'M' or 'F'"},"hccs":{"type":"array","items":{"type":"string"},"title":"Hccs","maxItems":500,"description":"HHS-HCC category ids present (e.g. '35_1')"},"icds":{"type":"array","items":{"type":"string"},"title":"Icds","maxItems":500,"description":"ICD-10-CM codes (resolved to HHS-HCC categories)"},"ndcs":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":500},{"type":"null"}],"title":"Ndcs","description":"NDC drug codes, resolved to RXCs via the CMS Table-10a crosswalk"},"rxcs":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":500},{"type":"null"}],"title":"Rxcs","description":"RXC prescription-drug categories (e.g. 'RXC_01' or '1')"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"hcpcs":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":500},{"type":"null"}],"title":"Hcpcs","description":"HCPCS drug codes, resolved to RXCs via the CMS Table-10b crosswalk"},"segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Segment","description":"{Adult|Child|Infant}_{metal} segment; default Adult_Silver"},"disabled":{"type":"boolean","title":"Disabled","default":false,"description":"Accepted for surface parity; the HHS models have no such variable"},"medicaid":{"type":"boolean","title":"Medicaid","default":false,"description":"REJECTED with a 422: the commercial/ACA model has NO medicaid axis (it scores on age-sex, diagnosis categories, RXCs, enrollment duration and the metal level), so accepting it would be a silent no-op"},"csr_indicator":{"anyOf":[{"type":"integer","maximum":11,"minimum":1},{"type":"null"}],"title":"Csr Indicator","description":"Person-level cost-sharing-reduction indicator 1-11 (NEVER a HIOS variant id). Produces csr_factor + csr_adjusted_raf; raf itself stays the additive sum"},"orig_disabled":{"type":"boolean","title":"Orig Disabled","default":false,"description":"Accepted for surface parity; the HHS models have no such variable"},"enrollment_months":{"anyOf":[{"type":"integer","maximum":12,"minimum":1},{"type":"null"}],"title":"Enrollment Months","description":"The CMS ENROLDURATION BAND 1-12, NOT a month count. CMS bands DAYS: 1 = 1-31 days, 2 = 32-62, 3 = 63-93, 4 = 94-124, 5 = 125-155, 6 = 156-186, ... 12 = 336-366 - so a member enrolled 200 days is band 7, NOT band 6 (200/30 rounds to '6 months' and would wrongly buy an HCC_ED6 factor). Bands 1-6 carry an HCC_ED factor; a near-full-year member (7-12) carries none by design"}},"description":"One beneficiary's profile for an HHS-HCC (commercial/ACA) RAF. HHS-HCC\ncategory ids are STRINGS (``35_1``), so ``hccs`` is a string list (unlike the\ninteger-keyed CMS-HCC/RxHCC/ESRD companions).","additionalProperties":false},"Icd11MapEntry":{"type":"object","title":"Icd11MapEntry","required":["direction","map_relation"],"properties":{"release":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Release"},"direction":{"type":"string","title":"Direction"},"icd10_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd10 Code"},"icd11_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd11 Code"},"icd10_depth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Icd10 Depth"},"icd10_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd10 Title"},"icd11_depth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Icd11 Depth"},"icd11_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd11 Title"},"map_relation":{"type":"string","title":"Map Relation"},"icd10_chapter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd10 Chapter"},"icd11_chapter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd11 Chapter"},"foundation_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foundation Uri"},"icd10_class_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd10 Class Kind"},"icd11_class_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd11 Class Kind"},"linearization_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linearization Uri"}},"description":"One row of WHO's published ICD-10 <-> ICD-11 mapping tables.\n\n``direction`` names the source side (``10to11`` / ``11to10``).\n``map_relation`` names WHICH WHO table the row came from: ``one_category``\n(WHO's single best target) or ``multiple_categories`` (WHO's one-to-many\nvariant). The relation is data, not a quality score - a consumer that wants\nthe single best target reads only ``one_category``.\n\nClass kind and depth are stated per side where WHO states them; WHO's\n``11To10MapToOneCategory`` table carries neither, so those stay None for\nthat direction. ``foundation_uri`` / ``linearization_uri`` are the ICD-11\nURIs the WHO license requires to travel with the code and title.\n\nNOTE the ICD-10 side is **WHO ICD-10**, not the US ICD-10-CM."},"IcdHccMapping":{"type":"object","title":"IcdHccMapping","required":["hcc"],"properties":{"hcc":{"type":"integer","title":"Hcc"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score"},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"}},"description":"One HCC (risk-adjustment category) an ICD-10-CM code maps to, with score."},"LabNcdProfile":{"type":"object","title":"LabNcdProfile","required":["code","code_kind"],"properties":{"code":{"type":"string","title":"Code"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/LabNcdEntry"},"title":"Entries","default":[]},"code_kind":{"type":"string","title":"Code Kind"},"total_ncds":{"type":"integer","title":"Total Ncds","default":0}},"description":"Medicare national Lab-NCD (190.x) coverage edits for a code, from the\nNATIVE codesets ``lab_ncd_icd10`` + ``lab_ncd_cpt`` tables (the CMS quarterly\n\"Lab Code List - ICD-10\"). Answers the lab adjudication question - will THIS\ndiagnosis/lab-procedure be paid - distinct from the narrative NCD/LCD\ncoverage layer (``nlcd``). ``code_kind`` is ``'icd'`` (entries carry the\ndiagnosis resolution) or ``'lab_cpt'`` (entries carry the NCD bucket sizes)."},"MoldxDexEntry":{"type":"object","title":"MoldxDexEntry","required":["z_code"],"properties":{"z_code":{"type":"string","title":"Z Code"},"retired":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retired"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"lab_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lab Name"},"specimen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specimen"},"ta_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ta Result"},"test_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Name"},"fda_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fda Status"},"lab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lab Test Id"},"moldx_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Moldx Price"},"moldx_coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Moldx Coverage"},"recommended_cpt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recommended Cpt"},"turnaround_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turnaround Time"},"test_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Description"},"fda_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fda Document Number"},"patient_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Patient Instructions"},"handling_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handling Instructions"}},"description":"One registered DEX molecular-diagnostic test record."},"NCCIAddOnEdit":{"type":"object","title":"NCCIAddOnEdit","required":["add_on_code"],"properties":{"edit_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Edit Type"},"add_on_code":{"type":"string","title":"Add On Code"},"primary_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Code"},"deletion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletion Date"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"special_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Special Instructions"}},"description":"One NCCI Add-On Code (AOC) edit row: this add-on code paired with one\nacceptable primary procedure code (``primary_code`` is None on Type 2\nAOCs - CMS defines no primary list; contractors use their own)."},"OppsLineInput":{"type":"object","title":"OppsLineInput","required":["hcpcs"],"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Line date of service (YYYY-MM-DD); drives per-DOS conditional packaging (Q1/Q2). Defaults to the claim-level dos when omitted."},"hcpcs":{"type":"string","title":"Hcpcs","description":"HCPCS/CPT code billed on the line"},"units":{"type":"integer","title":"Units","default":1,"minimum":1,"description":"Units (captured; not applied to the Phase-1 estimate)"}},"description":"One outpatient claim line."},"RxnormProfile":{"type":"object","title":"RxnormProfile","required":["code"],"properties":{"tty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tty"},"code":{"type":"string","title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"standard":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard"}},"description":"RxNorm (NLM) concept section: the RXCUI, its name, term type (tty), and\nstandard-concept flag. From the OHDSI/Athena RxNorm vocabulary (public)."},"CdpsRxCategory":{"type":"object","title":"CdpsRxCategory","required":["category"],"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"category":{"type":"string","title":"Category"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"description":"One CDPS/MRx pharmacy risk category an NDC maps to. ``model`` names which\nUCSD model produced it (``mrx`` pharmacy-only, ``cdps_rx`` combined)."},"EsrdHccProfile":{"type":"object","title":"EsrdHccProfile","required":["esrdhcc"],"properties":{"trumps":{"type":"array","items":{"type":"integer"},"title":"Trumps","default":[]},"esrdhcc":{"type":"integer","title":"Esrdhcc"},"model_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Model Year"},"risk_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Score"},"trumped_by":{"type":"array","items":{"type":"integer"},"title":"Trumped By","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"member_icds":{"type":"array","items":{"type":"string"},"title":"Member Icds","default":[]},"model_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version"},"score_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Score Segment"},"member_icd_count":{"type":"integer","title":"Member Icd Count","default":0},"members_truncated":{"type":"boolean","title":"Members Truncated","default":false},"scores_by_segment":{"type":"object","title":"Scores By Segment","default":{},"additionalProperties":{"type":"number"}}},"description":"Forward profile for an ESRD-HCC *category* (the dialysis/transplant\nrisk-adjustment bucket).\n\nThe ESRD analog of HccProfile/RxHccProfile: ``risk_score`` is the Dialysis\nContinuing Enrollee (DI_HCC*) coefficient - the ESRD reference segment, the\nanalog of CMS-HCC's CNA / RxHCC's Rx_CE_NoLowAged. ``member_icds`` is a capped\nsample. The category id is an INTEGER (like CMS-HCC/RxHCC, unlike HHS-HCC)."},"Icd11MapSystem":{"enum":["icd10","icd11"],"type":"string","title":"Icd11MapSystem","description":"The two sides of WHO's ICD-10 <-> ICD-11 mapping (the code's OWN system).\nRestricts the /api/icd11-map path param so an unknown system 422s\ndeterministically. NOTE 'icd10' is WHO ICD-10, NOT the US ICD-10-CM."},"PriorAuthEntry":{"type":"object","title":"PriorAuthEntry","required":["program"],"properties":{"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"program":{"type":"string","title":"Program"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"},"pa_required":{"type":"boolean","title":"Pa Required","default":true},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"}},"description":"One Required-Prior-Authorization requirement for a CPT/HCPCS code: the CMS\nprogram (``dmepos`` / ``opd``), whether PA is required, and the effective/\nremoval date window (ISO; ``end_date`` None = open-ended)."},"SnomedMapEntry":{"type":"object","title":"SnomedMapEntry","required":["snomed_code"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"icd_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd Code"},"map_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Map Rule"},"map_group":{"type":"integer","title":"Map Group","default":0},"map_advice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Map Advice"},"snomed_code":{"type":"string","title":"Snomed Code"},"map_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Map Category"},"map_priority":{"type":"integer","title":"Map Priority","default":0}},"description":"One SNOMED CT -> ICD-10-CM ExtendedMap row (refset 6011000124106): a SNOMED\nconcept's mapped ICD-10-CM target under the reimbursement map, WITH its rule\nsemantics. ``map_group`` collects parallel alternatives; ``map_priority`` is\nthe evaluation order within a group (1 first). ``map_rule`` / ``map_advice``\ncarry the verbatim condition/advice (e.g. an ``IFA 445518008 | Age at onset...``\nrule). ``icd_code`` is the DOTTED target, None for a no-target category (the\n``map_category`` says why). GATED - SNOMED-licensed content."},"VaccineProfile":{"type":"object","title":"VaccineProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/VaccineEntry"},"title":"Entries","default":[]},"total_cvx":{"type":"integer","title":"Total Cvx","default":0},"is_vaccine":{"type":"boolean","title":"Is Vaccine","default":false}},"description":"The CDC CVX vaccine(s) a CPT/HCPCS product code maps to, from the NATIVE\ncodesets cvx / cvx_cpt tables (the CDC IIS standard). The IIS-record (CVX/\nMVX) <-> claim (CPT) bridge for immunization billing reconciliation. A code\nmay map to more than one CVX. Empty when the code maps to no CVX."},"AsaRulesProfile":{"type":"object","title":"AsaRulesProfile","required":["code","code_type"],"properties":{"code":{"type":"string","title":"Code"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"pairs":{"type":"array","items":{"$ref":"#/components/schemas/AsaRulePair"},"title":"Pairs","default":[]},"code_type":{"type":"string","title":"Code Type"},"is_anesthesia_code":{"type":"boolean","title":"Is Anesthesia Code","default":false}},"description":"The ASA RVG book's coding rules for one code (the ``asa_rules`` section).\n\n``pairs`` are the code relations touching this code in BOTH directions.\n\nThe guideline policies used to ride here too. They are code-INDEPENDENT -- byte\nidentical on every code, and 88% of this section's payload -- so they moved to the\n``asa_guidelines`` reference dataset (GET /api/asa/guidelines, MCP\nget_asa_guidelines, `hcs asa-guidelines`). Ask for them once per edition instead of\nonce per code.\n\n``is_anesthesia_code`` says whether the book covers this code as an anesthesia\nservice. The section is omitted entirely for a non-anesthesia code with no\nrelations; an anesthesia code with no relations still gets the object, because\nthere \"the book prints no relation\" is a real answer.\n\nASA-licensed: the egress gate nulls this whole section for a caller who is not\nentitled to the ASA corpus."},"DrgGroupRequest":{"type":"object","title":"DrgGroupRequest","required":["principal_dx"],"properties":{"age":{"anyOf":[{"type":"integer","maximum":130,"minimum":0},{"type":"null"}],"title":"Age"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD); resolves the FY"},"sex":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sex","description":"'M' or 'F'"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"MS-DRG fiscal year; defaults to newest"},"base_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Rate","description":"IPPS national base operating rate for the payment estimate; defaults to the configured rate"},"procedures":{"type":"array","items":{"type":"string"},"title":"Procedures","maxItems":200,"description":"ICD-10-PCS inpatient procedures"},"principal_dx":{"type":"string","title":"Principal Dx","description":"Principal (admitting) ICD-10-CM diagnosis"},"secondary_dxs":{"type":"array","items":{"type":"string"},"title":"Secondary Dxs","maxItems":200,"description":"Secondary ICD-10-CM diagnoses (drive CC/MCC severity)"},"discharge_disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Discharge Disposition"}},"description":"One inpatient encounter's coded data + demographics for MS-DRG assignment."},"ElixhauserEntry":{"type":"object","title":"ElixhauserEntry","required":["comorbidity"],"properties":{"comorbidity":{"type":"string","title":"Comorbidity"},"comorbidity_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comorbidity Description"}},"description":"One AHRQ Elixhauser comorbidity measure an ICD-10-CM code satisfies: the\nmeasure flag (the AHRQ per-code column name, e.g. ``HF``, ``VALVE``,\n``DIAB_CX``, ``CBVD_POA``) and its human-readable description."},"ICDCoOccurrence":{"type":"object","title":"ICDCoOccurrence","required":["icd10","count","frequency"],"properties":{"count":{"type":"integer","title":"Count"},"icd10":{"type":"string","title":"Icd10"},"frequency":{"type":"number","title":"Frequency"}},"description":"One ICD-10 that frequently co-occurs with a CPT in real claims."},"Icd10PcsProfile":{"type":"object","title":"Icd10PcsProfile","properties":{"billable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Billable"},"short_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Description"}},"description":"ICD-10-PCS-specific section: inpatient procedure code facts.\n\nA complete ICD-10-PCS code is 7 characters and ``billable=True``; the\n3-character category rows are headers/titles (``billable=False``)."},"IcdIndexProfile":{"type":"object","title":"IcdIndexProfile","properties":{"drug":{"type":"array","items":{"$ref":"#/components/schemas/IcdIndexDrug"},"title":"Drug","default":[]},"neoplasm":{"type":"array","items":{"$ref":"#/components/schemas/IcdIndexNeoplasm"},"title":"Neoplasm","default":[]}},"description":"The ICD-10-CM Index-grid memberships an ICD-10-CM code maps to (reverse\ndirection), from the NATIVE codesets ``icd10cm_neoplasm`` + ``icd10cm_drug``\ntables. Empty when the code is in neither grid."},"ModifierProfile":{"type":"object","title":"ModifierProfile","required":["modifier"],"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"modifier":{"type":"string","title":"Modifier"},"payment_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Pct"},"pricing_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pricing Note","default":"Policy percentages only - actual dollar amounts are priced by Hank PP Man, not codesets."},"adjustment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adjustment Type"},"affects_payment":{"type":"boolean","title":"Affects Payment","default":false},"ncci_ptp_bypass":{"type":"boolean","title":"Ncci Ptp Bypass","default":false},"rvu_policy_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rvu Policy Indicator"}},"description":"Payment-adjustment semantics for a billing modifier - the curated CMS/NCCI\npolicy overlay (see ``modifier_semantics.py``). PUBLIC-DOMAIN policy, NOT AMA\ndescriptor text, so it is served even when the modifier's AMA description is\nlicense-withheld.\n\n``payment_pct`` is the STANDARD policy multiplier (percent of the fee-schedule\nallowed amount - e.g. 150 for bilateral), a policy fact, NOT a price (dollar\namounts live in Hank PP Man). ``rvu_policy_indicator`` names the native ``rvu``\ntable column that decides, per procedure, whether the modifier is payable\n(e.g. modifier 50 -> the procedure's ``bilat surg`` indicator)."},"MoldxDexProfile":{"type":"object","title":"MoldxDexProfile","properties":{"entry":{"anyOf":[{"$ref":"#/components/schemas/MoldxDexEntry"},{"type":"null"}]}},"description":"MolDX DEX Z-code block: the registry record for one Z-code. LICENSE-GATED\n(Palmetto GBA)."},"OrangeBookEntry":{"type":"object","title":"OrangeBookEntry","properties":{"rs":{"type":"boolean","title":"Rs","default":false},"rld":{"type":"boolean","title":"Rld","default":false},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"te_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Te Code"},"df_route":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Df Route"},"strength":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Strength"},"applicant":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applicant"},"ingredient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ingredient"},"product_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product No"},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trade Name"},"approval_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Date"},"marketing_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marketing Status"},"approved_pre_1982":{"type":"boolean","title":"Approved Pre 1982","default":false},"applicant_full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applicant Full Name"}},"description":"One approved drug product in the FDA Orange Book - one product under one\napplication.\n\n``te_code`` is the therapeutic-equivalence evaluation and the reason the\nsection exists: an \"A\"-rated code (AB, AA, AP, AT ...) means the product is\ntherapeutically equivalent to the reference listed drug and is substitutable\nfor it. ``None`` means NOT RATED (single-source and discontinued products are\nnot rated), never \"not equivalent\".\n\n``approval_date`` is ``None`` on the 12% of products the FDA lists as\n\"Approved Prior to Jan 1, 1982\"; those carry ``approved_pre_1982=True``\ninstead of a fabricated date."},"PreventiveEntry":{"type":"object","title":"PreventiveEntry","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"service_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Name"},"deductible_waived":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Deductible Waived"},"coinsurance_waived":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Coinsurance Waived"}},"description":"One Medicare preventive service a code bills, with its beneficiary\ncost-sharing. ``deductible_waived`` / ``coinsurance_waived`` are 1 (waived)\n/ 0 (the beneficiary still pays) - kept independent, never collapsed."},"PurpleBookEntry":{"type":"object","title":"PurpleBookEntry","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"route":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Route"},"center":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Center"},"bla_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bla Type"},"strength":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Strength"},"dosage_form":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dosage Form"},"proper_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proper Name"},"product_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Kind"},"licensure_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licensure Date"},"product_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Number"},"licensure_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licensure Status"},"marketing_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marketing Status"},"proprietary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proprietary Name"},"product_presentation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Presentation"},"reference_product_bla":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Product Bla"},"reference_product_proper_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Product Proper Name"},"interchangeable_licensure_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interchangeable Licensure Date"},"reference_product_proprietary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Product Proprietary Name"}},"description":"One licensed biological product in the FDA Purple Book - one product\nunder one BLA.\n\n``product_kind`` is why the section exists. ``reference`` is the originator\nbiologic (licensed under PHS Act 351(a)). ``biosimilar`` is highly similar\nto the named reference product (351(k)). ``interchangeable`` is a biosimilar\nthe FDA additionally found substitutable without prescriber intervention,\nsubject to state law - the biologics analogue of an A-rated Orange Book TE\ncode. One BLA can hold products of BOTH 351(k) kinds, so the kind is a\nper-PRODUCT fact, not a per-licence one.\n\n``reference_product_bla`` is DERIVED, and only when unambiguous: the FDA\nnames a reference product by text alone, so it is resolved against the\ndrop's own 351(a) licences and left ``None`` when the name matches more\nthan one (rituximab/Rituxan really does name two). The named reference\nTEXT is always served regardless."},"ValidationError":{"type":"object","title":"ValidationError","required":["loc","msg","type"],"properties":{"ctx":{"type":"object","title":"Context"},"loc":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"}}},"FeeScheduleEntry":{"type":"object","title":"FeeScheduleEntry","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"mp_rvu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mp Rvu"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality"},"modifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifier"},"schedule":{"type":"string","title":"Schedule","default":"pfs"},"work_rvu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Work Rvu"},"co_surgery":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Co Surgery"},"global_days":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Days"},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Code"},"fee_facility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Facility"},"team_surgery":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Team Surgery"},"pctc_indicator":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pctc Indicator"},"fee_nonfacility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fee Nonfacility"},"pe_rvu_facility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pe Rvu Facility"},"assistant_surgery":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Assistant Surgery"},"bilateral_surgery":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bilateral Surgery"},"conversion_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Conversion Factor"},"multiple_procedure":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Multiple Procedure"},"pe_rvu_nonfacility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pe Rvu Nonfacility"},"status_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Description"},"total_rvu_facility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Rvu Facility"},"total_rvu_nonfacility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Rvu Nonfacility"}},"description":"One Medicare fee-schedule row for a code (one modifier variant).\n\nSourced from claim-cleaner's MPFS ``rvu`` table. ``schedule`` is the CMS\nfee-schedule family (``pfs`` for the Physician Fee Schedule today). The\n``fee_*`` amounts are NATIONAL (GPCI = 1.0) allowed amounts computed as\n``total_rvu * conversion_factor`` - a locality-adjusted amount (GPCI from the\n``locale`` table) is forward-ready via the optional ``locality`` field but\nnot computed in this pass. The payment-policy indicators (status, global\nperiod, the surgery/multi-proc flags) come straight off the MPFS row."},"IcdIndexNeoplasm":{"type":"object","title":"IcdIndexNeoplasm","properties":{"icd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icd"},"behavior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behavior"},"site_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Text"}},"description":"One ICD-10-CM Neoplasm-Table membership for a diagnosis code: the site\nbreadcrumb (e.g. 'Neoplasm, neoplastic, lung') and the behavior column\n(malignant_primary | malignant_secondary | ca_in_situ | benign | uncertain\n| unspecified) whose cell holds this code."},"NCCIAddOnProfile":{"type":"object","title":"NCCIAddOnProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/NCCIAddOnEdit"},"title":"Entries","default":[]},"edit_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Edit Type"},"truncated":{"type":"boolean","title":"Truncated","default":false},"primary_codes":{"type":"array","items":{"type":"string"},"title":"Primary Codes","default":[]}},"description":"NCCI Add-On Code edits for a code, from the NATIVE codesets\n``ncci_add_on_edits`` table (the CMS AOC fixed-width files).\n\n``edit_type`` is the code's AOC type (CMS, verbatim 2026-06-11): Type 1 -\n\"never paid unless a listed primary procedure code is also paid\"; Type 2 -\nno CMS-defined primary list, contractor discretion (``entries`` carry\n``primary_code=None``); Type 3 - a partial, non-exclusive primary list.\nEmpty (``edit_type`` None, no entries) when the code is not an add-on code."},"NdcRxnormMapping":{"type":"object","title":"NdcRxnormMapping","required":["rxnorm_code"],"properties":{"rxnorm_code":{"type":"string","title":"Rxnorm Code"},"rxnorm_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rxnorm Name"}},"description":"One NDC->RxNorm 'Maps to' edge: the RxNorm RXCUI + its name."},"NdcRxnormProfile":{"type":"object","title":"NdcRxnormProfile","properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/NdcRxnormMapping"},"title":"Mappings","default":[]}},"description":"NDC<->RxNorm crosswalk section (OPEN): the RxNorm concept(s) an NDC maps\nto (OHDSI 'Maps to'). Empty when the NDC maps to nothing / not deployed."},"OppsGroupRequest":{"type":"object","title":"OppsGroupRequest","required":["lines"],"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD); resolves the OPPS calendar quarter when 'quarter' is omitted"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OppsLineInput"},"title":"Lines","maxItems":200,"minItems":1,"description":"The HCPCS/CPT lines on the claim"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter","description":"OPPS quarter, e.g. '2026Q2'; defaults to the newest loaded quarter"},"conversion_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Conversion Factor","description":"National OPPS conversion factor for the weight-only payment fallback; defaults to the configured value"}},"description":"One outpatient encounter's claim lines + the quarter/conversion context."},"PriorAuthProfile":{"type":"object","title":"PriorAuthProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/PriorAuthEntry"},"title":"Entries","default":[]}},"description":"The Medicare prior-authorization requirement(s) a CPT/HCPCS code carries,\nfrom the NATIVE codesets ``prior_auth`` table (the CMS DMEPOS + OPD Required\nPrior Authorization lists). The front-end denial-prevention flag. Empty when\nthe code requires no PA."},"ProposalChangeIn":{"type":"object","title":"ProposalChangeIn","required":["op"],"properties":{"op":{"enum":["add","replace","retire"],"type":"string","title":"Op"},"scope":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Scope","description":"Specialty lane this new rule belongs to (anesthesia|radiology|surgical|em|gi); null = global. Not valid on a 'retire'."},"new_source":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"New Source"},"code_or_key":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Code Or Key","description":"Target code/key for THIS change in a batch proposal; null = the proposal-level code_or_key"},"new_end_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New End Year"},"new_guidance":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"New Guidance"},"new_start_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Start Year"},"target_row_hashes":{"type":"array","items":{"type":"string"},"title":"Target Row Hashes","maxItems":200,"description":"ACTIVE row hashes this op replaces/retires (empty for add). A combine-N-rows-into-1 is ONE replace with N targets."}}},"RuleCheckRequest":{"type":"object","title":"RuleCheckRequest","required":["codes"],"properties":{"age":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Age"},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"sex":{"anyOf":[{"enum":["M","F"],"type":"string"},{"type":"null"}],"title":"Sex"},"porv":{"anyOf":[{"enum":["P","V"],"type":"string"},{"type":"null"}],"title":"Porv"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"codes":{"type":"array","items":{"type":"string"},"title":"Codes","maxItems":500,"minItems":1}}},"_ConflictRequest":{"type":"object","title":"_ConflictRequest","required":["icd_a","icd_b"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"icd_a":{"type":"string","title":"Icd A","description":"first ICD-10-CM code"},"icd_b":{"type":"string","title":"Icd B","description":"second ICD-10-CM code"}}},"AccessRequestBody":{"type":"object","title":"AccessRequestBody","required":["corpus_key"],"properties":{"corpus_key":{"type":"string","title":"Corpus Key","maxLength":128,"minLength":1,"description":"The licensed corpus to request access to."},"attestation":{"type":"boolean","title":"Attestation","default":false,"description":"Affirm you hold the license required for this corpus. REQUIRED (must be true) for a license-restricted corpus - the request is 422'd without it, and the response carries the exact attestation wording to show."},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Justification","description":"Why you need it (shown to the Hank admin)."}}},"AnesthesiaProfile":{"type":"object","title":"AnesthesiaProfile","properties":{"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"},"is_addon":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Addon"},"work_rvu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Work Rvu"},"cf_locality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cf Locality"},"global_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Period"},"base_units_asa":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Base Units Asa"},"base_units_cms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Base Units Cms"},"is_resequenced":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Resequenced"},"is_time_tracked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Time Tracked"},"rvg_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rvg Description"},"is_new_this_year":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is New This Year"},"changed_this_year":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Changed This Year"},"conversion_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Conversion Factor"},"rvg_coding_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rvg Coding Comment"},"coding_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Coding Instructions"},"cms_differs_from_asa":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cms Differs From Asa"},"estimated_base_allowed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Estimated Base Allowed"},"cf_locality_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cf Locality Description"}},"description":"Anesthesia mapping detail for a surgical CPT (from the ASA crosswalk +\nRVG): base units (CMS vs ASA), whether the code is time-billed, the ASA/RVG\ncoding instructions, and per-edition change flags. This is what an anesthesia\ncoder actually needs to bill and to know which code to pick."},"AocOrphansRequest":{"type":"object","title":"AocOrphansRequest","required":["codes"],"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD)"},"codes":{"type":"array","items":{"type":"string"},"title":"Codes","maxItems":200,"minItems":1,"description":"CPT/HCPCS codes on the claim"}},"description":"The codes on a claim, to flag add-on codes billed without a primary."},"AscPaymentProfile":{"type":"object","title":"AscPaymentProfile","properties":{"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"payment_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Rate"},"payment_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Indicator"}},"description":"ASC fee-schedule payment for a HCPCS: the ASC payment indicator + the\nnational ASC payment rate."},"AspPricingProfile":{"type":"object","title":"AspPricingProfile","properties":{"dosage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dosage"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"file_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Status"},"effective_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective End"},"payment_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Limit"},"coinsurance_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coinsurance Pct"},"effective_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Start"},"short_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Description"}},"description":"CMS Part-B ASP drug pricing for a HCPCS drug code (J/Q/A/P).\n\n``payment_limit`` is the Medicare allowed amount (ASP + 6%) for the listed\n``dosage`` billing unit, for the given quarter."},"CodesBatchRequest":{"type":"object","title":"CodesBatchRequest","required":["type","codes"],"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"type":{"$ref":"#/components/schemas/CodeType","description":"Code type for the whole batch (deterministic shape)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"codes":{"type":"array","items":{"type":"string"},"title":"Codes","maxItems":500,"minItems":1},"detail":{"type":"string","title":"Detail","default":"standard"},"exclude":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Exclude"},"include":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Include"}}},"CrosswalksProfile":{"type":"object","title":"CrosswalksProfile","properties":{"asa_codes":{"type":"array","items":{"type":"string"},"title":"Asa Codes","default":[]},"surgical_cpts":{"type":"array","items":{"type":"string"},"title":"Surgical Cpts","default":[]}},"description":"ASA crosswalk mappings for a code.\n\nFor surgical CPT codes: asa_codes lists the anesthesia codes that map to it.\nFor anesthesia codes: surgical_cpts lists the surgical CPT codes that use it.\n\nNote: tuples (not lists) for cache immutability - see GroupsProfile docstring."},"ElixhauserProfile":{"type":"object","title":"ElixhauserProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/ElixhauserEntry"},"title":"Entries","default":[]}},"description":"The AHRQ Elixhauser comorbidity measures an ICD-10-CM diagnosis satisfies,\nfrom the codesets ``elixhauser_icd`` table - the standard cross-payer\ncomorbidity/severity adjuster (the non-IPPS analog of CMS CC/MCC). The\nPOA-aware Cerebrovascular split (CBVD_POA/CBVD_SQLA) is preserved verbatim.\nEmpty when the code satisfies no measure."},"HccCrosswalkEntry":{"type":"object","title":"HccCrosswalkEntry","required":["hcc","model_version"],"properties":{"hcc":{"type":"integer","title":"Hcc"},"icd_count":{"type":"integer","title":"Icd Count","default":0},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence"},"model_version":{"type":"string","title":"Model Version"}},"description":"A cross-model-version HCC mapping (V24↔V28), derived from shared ICDs.\nCMS publishes no direct map; ``confidence`` reflects shared-ICD support."},"HhPdgmInteraction":{"type":"object","title":"HhPdgmInteraction","properties":{"partner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner"},"interaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interaction Id"},"partner_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Description"}},"description":"One published high-comorbidity PAIRING under Home Health PDGM.\n\nTwo comorbidity subgroups reported on the same period of care earn the HIGH\ncomorbidity adjustment only when the pair appears in this list. ``partner``\nis the OTHER subgroup in the pair, relative to the code being looked up."},"MedicareReference":{"type":"object","title":"MedicareReference","required":["amount","basis"],"properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"basis":{"type":"string","title":"Basis"},"amount":{"type":"number","title":"Amount"}},"description":"A NATIONAL Medicare REFERENCE figure for a procedure-concept member\n(#164) - a benchmark, NEVER a negotiated price (real rates live in Hank\nPP Man; this is the same boundary as the MS-DRG grouper's\n``estimated_payment``). No wage-index/outlier/locality math beyond what the\nnamed basis itself is; ``basis`` says exactly what the number is:\n\n  msdrg_weight_x_ipps_national_base_rate   DRG relative weight × the national\n                                           IPPS base operating rate (env\n                                           HANK_IPPS_BASE_RATE; coarse)\n  opps_apc_national_rate                   the APC's national OPPS rate\n  asc_national_rate                        the Medicare ASC fee-schedule rate\n  mpfs_national_facility_allowed           MPFS facility total RVU × CF (GPCI=1)\n  mpfs_national_nonfacility_allowed        MPFS non-facility total RVU × CF\n  anesthesia_national_avg_cf_x_base_units  the national-average anesthesia CF\n                                           × ASA base units (TIME UNITS\n                                           EXCLUDED - the flag-fall reference;\n                                           anesthesia bills (base+time)×CF)"},"OrangeBookProfile":{"type":"object","title":"OrangeBookProfile","properties":{"appl_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appl No"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/OrangeBookEntry"},"title":"Entries","default":[]},"appl_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appl Type"},"application_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Number"}},"description":"FDA Orange Book section (on ndc): the therapeutic-equivalence identity of\nthe FDA application this drug was approved under.\n\nThe grain is the APPLICATION FAMILY - every product under the application,\neach carrying its own strength / product_no / te_code, because the NDC\ndirectory has no product-number leg to narrow on. Empty ``entries`` with a\n``None`` ``application_number`` is the EXPECTED shape for a drug with no\nOrange Book application (a BLA biologic, an OTC monograph drug, an\nunapproved product) - not an error. A REFERENCE, never pricing."},"PreventiveProfile":{"type":"object","title":"PreventiveProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/PreventiveEntry"},"title":"Entries","default":[]},"is_preventive":{"type":"boolean","title":"Is Preventive","default":false},"total_services":{"type":"integer","title":"Total Services","default":0}},"description":"Medicare preventive-services cost-sharing for a CPT/HCPCS code, from the\nNATIVE codesets ``preventive_services`` table (the CMS MLN006559 chart).\nAnswers 'is this a Medicare preventive service, and is the deductible /\ncoinsurance waived?'. A code may bill more than one preventive service."},"PurpleBookProfile":{"type":"object","title":"PurpleBookProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/PurpleBookEntry"},"title":"Entries","default":[]},"bla_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bla Number"},"application_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Number"}},"description":"FDA Purple Book section (on ndc): the biologic-licence identity of the\nBLA this drug was licensed under.\n\nThe grain is the LICENCE FAMILY - every product under the BLA, each carrying\nits own strength / product_number / product_kind, because the NDC directory\nhas no product-number leg to narrow on. Empty ``entries`` with a ``None``\n``bla_number`` is the EXPECTED shape for a drug that is not a biologic (an\nNDA/ANDA drug, an OTC monograph drug, an unapproved product) - not an error.\nA REFERENCE, never pricing."},"TelehealthProfile":{"type":"object","title":"TelehealthProfile","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"eligible":{"type":"boolean","title":"Eligible","default":false},"audio_only":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Only"}},"description":"Medicare Telehealth Services list status for a CPT/HCPCS code, from the\ncodesets ``telehealth_services`` table. ``eligible`` is True when the code is\non the list for the resolved calendar year; ``status`` is its category\n(Permanent / Provisional / etc.) and ``audio_only`` flags audio-only\neligibility. Empty (eligible=False) when not on the list / no table."},"DataFreshnessEntry":{"type":"object","title":"DataFreshnessEntry","required":["table"],"properties":{"table":{"type":"string","title":"Table"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"description":"When one backing table was last refreshed (from codeset_meta)."},"EapgWeightsProfile":{"type":"object","title":"EapgWeightsProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/EapgWeight"},"title":"Entries","default":[]}},"description":"Payer-published EAPG weights for one group. LICENSE-GATED (Solventum)."},"FeeScheduleProfile":{"type":"object","title":"FeeScheduleProfile","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/FeeScheduleEntry"},"title":"Entries","default":[]},"conversion_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Conversion Factor"}},"description":"Medicare fee-schedule allowed amounts + payment policy for a code.\n\nOne entry per modifier variant (base / 26 / TC). Empty when claim-cleaner's\n``rvu`` fee-schedule data isn't reachable on this backend (the section then\nreports ``not_deployed``). Locality-adjusted amounts are a forward-ready\nfollow-up; today's ``fee_*`` are national (GPCI = 1.0)."},"MceIcdRulesProfile":{"type":"object","title":"MceIcdRulesProfile","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/MceIcdRule"},"title":"Rules","default":[]}},"description":"MCE (Medicare Code Editor) demographic + structural rules for an\nICD-10-CM code, from the NATIVE codesets ``mce_icd_rules`` table (the CMS\n\"Definition of Medicare Code Edits\" manual's machine-readable lists).\nRule names stay neutral - consumers own severity/applicability (MCE\nsemantics are inpatient; claim-cleaner applies them to professional dx)."},"MedicaidEobMapping":{"type":"object","title":"MedicaidEobMapping","properties":{"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"edition_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edition Date"},"source_program":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Program"},"resolution_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolution Text"},"state_edit_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Edit Code"},"edit_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edit Description"}},"description":"One state Medicaid edit that maps to a national CARC/RARC code."},"MedicaidEobProfile":{"type":"object","title":"MedicaidEobProfile","required":["national_code","code_kind"],"properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MedicaidEobMapping"},"title":"Mappings","default":[]},"code_kind":{"type":"string","title":"Code Kind"},"national_code":{"type":"string","title":"National Code"},"program_count":{"type":"integer","title":"Program Count","default":0},"total_mappings":{"type":"integer","title":"Total Mappings","default":0},"mappings_truncated":{"type":"boolean","title":"Mappings Truncated","default":false}},"description":"medicaid_eob section (on a CARC/RARC profile): the state Medicaid MMIS\nedits across jurisdictions that map to this national code (reverse\ncrosswalk). The forward direction (state edit -> national codes) is the\n/api/medicaid-edit/{program}/{edit} route."},"MembershipsProfile":{"type":"object","title":"MembershipsProfile","required":["code","code_type"],"properties":{"axes":{"type":"array","items":{"type":"string"},"title":"Axes","default":[]},"code":{"type":"string","title":"Code"},"code_type":{"type":"string","title":"Code Type"},"memberships":{"type":"array","items":{"$ref":"#/components/schemas/Membership"},"title":"Memberships","default":[]}},"description":"Every classification-group membership a code has, across all deployed\ngrouping taxonomies - the unified reverse \"what groups is this code in?\"\nanswer. Purely additive/read-only: axes whose backing table is absent are\nsimply omitted (degrade-to-empty). Phase-1 axes are all free / public-domain;\na license-gated axis carries its own descriptor_license per row and rides the\nstandard per-row egress gate (redact-not-block: the group stays discoverable,\nonly the descriptor label is withheld from a non-entitled caller)."},"NcpdpRejectProfile":{"type":"object","title":"NcpdpRejectProfile","required":["reject_code"],"properties":{"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"reject_code":{"type":"string","title":"Reject Code"},"field_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Number"},"transaction_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Code"}},"description":"NCPDP reject-code block: the value returned in field 511-FB on a\nTelecommunication Standard D.0 denial response, its description, the field it\nnames, and the ECL publication it came from. LICENSE-GATED and POLICY-GATED\n(NCPDP)."},"OppsPaymentProfile":{"type":"object","title":"OppsPaymentProfile","properties":{"apc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apc"},"copay":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Copay"},"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarter"},"min_copay":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Copay"},"payment_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Rate"},"relative_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Relative Weight"},"status_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Indicator"}},"description":"OPPS Addendum B outpatient payment for a HCPCS/CPT: the status indicator\n(how OPPS treats the code - paid/packaged/comprehensive), APC assignment,\nrelative weight, national payment rate, and copays."},"CdtEditorialProfile":{"type":"object","title":"CdtEditorialProfile","required":["code"],"properties":{"code":{"type":"string","title":"Code"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descriptor"},"nomenclature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nomenclature"},"descriptor_es":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descriptor Es"},"nomenclature_es":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nomenclature Es"},"consumer_friendly":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumer Friendly"},"category_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Of Service"},"subcategory_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory Of Service"}},"description":"The full ADA CDT editorial content for a dental D-code: nomenclature,\ndescriptor of the procedure, category of service, plus the Spanish and\nConsumer-Friendly variants. The free CMS HCPCS file carries only the SHORT\ndescriptor, which is what the ``cdt`` block ships. LICENSE-GATED (ADA)."},"CoOccurrenceProfile":{"type":"object","title":"CoOccurrenceProfile","properties":{"source":{"type":"string","title":"Source","default":"hank_claims"},"top_icds":{"type":"array","items":{"$ref":"#/components/schemas/ICDCoOccurrence"},"title":"Top Icds","default":[]},"truncated":{"type":"boolean","title":"Truncated","default":false},"total_available":{"type":"integer","title":"Total Available","default":0}},"description":"Top ICD-10s billed alongside this CPT, ranked by frequency desc.\n\n``source`` is the dataset-level label for the real-claims corpus behind\nthe section ('hank_claims' - codesets' native frequency tables). It is\nNOT the per-row DB provenance column (``frequency_*.source``), which is\ninternal-only and never serialized into any response model."},"CompanionRafRequest":{"type":"object","title":"CompanionRafRequest","required":["age","sex"],"properties":{"age":{"type":"integer","title":"Age","maximum":130,"minimum":0},"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"lti":{"type":"boolean","title":"Lti","default":false,"description":"ESRD-HCC only: long-term-institutional status"},"sex":{"type":"string","title":"Sex","description":"'M' or 'F'"},"esrd":{"type":"boolean","title":"Esrd","default":false,"description":"RxHCC only: the member had at least one month of ESRD status in the payment year (the ESRD axis of the Rx_NE_* new-enrollee grids)"},"hccs":{"type":"array","items":{"type":"integer"},"title":"Hccs","maxItems":500,"description":"Model category numbers present on the beneficiary"},"icds":{"type":"array","items":{"type":"string"},"title":"Icds","maxItems":500,"description":"ICD-10-CM codes (resolved to the model's categories)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"segment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Segment","description":"Risk segment; default is the model reference"},"disabled":{"type":"boolean","title":"Disabled","default":false,"description":"Currently disabled"},"medicaid":{"type":"boolean","title":"Medicaid","default":false,"description":"RxHCC only. ESRD-HCC REJECTS this with a 422: it encodes dual eligibility as dual_status (none|partial|full), which drives the FBDual/PBDual demographic terms and the ND_PBD vs FBD functioning-graft legs - silently ignoring medicaid here understated a full-dual member's score"},"dual_status":{"anyOf":[{"enum":["none","partial","full"],"type":"string"},{"type":"null"}],"title":"Dual Status","description":"ESRD-HCC only: Medicaid dual status - none | partial | full. Case- and whitespace-EXACT on this REST surface (the schema is a closed Literal, so 'Full ' or 'FULL' is a 422); MCP, the CLI and the library normalize instead."},"orig_disabled":{"type":"boolean","title":"Orig Disabled","default":false,"description":"Originally entitled by disability (OREC 1)"},"originally_esrd":{"type":"boolean","title":"Originally Esrd","default":false,"description":"ESRD-HCC only: originally entitled by ESRD (OREC 2/3)"},"months_since_transplant":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Months Since Transplant","description":"ESRD-HCC only: months since the kidney transplant (month 1 = the transplant month). 1-3 score the flat transplant factors; 4+ select the functioning-graft duration add-on"}},"description":"One beneficiary's category profile + demographics for a companion RAF.\n\nThe RxHCC-only and ESRD-HCC-only member inputs share this model (one request\nshape for the two integer-keyed companions); sending one model's input to the\nother is a 422 naming the owning model, not a silent no-op.","additionalProperties":false},"GlobalPeriodProfile":{"type":"object","title":"GlobalPeriodProfile","properties":{"pre_op":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pre Op"},"post_op":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Post Op"},"intra_op":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Intra Op"}},"description":"The pre/intra/post-operative PROPORTIONS of a surgical code's global\npackage (each a fraction of 1.0, e.g. 0.10 / 0.69 / 0.21 for a 090-day\nglobal). Tells a coder how the bundled work splits - e.g. whether a\nsame-surgeon post-op visit is already paid for inside the global."},"HTTPValidationError":{"type":"object","title":"HTTPValidationError","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail"}}},"Icd10cmNotesProfile":{"type":"object","title":"Icd10cmNotesProfile","properties":{"notes":{"type":"array","items":{"$ref":"#/components/schemas/Icd10cmNote"},"title":"Notes","default":[]}},"description":"ICD-10-CM tabular instructional notes (Excludes1 / Excludes2 /\ncode-first / use-additional) that apply to a diagnosis - every note\nattached at the code or any ancestor category, from the NATIVE codesets\n``icd10cm_tabular_notes`` table (parsed from the NCHS tabular XML).\n\"Conflict\" is the consumer-side reading of Excludes1 pairs -\n``ICD.getConflicts(icd_a, icd_b)`` serves that question directly."},"IcdConflictsRequest":{"type":"object","title":"IcdConflictsRequest","required":["codes"],"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos","description":"Date of service (YYYY-MM-DD); resolves the FY"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"codes":{"type":"array","items":{"type":"string"},"title":"Codes","maxItems":100,"minItems":1,"description":"ICD-10-CM diagnoses (dotted or dotless)"}},"description":"A set of ICD-10-CM diagnoses to scan for Excludes1 conflicts."},"IpfComorbidityEntry":{"type":"object","title":"IpfComorbidityEntry","required":["category","code_system"],"properties":{"fy":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy"},"category":{"type":"string","title":"Category"},"code_system":{"type":"string","title":"Code System"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"}},"description":"One IPF PPS comorbidity-category membership.\n\n``code_system`` distinguishes the ICD-10-CM diagnosis categories from the\nICD-10-PCS procedure categories that ride the same published list."},"IrfComorbidityEntry":{"type":"object","title":"IrfComorbidityEntry","required":["code"],"properties":{"fy":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy"},"code":{"type":"string","title":"Code"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"tier":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tier"},"code_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Title"},"entry_type":{"type":"string","title":"Entry Type","default":"single"},"partner_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Code"},"partner_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Title"},"ric_exclusion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ric Exclusion"},"tier_hipps_character":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tier Hipps Character"}},"description":"One IRF PPS Appendix C comorbidity entry.\n\n``tier`` (1 high cost, 2 medium, 3 low) becomes the first character of the\nIRF HIPPS code: B, C and D respectively.\n\n``ric_exclusion`` names the Rehabilitation Impairment Categories the tier\ndoes NOT apply to (empty means none are excluded) -- always check the case's\nRIC before applying the tier.\n\n``entry_type`` ``combination`` means the tier is earned ONLY when this code\nand its ``partner_code`` are BOTH present. Never read a tier off a\ncombination entry alone."},"AprDrgWeightsProfile":{"type":"object","title":"AprDrgWeightsProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/AprDrgWeight"},"title":"Entries","default":[]}},"description":"Payer-published APR-DRG weights for one base DRG (up to four rows, one per\nSeverity of Illness subclass, per payer). LICENSE-GATED (Solventum)."},"DataFreshnessProfile":{"type":"object","title":"DataFreshnessProfile","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/DataFreshnessEntry"},"title":"Entries","default":[]}},"description":"Per-table 'last updated' provenance for the sources backing THIS profile -\na scholarly/audit 'data current as of' stamp so a consumer knows whether they\nare looking at this year's loaded data."},"EsrdComorbidityEntry":{"type":"object","title":"EsrdComorbidityEntry","required":["category","acuity"],"properties":{"acuity":{"type":"string","title":"Acuity"},"category":{"type":"string","title":"Category"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"}},"description":"One ESRD PPS comorbidity-category membership."},"Icd10cmSnomedMapping":{"type":"object","title":"Icd10cmSnomedMapping","required":["snomed_code"],"properties":{"snomed_code":{"type":"string","title":"Snomed Code"},"snomed_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snomed Name"}},"description":"One ICD-10-CM->SNOMED 'Maps to' edge: the SNOMED concept id + its name."},"Icd10cmSnomedProfile":{"type":"object","title":"Icd10cmSnomedProfile","properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/Icd10cmSnomedMapping"},"title":"Mappings","default":[]}},"description":"ICD-10-CM<->SNOMED crosswalk section (GATED - carries SNOMED descriptors\nunder the SNOMED/UMLS license): the SNOMED concept(s) an ICD-10-CM code maps\nto (OHDSI 'Maps to'). Empty when none / not deployed."},"MoldxDexTestsProfile":{"type":"object","title":"MoldxDexTestsProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/MoldxDexEntry"},"title":"Entries","default":[]}},"description":"The registered DEX tests that bill under a CPT/HCPCS code - the reverse of\nthe moldx-dex code type. Resolves an unlisted molecular CPT (81479) to the\nspecific tests behind it. LICENSE-GATED (Palmetto GBA)."},"RelationshipsProfile":{"type":"object","title":"RelationshipsProfile","properties":{"related":{"type":"array","items":{"$ref":"#/components/schemas/RelatedCode"},"title":"Related","default":[]},"truncated":{"type":"boolean","title":"Truncated","default":false},"total_available":{"type":"integer","title":"Total Available","default":0}},"description":"Ranked codes that go with this one, in every stored direction - empirical\nco-occurrence frequency, count-free. Group ``related`` by\n``relationship_type`` for display (cpt_icd, icd_cpt, cpt_cpt, ...); ranks\nare dense per (relationship_type, segment)."},"HedisValueSetsProfile":{"type":"object","title":"HedisValueSetsProfile","properties":{"value_sets":{"type":"array","items":{"$ref":"#/components/schemas/HedisValueSetMembership"},"title":"Value Sets","default":[]}},"description":"The NCQA HEDIS value sets a code belongs to - which quality measures count\nthis code. LICENSE-GATED (NCQA commercial license)."},"IpfComorbidityProfile":{"type":"object","title":"IpfComorbidityProfile","properties":{"fy":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/IpfComorbidityEntry"},"title":"Entries","default":[]}},"description":"The IPF PPS comorbidity categories a code belongs to (Addendum B-4 --\ncomposition only; the payment adjustment factor is deliberately absent)."},"IrfComorbidityProfile":{"type":"object","title":"IrfComorbidityProfile","properties":{"fy":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fy"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/IrfComorbidityEntry"},"title":"Entries","default":[]}},"description":"The IRF PPS comorbidity tier entries an ICD-10-CM code carries.\n\nA code can appear more than once: once standalone and once per combination\npair it heads, each pair with its own RIC exclusion."},"EsrdComorbidityProfile":{"type":"object","title":"EsrdComorbidityProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/EsrdComorbidityEntry"},"title":"Entries","default":[]},"published_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Published Note"},"published_effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Published Effective From"}},"description":"The ESRD PPS comorbidity categories an ICD-10-CM code belongs to.\n\n``published_note`` always carries the vintage caveat: CMS last published this\nlist effective 2020-10-01 and has not republished since, so it has not\nabsorbed the FY2021 through FY2026 ICD-10-CM updates. The list ships exactly\nas CMS published it, and the note travels with every answer so a consumer\ncannot mistake it for a maintained list."},"ProcedureConceptMember":{"type":"object","title":"ProcedureConceptMember","required":["member_type","code","role"],"properties":{"code":{"type":"string","title":"Code"},"role":{"type":"string","title":"Role"},"base_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Base Units"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence"},"converts_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Converts To"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"global_days":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Days"},"member_type":{"type":"string","title":"Member Type"},"bundle_scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bundle Scope"},"relationship":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relationship"},"billing_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Class"},"converts_from":{"type":"array","items":{"type":"string"},"title":"Converts From","default":[]},"pctc_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pctc Indicator"},"bundle_excludes":{"type":"array","items":{"type":"string"},"title":"Bundle Excludes","default":[]},"bundle_includes":{"type":"array","items":{"type":"string"},"title":"Bundle Includes","default":[]},"medicare_reference":{"anyOf":[{"$ref":"#/components/schemas/MedicareReference"},{"type":"null"}]},"already_packaged_in_facility":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Already Packaged In Facility"}},"description":"One code form of a procedure concept - a sibling across coding systems.\n\n``description`` is joined at serve time and is license-gated per member\n(AMA-CPT and 3M-APR-DRG descriptors are nulled for a non-entitled caller;\nthe code + relationship are always served - redact-not-block). ``bundle_scope``\nis the apples-to-apples hint (what this form's published price includes, e.g.\nan inpatient DRG facility bundle vs an outpatient CPT line)."},"HedisValueSetMembership":{"type":"object","title":"HedisValueSetMembership","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"code_system":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code System"},"measure_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Measure Year"},"value_set_oid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Set Oid"},"value_set_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Set Name"},"code_system_oid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code System Oid"},"code_system_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code System Version"}},"description":"One HEDIS value set a code belongs to, with the code-system provenance the\nVSD publishes for that membership."},"ProcedureConceptProfile":{"type":"object","title":"ProcedureConceptProfile","required":["code","code_type"],"properties":{"code":{"type":"string","title":"Code"},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/ProcedureConceptSibling"},"title":"Concepts","default":[]},"code_type":{"type":"string","title":"Code Type"}},"description":"Cross-setting procedure-IDENTITY (#149): the procedure concept(s) this code\nis a member of, each with its sibling code forms across CPT/MS-DRG/APR-DRG/APC\n+ setting + bundle_scope + confidence. A DRG is coarser than a CPT (DRG 470 =\nhip AND knee), so one code can resolve to a SET of concepts - never a 1:1.\nThis is an identity bridge, not a price map (pricing lives in PPMan)."},"ProcedureConceptSibling":{"type":"object","title":"ProcedureConceptSibling","required":["concept_key"],"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ProcedureConceptMember"},"title":"Members","default":[]},"setting":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setting"},"asc_payable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Asc Payable"},"concept_key":{"type":"string","title":"Concept Key"},"curation_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Curation Status"},"procedure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procedure Class"},"outpatient_payable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Outpatient Payable"},"asc_payment_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asc Payment Indicator"},"opps_status_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opps Status Indicator"},"shoppable_service_ids":{"type":"array","items":{"type":"integer"},"title":"Shoppable Service Ids","default":[]},"asc_medicare_reference":{"anyOf":[{"$ref":"#/components/schemas/MedicareReference"},{"type":"null"}]}},"description":"A procedure concept this code belongs to, with its cross-system equivalents.\n\n``outpatient_payable`` / ``opps_status_indicator`` are the site-of-service\npayability signal (derived at serve time from the anchor's OPPS Addendum-B\nstatus indicator): whether the procedure can bill in a hospital-outpatient /\nASC setting at all - the facility-matching axis for the price shopper."},"SnomedIcd10cmMapProfile":{"type":"object","title":"SnomedIcd10cmMapProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/SnomedMapEntry"},"title":"Entries","default":[]}},"description":"The SNOMED CT concepts whose reimbursement ExtendedMap targets an\nICD-10-CM code - the REVERSE direction of refset 6011000124106 (which SNOMED\nconcepts map TO this ICD, with the group/priority MAPRULE/MAPADVICE\nconditions). From the NATIVE codesets ``snomed_icd10cm_map`` table. GATED\n(SNOMED-licensed): withheld from non-entitled external callers."},"MedicareSpecialtyMapping":{"type":"object","title":"MedicareSpecialtyMapping","properties":{"provider_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Type"},"specialty_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specialty Description"},"medicare_specialty_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Medicare Specialty Code"}},"description":"One NUCC-taxonomy -> Medicare-specialty mapping (a taxonomy can carry\nmore than one Medicare specialty; none is dropped)."},"MedicareSpecialtyProfile":{"type":"object","title":"MedicareSpecialtyProfile","required":["taxonomy_code"],"properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MedicareSpecialtyMapping"},"title":"Mappings","default":[]},"provider_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Type"},"taxonomy_code":{"type":"string","title":"Taxonomy Code"},"specialty_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Specialty Description"},"medicare_specialty_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Medicare Specialty Code"}},"description":"The CMS Taxonomy -> Medicare Specialty crosswalk for a NUCC provider-\ntaxonomy code, from the NATIVE codesets ``nucc_medicare_specialty`` table.\nThe PRIMARY (lowest) Medicare specialty is at the top level; every mapping\nis under ``mappings``. ``medicare_specialty_code`` is None when the taxonomy\ncarries no Medicare specialty (the crosswalk is partial - modeled optional,\nnot a total function)."},"IoceProcDemographicsEntry":{"type":"object","title":"IoceProcDemographicsEntry","required":["origin"],"properties":{"sex":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sex"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"hi_age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Hi Age"},"lo_age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lo Age"},"origin":{"type":"string","title":"Origin"},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rationale"},"effective_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective To"},"effective_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective From"},"source_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Version"}},"description":"One procedure-side demographic restriction for a CPT/HCPCS code.\n\n``origin`` is deliberately part of the contract (unlike the frequency\ntables' DB-internal ``source`` column): for THIS dataset the overlay-ness\nIS the semantic content - a consumer deciding deny-vs-warn must know\nwhether a restriction is CMS's I/OCE edit (``'ioce'``) or Hank policy\n(``'hank_curated'``; CMS deactivated procedure-sex editing in v26.0/\nJan-2025, so every sex restriction today is the curated overlay).\n\nI/OCE rows carry the age band + version-ranged effective dates\n(``effective_to`` None = the open newest range). CMS age encodings:\n0/0 = newborn (<1yr), 0/17 = pediatric, 9/64 = maternity, 15/124 = adult\n(0/124 = all ages is never stored - only restricted rows ship). ``sex``\non an ioce row is forward-compat only (NULL today). Curated rows carry\n``rule``/``value`` (e.g. ``sex`` / ``female``) and ``rationale`` (the CPT\ndescription that justified the rule); they are undated policy."},"CptIcdGuidanceBatchRequest":{"type":"object","title":"CptIcdGuidanceBatchRequest","required":["codes"],"properties":{"dos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dos"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"codes":{"type":"array","items":{"type":"string"},"title":"Codes","maxItems":500,"minItems":1}}},"IoceProcDemographicsProfile":{"type":"object","title":"IoceProcDemographicsProfile","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/IoceProcDemographicsEntry"},"title":"Entries","default":[]}},"description":"Procedure-side demographics for a CPT/HCPCS code, from the NATIVE\ncodesets ``ioce_proc_demographics`` (CMS I/OCE quarterly Report-Tables,\nversion-ranged) + ``hank_proc_demographics`` (the Hank-curated sex\noverlay) tables - the CODE_RULES replacement (2026-06-11 spec §4).\nProfile-level reads are year-granular (the year's Dec-31 anchor);\nexact-date selection lives on ``IOCEPROC.get_demographics(code, dos=)``.\nEmpty when the code carries no restriction."}},"securitySchemes":{"HankAccessToken":{"type":"http","scheme":"bearer","description":"Your `hcs_` access token from console.hank.ai. The API has no login/session - every request must carry it as `Authorization: Bearer <token>`. Click Authorize and paste just the token (no 'Bearer ' prefix)."}}}}