---
title: "Batch Hcc Suppress"
method: POST
path: "/api/v1/batch/hcc/suppress"
tags: ["batch"]
---

# Batch Hcc Suppress

`POST /api/v1/batch/hcc/suppress`

## Request

- Base URL: `https://api.accurecord.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.accurecord.io/api/v1/batch/hcc/suppress`
- Auth: none declared

Analyze HCC categories for a set of codes with hierarchy suppression.

For each code, retrieves HCC categories for the specified model/version,
attaches RAF weights, then applies CMS hierarchy rules to determine
which lower-severity categories are suppressed.

Returns per-code details, active/suppressed category lists, and a
total RAF score from the active (non-suppressed) categories.

``total_raf_score`` is ``null`` — never a bare 0.0 — whenever the mapped categories
could not resolve a coefficient; ``raf_status`` / ``raf_status_detail`` say why, and
``categories_without_coefficient`` names them. A real 0.0 (every code evaluated, none
maps to a category in this model) is still returned as 0.0 with ``no_hcc_mapping``.

**Limits:**
- Maximum 50 codes per request
- Requires Pro or Enterprise tier

## Headers

- `x-api-key` string, nullable

## Request body

- BatchHCCSuppressRequest: Request body for HCC suppression analysis.
  - `codes` string[], required: List of ICD-10-CM codes
  - `year` integer, nullable: Fiscal year version
  - `model_type` string: HCC model: CMS-HCC, RxHCC, HHS-HCC, ESRD
  - `model_version` string: Model version: V24, V28, V06, etc.
  - `payment_year` integer, nullable: Payment year for weights
  - `segment` string: Beneficiary segment for weight lookup

## Response `200`

Successful Response

- object

## Other responses

- `400`: Malformed or out-of-bounds request — a batch over 50 codes, a file over the upload limit, an unparseable identifier, or a surface that is switched off in this environment (the `cpt_*_disabled` gates are 400, not 403). ⚠ Not interchangeable with 422: 400 is raised BY the handler, 422 by request validation.
- `401`: Missing, malformed, revoked or expired credential. Send the key as `X-API-Key` or `Authorization: Bearer`. `detail` is a string, except the MFA challenge on `/auth/login`, which is `{code: 'mfa_required', message}`.
- `403`: Authenticated but not permitted: the tier does not include the feature, the role is insufficient, or the free tier is paused. Gate-specific bodies use the `{code, message}` shape (`tier_required`, `insufficient_role`). ⚠ The free-tier pause is the ONE error in the service that does not use `detail` at all — its body is `{error: 'free_tier_paused', message}` at the top level. ⚠ Preconditions the caller CAN satisfy (no org, no BAA, PHI mode off) are 412, not 403 — see below.
- `404`: Resource, code, or org-scoped record not found. Note that a record belonging to ANOTHER organization is also a 404, never a 403 — existence is not disclosed across tenants.
- `412`: A precondition on the calling principal is unmet and the caller can fix it: no organization linked to the key (`org_required`), no signed BAA (`baa_required`), PHI mode not activated (`phi_not_activated`), reviewer mode off (`review_mode_disabled`), or the session was never second-factored (`mfa_required`). All use the `{code, message}` shape.
- `422`: Request body or query failed validation. FastAPI's own failures are a LIST of `{loc, msg, type}`; semantic refusals raised by the service are an object (the risk-adjustment endpoints use `{status, ...}`).
- `429`: Rate limit, quota or concurrency cap exceeded. The tier limiter, the per-key chart-review job cap, the anonymous demo cap and the auth/signup limiters all land here; only the tier limiter sets the `X-RateLimit-*` headers.
- `500`: Unhandled server error. The body is `{detail: 'Internal server error', request_id: <id>}` and the same id is on the `X-Request-ID` response header.
- `503`: A dependency this request needed is unavailable — the database, an upstream model provider, or reference data that is present but not READY. Retry is reasonable, except for the risk-adjustment `blocked_pack_not_ready` refusals, which stay 503 until the coefficient pack is actually loaded.

---

[API](https://skmtc.dev/accurecord/apis/icd-10-coding-api.md) · [All operations](https://skmtc.dev/accurecord/apis/icd-10-coding-api/llms.txt) · [OpenAPI document](https://skmtc.dev/accurecord/apis/icd-10-coding-api/revisions/b1e12ce06ba5?raw)
