Prior Authorization

Get canonical or mapped prior authorization result

Default view=canonical. Use view=mapped for data.data.rows. HTTP 202 means worker processing; HTTP 200 can include a payer A4 pending decision. Inspect ok, outcome, errors and warnings. Never automatically resubmit a needs_review case.

GETNeeds publication reviewExternal or credentialedPrior AuthorizationoperationId: getPriorAuthResulthttps://dev-api.quickintell.com/api/v1/prior-auth/authorizations/{priorAuthId}/result
Needs publication reviewExternal or credentialedPrior 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, E3 async and idempotency policy, 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

External or credentialed

May touch credentials, webhooks, SFTP, EHRs, payers, portals, clearinghouses, or other external systems.

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 GET /api/v1/prior-auth/authorizations/{priorAuthId}/result. 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 GET /api/v1/prior-auth/authorizations/{priorAuthId}/result, 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.

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.

HeaderRequiredCurrent statusNotes
AuthorizationYesCurrentBearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-KeyNoTarget/futureDo not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-IdNoTarget/futureUse 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.

TopicStatusGuidance
Current idempotencyRead request; no mutation idempotency contract needed.Use ordinary safe-read retry behavior with rate-limit backoff.
Universal headerNot declaredDo not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behaviorUnresolvedSame-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.

TopicStatusGuidance
Immediate response202Treat the response as accepted or queued work, not completed workflow execution.
Polling and terminal statesEndpoint-specificUse only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
Later side effectsPossibleQueued 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.

TopicStatusGuidance
Content classNo file/artifact class inferredOpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keysNot applicable unless a file field is presentTenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retentionUnresolved unless endpoint-specific evidence existsShort-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.
  • HTTP 202 or queued behavior requires endpoint-specific polling, terminal-state, retry, and retention guidance.
  • External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Evidence

EvidenceStatusCaveat
OpenAPI artifactdocs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.Generated baseline contract only.
Route registryNeeds publication review from documentation classification overlay.E6 route registry evidence is still required before external publication.
Example validationGenerated examples are internal baseline aids.No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewedImplementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.Refresh this evidence for release workspaces.
Release evidenceE9 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.

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

NameLocationRequiredTypeDescriptionValidation and safety notes
priorAuthIdpathYesstringQuickRCM prior authorization case identifier scoped to the authenticated organization.Minimum length: 1.

Query parameters

NameLocationRequiredTypeDescriptionValidation and safety notes
viewqueryNocanonical | mappedOpenAPI description is missing; publication gap.Enum values are declared in the Type column.

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
Processed result; inspect payer outcome and errors.
Generated from the OpenAPI response schema.
{
  "ok": true,
  "outcome": "example-outcome",
  "errors": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "warnings": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "meta": {
    "inquiryId": "00000000-0000-4000-8000-000000000001",
    "priorAuthId": "00000000-0000-4000-8000-000000000001",
    "processingState": "example-processingstate",
    "errorCode": "example-errorcode",
    "mappingProfileId": "00000000-0000-4000-8000-000000000001",
    "mappingProfileVersion": 1.25,
    "verified_by_quickintell": true
  },
  "data": "example-data"
}
202
Queued or processing.
Generated from the OpenAPI response schema.
{
  "ok": true,
  "outcome": "example-outcome",
  "errors": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "warnings": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "meta": {
    "inquiryId": "00000000-0000-4000-8000-000000000001",
    "priorAuthId": "00000000-0000-4000-8000-000000000001",
    "processingState": "example-processingstate",
    "errorCode": "example-errorcode",
    "mappingProfileId": "00000000-0000-4000-8000-000000000001",
    "mappingProfileVersion": 1.25,
    "verified_by_quickintell": true
  },
  "data": "example-data"
}

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.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Request validation failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}
401
Authentication required.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Authentication required",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}
403
Access denied.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "FORBIDDEN",
      "message": "Forbidden",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}
404
Case not found.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "NOT_FOUND",
      "message": "Resource not found",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}
409
Needs review or no pinned mapping profile.
Handle this response as normal integration control flow.
{
  "ok": true,
  "outcome": "example-outcome",
  "errors": [
    {
      "code": "CONFLICT",
      "message": "Resource conflict",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "warnings": [
    {
      "code": "CONFLICT",
      "message": "Resource conflict",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "meta": {
    "inquiryId": "00000000-0000-4000-8000-000000000001",
    "priorAuthId": "00000000-0000-4000-8000-000000000001",
    "processingState": "example-processingstate",
    "errorCode": "example-errorcode",
    "mappingProfileId": "00000000-0000-4000-8000-000000000001",
    "mappingProfileVersion": 1.25,
    "verified_by_quickintell": true
  },
  "data": "example-data"
}
422
Payer or processing failure.
Handle this response as normal integration control flow.
{
  "ok": true,
  "outcome": "example-outcome",
  "errors": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "warnings": [
    {
      "code": "ERROR",
      "message": "Request failed",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ],
  "meta": {
    "inquiryId": "00000000-0000-4000-8000-000000000001",
    "priorAuthId": "00000000-0000-4000-8000-000000000001",
    "processingState": "example-processingstate",
    "errorCode": "example-errorcode",
    "mappingProfileId": "00000000-0000-4000-8000-000000000001",
    "mappingProfileVersion": 1.25,
    "verified_by_quickintell": true
  },
  "data": "example-data"
}
429
Rate limited.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "RATE_LIMIT_EXCEEDED",
      "message": "Rate limit exceeded",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}
500
Internal error.
Handle this response as normal integration control flow.
{
  "ok": false,
  "errors": [
    {
      "code": "INTERNAL_ERROR",
      "message": "Internal server error",
      "source": "example-source",
      "retryable": true,
      "stage": "example-stage",
      "path": "example-path",
      "httpStatus": 1.25
    }
  ]
}

Adjacent endpoints

Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.

Get canonical or mapped prior authorization result | QuickRCM API Docs | QuickRCM API Docs