Prior Authorization

Create prior authorization appeal

Creates a local appeal for a denied prior authorization in the authenticated organization.

POSTNeeds publication reviewLocal writePrior AuthorizationoperationId: createPriorAuthAppealhttps://dev-api.quickintell.com/api/v1/prior-auth/authorizations/{priorAuthId}/appeals

Needs publication reviewLocal writePrior auth and clinical

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 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/prior-auth/authorizations/{priorAuthId}/appeals. 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/prior-auth/authorizations/{priorAuthId}/appeals, 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

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

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

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.

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	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.

Prior Authorization public API.

Prior Authorization APIs expose organization-scoped requirement checks, case creation and maintenance, draft saves, status transitions, renewals, local appeal tracking, bulk workflow queueing, bulk-upload batch status, and supporting-document upload setup for the tenant selected by the bearer API key. The public reference should be explicit about side effects. Requirement checks return decision-support fields and do not create authorization cases. Case create/update/status/submit endpoints return sanitized QuickRCM prior authorization summaries, not payer approvals or denials. Renewal and appeal endpoints create or update local workflow records. Bulk authorization submissions and bulk-upload batches are queue-oriented public workflows. Document submission endpoints are public validation surfaces that require `dryRun: true`; the OpenAPI descriptions state vendor submission is skipped. The current draft-save OpenAPI request schema is an `allOf` body with the create-case request fields plus optional `priorAuthId`; documentation should not imply that draft save has an empty or undocumented body. If the final docs want partial-draft behavior, the public schema must be expanded or clarified first. These endpoints can carry PHI or sensitive operational data in patient names, dates of birth, MRNs, member IDs, clinical indications, medical-necessity letters, appeal letters, document metadata, presigned upload URLs, and storage object keys. Public examples should be synthetic, and docs should tell callers not to log raw request bodies, upload URLs, S3 keys, payer portal credentials, raw EDI, transcripts, tokens, or vendor payloads. For `createPriorAuth` and `savePriorAuthDraft`, the generated OpenAPI body shows `payerId` and `payerName` as individually optional, but the public contract enforces a cross-field rule: callers must provide at least one of them. The handler uses `payerName` when supplied, attempts to resolve known payer IDs, and can return 400 asking for an explicit `payerName` when a supplied `payerId` cannot be resolved.

What this endpoint does

Use case

Use this when a denied prior authorization needs appeal tracking, appeal reason capture, optional appeal-letter text, and optional peer-to-peer request tracking.

Before calling

Confirm the source prior authorization belongs to the tenant and is denied. Prepare `appealLevel`, `appealType`, and a sanitized `appealReason`. If using `idempotencyKey`, treat it as a caller-provided request marker, not a documented deduplication guarantee.

Request and response behavior

Request guidance

`appealLevel`, `appealType`, and `appealReason` are required. `appealLetter`, `p2pRequested`, and `idempotencyKey` are optional. Keep appeal text clinically necessary and free of raw payer payloads, transcripts, credentials, and storage secrets.

`appealLevel` must be one of `PA_FIRST_LEVEL`, `PA_SECOND_LEVEL`, `PA_EXTERNAL_REVIEW`, or `PA_STATE_HEARING`.
`appealType` must be one of the PA appeal type enum values exposed by the schema.
`appealLetter` is capped at 50000 characters and can contain PHI.
`idempotencyKey` is optional and should be free of PHI; OpenAPI does not define server-side deduplication behavior.

Response semantics

HTTP 201 returns `data.appeal`, a local QuickRCM prior authorization appeal record. It does not prove external appeal submission, peer-to-peer scheduling, or payer overturn.

`data.appeal` is local tracking state.
Peer-to-peer fields are tracking fields, not evidence that a payer scheduled a call.
Use updatePriorAuthAppeal to record later status, P2P, or decision outcomes.

Errors and retries

Treat 409 as the documented signal that an active appeal already exists, 400 as invalid appeal fields, 401/403 as credential or tenant failures, 429 as a backoff signal, and 5xx as transient only with bounded retries. After timeouts, re-read local appeals before creating another appeal.

409 is declared as `An active appeal already exists`.
400 can indicate invalid appeal enum values or missing appeal reason.
Do not create duplicate appeals after a lost response without checking local state.

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
priorAuthId	path	Yes	string	QuickRCM prior authorization case identifier in the path. It must resolve inside the authenticated organization and be eligible for local appeal creation.	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
appealLevel	body	Yes	PA_FIRST_LEVEL \| PA_SECOND_LEVEL \| PA_EXTERNAL_REVIEW \| PA_STATE_HEARING	Required appeal level enum: first level, second level, external review, or state hearing.	Enum values are declared in the Type column.
appealType	body	Yes	PA_APPEAL_MEDICAL_NECESSITY \| PA_APPEAL_CODING_ERROR \| PA_APPEAL_MISSING_INFO_RESUBMIT \| PA_APPEAL_CLINICAL_REVIEW \| PA_APPEAL_ADMIN_ERROR	Required appeal category enum explaining why the denial is being challenged.	Enum values are declared in the Type column.
appealReason	body	Yes	string	Required appeal reason text capped at 5000 characters. Keep it clinically relevant and sanitized.	Minimum length: 1. Maximum length: 5000. Potential PHI; use synthetic examples and avoid logging raw values.
appealLetter	body	No	string	Optional appeal letter text capped at 50000 characters. Do not include raw payer payloads or transcripts.	Minimum length: 1. Maximum length: 50000. File, artifact, or raw-payload adjacent; keep examples metadata-only.
p2pRequested	body	No	boolean	Optional flag indicating whether peer-to-peer review is requested for local tracking.	OpenAPI does not declare additional validation metadata.
idempotencyKey	body	No	string	Optional caller-provided request marker capped at 200 characters and free of PHI. Do not document it as a deduplication guarantee.	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.

{
  "appealLevel": "PA_FIRST_LEVEL",
  "appealType": "PA_APPEAL_MEDICAL_NECESSITY",
  "appealReason": "example-appealreason",
  "appealLetter": "example-appealletter",
  "p2pRequested": 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.

201

Created prior authorization appeal.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "appeal": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "priorAuthId": "00000000-0000-4000-8000-000000000001",
      "appealLevel": "example-appeallevel",
      "appealType": "example-appealtype",
      "status": "active",
      "denialDate": "2026-06-08T10:15:30Z",
      "appealDeadline": "2026-06-08T10:15:30Z",
      "submittedAt": "2026-06-08T10:15:30Z",
      "decidedAt": "2026-06-08T10:15:30Z",
      "appealReason": "example-appealreason",
      "p2pRequested": true,
      "p2pScheduledAt": "2026-06-08T10:15:30Z",
      "p2pCompletedAt": "2026-06-08T10:15:30Z",
      "p2pOutcome": "example-p2poutcome",
      "decisionOutcome": "example-decisionoutcome",
      "decisionReason": "example-decisionreason",
      "newAuthNumber": "example-newauthnumber",
      "newExpirationDate": "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.