Prevention

Queue a prevention claim scrub

Validates an organization-owned claim and either validates, simulates, or queues a local prevention scrub work item.

POSTPublic reference baselineQueue or asyncPreventionoperationId: scrubPreventionClaimhttps://dev-api.quickintell.com/api/v1/prevention/claims/{claimId}/scrub

Public reference baselineQueue or asyncAgent Builder and Prevention

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 and E3 async and idempotency 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

Queue or async

May return queued work or HTTP 202. Queueing is not completion, and terminal job semantics are endpoint-specific.

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 agent builder and prevention contract generated for POST /api/v1/prevention/claims/{claimId}/scrub. 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/prevention/claims/{claimId}/scrub contract as a queue or async 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	202	Treat the response as accepted or queued work, not completed workflow execution.
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	Possible	Queued work may later cause local or external effects only where endpoint evidence says so.

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

HTTP 202 or queued behavior requires endpoint-specific polling, terminal-state, retry, and retention guidance.
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 Async Jobs

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.

Prevention public API.

Prevention APIs expose organization-scoped public endpoints for claim pre-submission scrub queueing, denial-risk prediction queueing, prevention alert review, finding resolution, controlled auto-fix preview/application/revert, prevention rule lifecycle management, prediction feedback, provider education workflow, and learned payer-rule promotion. The bearer API key selects the organization. Public callers should not send an `organizationId` selector. List and detail reads accept Prevention read or write scope; every mutation requires Prevention write scope. Referenced claims, claim lines, findings, predictions, rules, alerts, payer profiles, providers, education records, and auto-fix runs must belong to the authenticated organization. organizationId`; generated schema leaves `data` open-ended for several workflow endpoints, so endpoint examples should be treated as illustrative current handler behavior while the stable top-level envelope remains consistent. Alert list/detail and alert acknowledge endpoints return explicit alert objects. Public scrub, batch scrub, prediction, and education generation endpoints are safe local workflows: `validateOnly` returns validation-only output, `dryRun` simulates without queueing, and `queueOnly` creates or reuses local work items where the handler supports queueing. These endpoints do not return payer acceptances, raw electronic data interchange (EDI), raw payer payloads, live large language model (LLM) output, or external dispatch evidence. Use only synthetic examples in public documentation. Alert and education text can contain operational context, so examples and guidance should avoid real protected health information (PHI), credentials, tokens, raw EDI, transcripts, S3 keys, payer portal credentials, vendor payloads, or patient demographic details. Safe-workflow request bodies may accept unknown passthrough properties at validation time, but those properties are not part of the public API contract. Do not use extra properties to send protected health information (PHI), raw claim payloads, raw electronic data interchange (EDI), vendor payloads, credentials, tokens, or payer portal details.

What this endpoint does

Use case

Use this endpoint when an external workflow wants QuickRCM to prepare a claim for pre-submission prevention review without calling a payer or external system.

Before calling

Authenticate with Prevention write scope. Use a `claimId` from the same organization and decide whether the request should be `validateOnly`, `dryRun`, or queued.

Request and response behavior

Request guidance

Safe-mode precedence is `validateOnly` first, then `dryRun`, otherwise `queueOnly`. In queue mode the current handler creates or reuses a `PENDING_SCRUB` PreventionWorkItem. Reuse `idempotencyKey` only for the same claim and same logical retry.

`queueOnly` defaults to true.
`validateOnly` wins over `dryRun` if both are true.
`idempotencyKey` is capped at 200 characters and is matched against existing public work item metadata in queue mode.
Passthrough body properties are not documented public contract fields and must not carry PHI, raw claim payloads, raw EDI, vendor payloads, credentials, or tokens.

Response semantics

HTTP 200 returns a workflow result. `VALIDATED` means no work item was queued; `QUEUED` means a local work item was created or reused. `externalDispatch` is false and no payer or large language model (LLM) output is returned.

`mode` echoes `validateOnly`, `dryRun`, or `queueOnly`.
`workItemId` and `idempotentReplay` are present when queue mode creates or reuses a work item.
`externalDispatch` is false.

Errors and retries

Fix 400 validation errors before retrying. Treat 404 as missing or wrong-organization claim. If queue mode times out, retry with the same `idempotencyKey` to reuse an existing matching work item when present.

404 means the claim did not resolve in the API key organization.
429 requires backoff and a safe retry strategy.

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
claimId	path	Yes	string	QuickRCM claim identifier in the path. The claim must belong to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

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
queueOnly	body	No	boolean	Default true. When no higher-precedence safety flag is set, queues a local `PENDING_SCRUB` work item.	Default: true.
validateOnly	body	No	boolean	Highest-precedence safety flag. Validates ownership and request shape without queueing.	Default: false.
dryRun	body	No	boolean	Second-precedence safety flag. Simulates the request without queueing.	Default: false.
idempotencyKey	body	No	string	Caller retry key used in queue mode to find an existing matching public work item. Do not include protected health information (PHI).	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.

{
  "queueOnly": true,
  "validateOnly": false,
  "dryRun": false,
  "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

Prevention workflow result

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {},
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

202

Prevention workflow accepted for async processing

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {},
  "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