Denial Management

Validate denial document extraction

Validates or dry-runs a denial document extraction request using metadata only; public API callers cannot trigger OCR, LLM extraction, storage writes, queueing, or payer calls through this endpoint.

POSTNeeds publication reviewFile or artifactDenial ManagementoperationId: extractDenialDocumenthttps://dev-api.quickintell.com/api/v1/denial-management/documents/extract

Needs publication reviewFile or artifactClaims and denials

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust 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

File or artifact

Touches documents, reports, transcripts, PDFs, EDI, or generated artifacts. Metadata is safer than raw content.

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 claims and denials contract generated for POST /api/v1/denial-management/documents/extract. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for POST /api/v1/denial-management/documents/extract, but keeps the route out of ordinary production API positioning until review is complete.

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

Raw file contents, storage keys, signed URLs, and generated artifacts are not public from this page.

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	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
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	Not indicated by OpenAPI	No generic polling contract is published from this page.
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	Potential file or artifact	Documents, PDFs, reports, transcripts, EDI, OCR, or generated artifacts need E4 classification before public examples.
Ownership and storage keys	Evidence required	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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Related platform rules

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

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review 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.

Denial Management public API.

Denial Management APIs expose organization-scoped denial case read models, local denial workflow writes, remittance association, draft appeal creation, denial queue routing configuration, explicit case rerouting, and safe document-extraction validation. The bearer API key selects the organization. Public requests should not send `organizationId` as a tenant selector. Read endpoints accept Denial Management read or write scope; mutation endpoints require Denial Management write scope. Referenced denial cases, queues, queue rules, remittances, draft appeals, users, and optional case links must resolve inside the authenticated organization. These endpoints operate on QuickRCM local workflow state. They do not submit appeals to payers, run OCR or LLM extraction, upload files, parse ERA payloads, post payments, adjudicate claims, call clearinghouses, or guarantee denial recovery. Use synthetic examples and keep notes, rule metadata, letter HTML, filenames, and search/filter values free of real PHI, raw EDI, payer portal credentials, tokens, S3 keys, transcripts, and vendor payloads. Iteration 2 adds complete queue-rule action and condition field semantics, common response-field glossary coverage, and PHI-safe synthetic request/response examples for all 10 Denial Management operations.

What this endpoint does

Use case

Use this endpoint to confirm that a planned denial-document extraction request is well formed and optionally tied to an organization-owned denial case before using a separate internal or future ingestion workflow.

Before calling

Authenticate with `denial-management:write`. Provide `fileName`, `fileSizeBytes`, and either `validateOnly` or `dryRun`. If supplying `denialCaseId`, resolve it from the same organization first.

Request and response behavior

Request guidance

`fileName` is required and capped at 255 characters. `fileSizeBytes` is required, must be at least 1 byte, and is capped at 10 MiB. At least one of `validateOnly` or `dryRun` must be true. Do not send file bytes, signed URLs, S3 keys, OCR text, transcripts, raw payer documents, or extracted vendor payloads.

`validateOnly` or `dryRun` is required for API-key callers.
This endpoint accepts metadata only, not multipart upload or binary content.
If both `dryRun` and `validateOnly` are true, the current handler reports `mode: dryRun`.

Response semantics

A 200 response returns `mode`, `extractionPerformed: false`, `queued: false`, the optional denialCaseId, fileName, fileSizeBytes, and `meta.organizationId`. The response is validation evidence only.

`extractionPerformed` is always false in the public response schema.
`queued` is always false in the public response schema.
`mode` is `dryRun` when dryRun is true; otherwise it is `validateOnly`.

Errors and retries

A 400 is expected when neither validateOnly nor dryRun is true, when file metadata is invalid, or when limits are exceeded. A 404 means the supplied denialCaseId does not resolve in the authenticated organization. Retrying unchanged will not perform extraction.

400 can mean missing safety flag, invalid filename, or file size outside 1 byte through 10 MiB.
404 can mean the optional denialCaseId is missing or outside the authenticated organization.
Do not describe retries as eventually performing OCR; this public endpoint is validation-only/dry-run.

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

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
denialCaseId	body	No	string	Optional QuickRCM DenialCase identifier to validate against the authenticated organization.	Minimum length: 1.
fileName	body	Yes	string	Required display filename for the planned denial document. Keep examples synthetic and avoid PHI in filenames.	Minimum length: 1. Maximum length: 255. File, artifact, or raw-payload adjacent; keep examples metadata-only.
fileSizeBytes	body	Yes	integer	Required planned file size in bytes. The public schema allows 1 through 10485760 bytes.	Minimum value: 1. Maximum value: 10485760. File, artifact, or raw-payload adjacent; keep examples metadata-only.
validateOnly	body	No	boolean	Safety flag indicating that the request should only be validated.	OpenAPI does not declare additional validation metadata.
dryRun	body	No	boolean	Safety flag indicating that the request should be simulated without extraction or queueing.	OpenAPI does not declare additional validation metadata.

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.

{
  "fileName": "Example extract_denial_document",
  "fileSizeBytes": 1,
  "denialCaseId": "00000000-0000-4000-8000-000000000001",
  "validateOnly": true,
  "dryRun": true
}

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

Extraction request validated without external processing

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "validateOnly",
    "extractionPerformed": false,
    "queued": false,
    "denialCaseId": "00000000-0000-4000-8000-000000000001",
    "fileName": "Example extract_denial_document",
    "fileSizeBytes": 1
  },
  "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