Prevention

List prevention alerts

Lists prevention claim-creation alerts owned by the authenticated organization, with filters for lifecycle status, severity, alert type, claim, claim line, user, created date range, and pagination.

GETPublic reference baselineRead-onlyPreventionoperationId: listPreventionAlertshttps://dev-api.quickintell.com/api/v1/prevention/alerts

Public reference baselineRead-onlyAgent 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.

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

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

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 GET /api/v1/prevention/alerts. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated GET /api/v1/prevention/alerts contract as a read-only baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.

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	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
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.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness

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 to populate a prevention alert inbox, reconcile active warnings for claim review, or retrieve dismissed and acknowledged alerts for audit workflows.

Before calling

Authenticate with a Prevention read or write scope. Decide whether to filter by `status`, `severity`, `alertType`, claim context, user, and `startDate`/`endDate`; broad alert lists can expose claim-adjacent operational context.

Request and response behavior

Request guidance

Use `take` between 1 and 100 and `skip` between 0 and 10000. `startDate` and `endDate` must be ISO date-time strings. Do not send `organizationId`; the API key selects the tenant.

`status` is one of the source-backed lifecycle values: `ACTIVE`, `ACKNOWLEDGED`, `DISMISSED`, `RESOLVED`, or `EXPIRED`.
`severity` is one of `LOW`, `MEDIUM`, `HIGH`, or `CRITICAL`.
`take` defaults to 25 and is capped at 100.

Response semantics

HTTP 200 returns `data.alerts`, `total`, `skip`, and `take`. Each alert includes local prevention status, severity, title, message, suggested action, decimal strings for estimated risk and historical denial rate when present, and a sanitized claim summary with payer identifiers. It does not include patient demographics or raw claim payloads.

`estimatedRiskAmount` and `historicalDenialRate` are decimal strings or null, not floating-point numbers.
`status` is derived from `wasActedUpon`, `wasDismissed`, `acknowledgedAt`, `dismissedAt`, `resolvedAt`, and `dueAt`.
`claim` is nullable and only contains the sanitized claim id, status, claim control number, and payer summary.
Use alert action or dismissal endpoints to change alert workflow state.

Errors and retries

Treat 400 as invalid filters, 401/403 as credential or scope issues, and 429 as rate limiting that requires backoff. Retry transient 5xx failures after checking whether the client already has a fresh page.

403 means the API key lacks Prevention read/write scope.
Do not retry malformed date-time or pagination parameters unchanged.

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

This endpoint does not define path parameters.

Query parameters

Name	Location	Required	Type	Description	Validation and safety notes
status	query	No	ACTIVE \| ACKNOWLEDGED \| DISMISSED \| RESOLVED \| EXPIRED	Optional alert lifecycle filter from source constants: `ACTIVE`, `ACKNOWLEDGED`, `DISMISSED`, `RESOLVED`, or `EXPIRED`. `EXPIRED` means the alert is past `dueAt` and is not dismissed or resolved.	Enum values are declared in the Type column.
severity	query	No	LOW \| MEDIUM \| HIGH \| CRITICAL	Optional alert severity filter from `LOW`, `MEDIUM`, `HIGH`, or `CRITICAL`.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.
alertType	query	No	string	Organization-local alert classification such as a pre-submission scrub or claim creation warning.	Minimum length: 1. Maximum length: 128.
claimId	query	No	string	QuickRCM claim identifier used to filter alerts. The claim must belong to the API key organization.	Minimum length: 1. Maximum length: 128. Sensitive credential or storage-adjacent value; use placeholders only.
claimLineId	query	No	string	Optional claim line identifier used to filter line-specific prevention alerts.	Minimum length: 1. Maximum length: 128.
userId	query	No	string	QuickRCM user identifier associated with the alert.	Minimum length: 1. Maximum length: 128.
startDate	query	No	string (date-time)	Inclusive created-at lower bound as an ISO date-time string.	Format: date-time.
endDate	query	No	string (date-time)	Inclusive created-at upper bound as an ISO date-time string.	Format: date-time.
skip	query	No	integer	Number of records to skip for pagination. Use with take when the endpoint exposes skip/take pagination.	Minimum value: 0. Maximum value: 10000. Default: 0.
take	query	No	integer	Maximum number of records to take for skip/take pagination.	Minimum value: 1. Maximum value: 100. Default: 25.

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.

This endpoint does not define a JSON request body.

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.

No request example is declared.

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 alert list

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "alerts": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "claimId": "00000000-0000-4000-8000-000000000001",
        "claimLineId": "00000000-0000-4000-8000-000000000001",
        "userId": "00000000-0000-4000-8000-000000000001",
        "alertType": "example-alerttype",
        "triggerSource": "example-triggersource",
        "severity": "LOW",
        "status": "ACTIVE",
        "title": "Example prevention_alert",
        "message": "Request failed",
        "suggestedAction": "example-suggestedaction",
        "estimatedRiskAmount": "example-estimatedriskamount",
        "historicalDenialRate": "example-historicaldenialrate",
        "wasActedUpon": true,
        "actionTaken": "example-actiontaken",
        "wasDismissed": true,
        "dismissReason": "example-dismissreason",
        "acknowledgedAt": "2026-06-08T10:15:30Z",
        "dismissedAt": "2026-06-08T10:15:30Z",
        "resolvedAt": "2026-06-08T10:15:30Z",
        "ownerUserId": "00000000-0000-4000-8000-000000000001",
        "dueAt": "2026-06-08T10:15:30Z",
        "resolutionCode": "example-resolutioncode",
        "createdAt": "2026-06-08T10:15:30Z",
        "claim": {
          "id": "00000000-0000-4000-8000-000000000001",
          "status": "active",
          "claimControlNumber": "example-claimcontrolnumber",
          "payer": {
            "id": "00000000-0000-4000-8000-000000000001",
            "payerId": "87726",
            "name": "Example prevention_alert"
          }
        }
      }
    ],
    "total": 1,
    "skip": 1,
    "take": 1
  }
}

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