Risk Adjustment

Cancel risk adjustment job

Cancels an active queued or processing risk adjustment job in the authenticated organization.

POSTPublic reference baselineLocal writeRisk AdjustmentoperationId: cancelRiskAdjustmentJobhttps://dev-api.quickintell.com/api/v1/risk-adjustment/jobs/{jobId}/cancel

Public reference baselineLocal writePrior auth and clinical

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the prior auth and clinical contract generated for POST /api/v1/risk-adjustment/jobs/{jobId}/cancel. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated POST /api/v1/risk-adjustment/jobs/{jobId}/cancel contract as a local write baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	Request body exposes an endpoint-specific idempotencyKey compatibility field.	Retry only with the documented key location and after checking endpoint state; 409 behavior and retention still need release evidence.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Risk Adjustment public API.

Risk Adjustment APIs expose organization-scoped job workflow controls for patient-document risk adjustment processing and human review of Hierarchical Condition Category (HCC) code results. HCC outputs contribute to Risk Adjustment Factor (RAF) score fields, but the bearer API key selects the organization; public callers should not send an `organizationId` selector in these requests. All referenced jobs, patients, files, appointments, and HCC code review targets must belong to the authenticated organization. The public surface is job-oriented and asynchronous. Create, bulk-create, and reprocess endpoints validate local QuickRCM references and either return validation output or queue local work; the OpenAPI descriptions state that public callers do not directly invoke optical character recognition (OCR) or artificial intelligence (AI) processing. Read endpoints return sanitized job summaries, HCC result summaries, and a limited patient-summary object. They do not expose raw document chunks, raw evidence text, clinical note text, transcripts, raw electronic health record (EHR) payloads, raw payer payloads, signed storage URLs, review notes, protected health information (PHI) beyond the minimum documented identifiers, or raw electronic data interchange (EDI) payloads. These endpoints do not submit diagnoses to the Centers for Medicare & Medicaid Services (CMS), send Risk Adjustment Processing System (RAPS) files, send Encounter Data Processing System (EDPS) files, adjudicate claims, update a payer portal, write back to an EHR, or certify final RAF/HCC accuracy. Use `reviewRiskAdjustmentHccCode` only to record a human decision for one HCC code. Treat `finalizedRafScore` and review fields as downstream workflow inputs only when the job state actually includes them and required review has completed. Diagnosis code fields use International Classification of Diseases, 10th Revision (ICD-10) code values where the response schema names them.

What this endpoint does

Use case

Use this when a queued or in-progress risk adjustment job should no longer proceed because the source file, patient linkage, or workflow request was incorrect or no longer needed.

Before calling

Authenticate with `risk-adjustment:write`. Confirm the job is the intended active workflow and belongs to the authenticated organization. Preserve cancellation rationale in the calling system if needed; the public request schema does not define a reason field.

Request and response behavior

Request guidance

Pass `jobId` in the path. The optional JSON body supports `validateOnly`, `queueOnly`, and `idempotencyKey`; no cancellation reason field is documented. `validateOnly: true` checks whether the job can be cancelled without applying cancellation. Do not send raw clinical details or document contents in the body.

`jobId` is required in the path.
The documented body contains only safety/idempotency flags.
Do not document a cancellation reason request field unless the OpenAPI schema adds one.

Response semantics

HTTP 200 returns either validation-only output or the updated local job summary with status `CANCELLED`. Cancellation is local QuickRCM workflow state; it does not retract a CMS submission, payer communication, EHR write-back, or claim.

Use the returned job status, when present, as the source of truth for local workflow state.
No HCC evidence, raw document text, or external cancellation receipt is returned.
A 200 response is not an external transaction reversal.

Errors and retries

Treat 404 as tenant-scoped not found. Invalid lifecycle state currently returns 400, not 409; document it as an invalid request/state for this endpoint. 402 and 409 are declared common responses, but cancellation should not be described as a normal credit-consuming workflow or duplicate-job conflict. Retrying a cancellation after timeout is usually safe only after reading the job state again.

400 can indicate the job is not in a cancellable state such as `PENDING`, `INGESTING`, `CHUNKING`, `TIER1_PROCESSING`, `ROUTING`, `TIER2_PROCESSING`, or `AGGREGATING`.
404 means the job is not visible in the authenticated organization.
401/403 require credential or permission correction before retrying.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

Name	Location	Required	Type	Description	Validation and safety notes
jobId	path	Yes	string	QuickRCM risk adjustment job identifier to cancel.	Minimum length: 1.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
validateOnly	body	No	boolean	Optional flag to validate cancellation eligibility without applying it.	Default: false.
queueOnly	body	No	boolean	Optional safety flag exposed by the shared workflow request shape.	Default: true.
idempotencyKey	body	No	string	Optional caller-provided key capped at 200 characters.	Minimum length: 1. Maximum length: 200. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "validateOnly": false,
  "queueOnly": true,
  "idempotencyKey": "example-idempotencykey"
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Risk adjustment job cancelled.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "queued": true,
    "queueOnly": true,
    "valid": true,
    "estimatedCredits": 1,
    "job": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "patientId": "00000000-0000-4000-8000-000000000001",
      "fileId": "00000000-0000-4000-8000-000000000001",
      "appointmentId": "00000000-0000-4000-8000-000000000001",
      "status": "PENDING",
      "currentStage": "example-currentstage",
      "progress": 1,
      "totalPages": 1,
      "totalChunks": 1,
      "relevantChunks": 1,
      "tier1AcceptedChunks": 1,
      "tier2EscalatedChunks": 1,
      "discardedChunks": 1,
      "totalConditions": 1,
      "confirmedHccCodes": 1,
      "rafScore": 1.25,
      "totalCostUsd": 1,
      "creditsCost": 1,
      "requiresHumanReview": true,
      "humanReviewCompleted": true,
      "finalizedRafScore": 1.25,
      "startedAt": "2026-06-08T10:15:30Z",
      "completedAt": "2026-06-08T10:15:30Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.