Prior Authorization

Save prior authorization draft

Creates or updates a draft prior authorization for the authenticated organization according to the public operation description.

POSTNeeds publication reviewLocal writePrior AuthorizationoperationId: savePriorAuthDrafthttps://dev-api.quickintell.com/api/v1/prior-auth/authorizations/drafts

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/drafts. 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/drafts, 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	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	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 for draft-save flows that need to create or update a local prior authorization draft using the request fields exposed by the public schema. For finalized case creation semantics, use `createPriorAuth`.

Before calling

Confirm the caller has Prior Authorization access. Prepare the same required create-case fields exposed by the `allOf` request schema, including the cross-field payer rule: provide either `payerId` or `payerName`. Include `payerName` when a supplied payer ID may not resolve, and include `priorAuthId` only when updating a trusted draft or case from the same tenant.

Request and response behavior

Request guidance

The current OpenAPI body is an `allOf` schema containing the create prior authorization request fields plus optional `priorAuthId`. Required fields mirror the create-case schema: `patientFirstName`, `patientLastName`, `patientDOB`, `serviceType`, `specificService`, `cptCode`, `diagnosisCode`, and `orderingPhysician`, and the public contract additionally requires at least one of `payerId` or `payerName`. Keep clinical, payer, requirement-check, and metadata fields sanitized.

The public schema exposes named draft fields through an `allOf` body, not an empty object.
Use `priorAuthId` only for a trusted same-tenant draft/update target.
Keep draft content PHI-minimal and sanitized; do not include raw payer payloads, upload URLs, tokens, or credentials.
The draft-save body inherits the create-case payer rule: provide `payerId` or `payerName`, and provide `payerName` explicitly when payer ID lookup may not resolve.

Response semantics

HTTP 200 returns `data.priorAuth`, a saved local draft case summary. It is not payer submission, approval, denial, or receipt.

`data.priorAuth` is local draft state.
The endpoint does not submit the case externally.
Use submitPriorAuth when the case is ready for submission workflow.

Errors and retries

Treat 402 as insufficient credits, 400 as invalid draft request shape, 401/403 as credential or tenant authorization failures, 429 as a backoff signal, and 500 as transient only with bounded retries. Re-read or search current draft state after timeouts before sending another draft-save request.

402 is declared for insufficient credits.
400 can indicate missing required create-style fields or unsupported request shape.
After a lost response, reconcile current draft state before sending another draft-save request.

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
patientFirstName	body	Yes	string	Required patient first name for the draft. Use synthetic values in examples.	Minimum length: 1. Maximum length: 100. Potential PHI; use synthetic examples and avoid logging raw values.
patientLastName	body	Yes	string	Required patient last name for the draft. Use synthetic values in examples.	Minimum length: 1. Maximum length: 100. Potential PHI; use synthetic examples and avoid logging raw values.
patientDOB	body	Yes	string	Required patient date of birth as YYYY-MM-DD or another ISO date string.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
mrn	body	No	string	Optional medical record number. Treat as patient-identifying data.	Minimum length: 1. Maximum length: 120. Potential PHI; use synthetic examples and avoid logging raw values.
appointmentId	body	No	string	Optional QuickRCM appointment identifier to link the draft to a scheduled encounter.	Minimum length: 1.
serviceType	body	Yes	IMAGING \| SURGERY \| THERAPY \| DME \| MEDICATION \| imaging \| surgery \| therapy \| dme \| medication \| imaging-xray \| imaging-lab \| imaging-mri \| imaging-pet \| surgery-oral \| surgery-periodontal \| surgery-anesthesia \| surgery-assistance \| therapy-radiation \| therapy-inhalation \| therapy-chemotherapy \| therapy-dialysis \| dme-purchased \| dme-rental \| dme-prosthetics \| dme-hearing \| dme-oxygen \| medication-brand \| medication-generic \| medication-mail-order	Required service category or detailed service family enum from the public schema.	Enum values are declared in the Type column.
specificService	body	Yes	string	Required human-readable service description, capped at 250 characters.	Minimum length: 1. Maximum length: 250.
cptCode	body	Yes	string	Required CPT or procedure code, capped at 40 characters.	Minimum length: 1. Maximum length: 40.
diagnosisCode	body	Yes	string	Required diagnosis code, capped at 40 characters.	Minimum length: 1. Maximum length: 40. Potential PHI; use synthetic examples and avoid logging raw values.
diagnosisDescription	body	No	string	Optional diagnosis description, capped at 500 characters.	Minimum length: 1. Maximum length: 500. Potential PHI; use synthetic examples and avoid logging raw values.
orderingPhysician	body	Yes	string	Required ordering physician name or display label, capped at 200 characters.	Minimum length: 1. Maximum length: 200.
orderingPhysicianNPI	body	No	string	Optional ordering physician National Provider Identifier, capped at 20 characters.	Minimum length: 1. Maximum length: 20.
clinicalIndication	body	No	string	Optional clinical rationale, capped at 5000 characters. Avoid raw transcripts.	Minimum length: 1. Maximum length: 5000. Potential PHI; use synthetic examples and avoid logging raw values.
payerId	body	No	string	Conditionally required payer identifier when `payerName` is omitted, capped at 120 characters. Because draft save reuses the create-case schema, omitting both payer fields fails validation.	Minimum length: 1. Maximum length: 120.
payerName	body	No	string	Conditionally required payer display name when `payerId` is omitted or may not resolve, capped at 200 characters. Use synthetic payer names in examples.	Minimum length: 1. Maximum length: 200.
memberId	body	No	string	Optional payer member or subscriber identifier, capped at 120 characters. Treat as PHI-adjacent.	Minimum length: 1. Maximum length: 120. Potential PHI; use synthetic examples and avoid logging raw values.
placeOfService	body	No	string	Optional place-of-service label or description, capped at 120 characters.	Minimum length: 1. Maximum length: 120.
placeOfServiceCode	body	No	string	Optional short place-of-service code, capped at 10 characters.	Minimum length: 1. Maximum length: 10.
urgency	body	No	boolean	Optional boolean indicating urgent local workflow handling.	OpenAPI does not declare additional validation metadata.
isAuthRequiredResult	body	No	boolean	Optional copied boolean result from a prior-auth requirement check.	OpenAPI does not declare additional validation metadata.
isAuthRequiredPolicyName	body	No	string	Optional policy name copied from a requirement check, capped at 250 characters.	Minimum length: 1. Maximum length: 250.
isAuthRequiredPolicyDescription	body	No	string	Optional policy description copied from a requirement check, capped at 2000 characters.	Minimum length: 1. Maximum length: 2000.
isAuthRequiredRequirements	body	No	unknown	Optional structured requirements copied from a requirement check. Do not include raw payer payloads.	OpenAPI does not declare additional validation metadata.
isAuthRequiredEvidenceSufficiency	body	No	unknown	Optional structured evidence-sufficiency object copied from a requirement check.	OpenAPI does not declare additional validation metadata.
requirements	body	No	unknown	Optional structured draft requirements object. Keep it sanitized.	OpenAPI does not declare additional validation metadata.
metadata	body	No	object	Optional integration metadata object. Do not include credentials, tokens, raw EDI, upload URLs, or storage secrets.	Sensitive credential or storage-adjacent value; use placeholders only.
priorAuthId	body	No	string	Optional QuickRCM prior authorization identifier when updating an existing local draft or case in the authenticated organization.	Minimum length: 1.

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.

{
  "patientFirstName": "Example save_prior_auth_draft",
  "patientLastName": "Example save_prior_auth_draft",
  "patientDOB": "1984-03-22",
  "serviceType": "IMAGING",
  "specificService": "example-specificservice",
  "cptCode": "example-cptcode",
  "diagnosisCode": "example-diagnosiscode",
  "orderingPhysician": "example-orderingphysician",
  "mrn": "example-mrn",
  "appointmentId": "00000000-0000-4000-8000-000000000001",
  "diagnosisDescription": "Example save_prior_auth_draft note",
  "orderingPhysicianNPI": "1234567893",
  "clinicalIndication": "example-clinicalindication",
  "payerId": "87726",
  "payerName": "Example save_prior_auth_draft",
  "memberId": "W123456789",
  "priorAuthId": "00000000-0000-4000-8000-000000000001"
}

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

Saved prior authorization draft.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "priorAuth": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "caseId": "00000000-0000-4000-8000-000000000001",
      "status": "active",
      "patientId": "00000000-0000-4000-8000-000000000001",
      "appointmentId": "00000000-0000-4000-8000-000000000001",
      "urgency": true,
      "serviceType": "30",
      "specificService": "example-specificservice",
      "cptCode": "example-cptcode",
      "diagnosisCode": "example-diagnosiscode",
      "diagnosisDescription": "Example save_prior_auth_draft note",
      "orderingPhysician": "example-orderingphysician",
      "orderingPhysicianNPI": "1234567893",
      "payerId": "87726",
      "payerName": "Example save_prior_auth_draft",
      "memberId": "W123456789",
      "authorizationNumber": "example-authorizationnumber",
      "submittedAt": "2026-06-08T10:15:30Z",
      "approvedAt": "2026-06-08T10:15:30Z",
      "deniedAt": "2026-06-08T10:15:30Z",
      "denialReason": "example-denialreason",
      "expirationDate": "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.