Prior Authorization
Submit prior authorization
Submits an existing prior authorization case for payer review according to the public OpenAPI description and returns the updated local case summary.
operationId: submitPriorAuthhttps://dev-api.quickintell.com/api/v1/prior-auth/authorizations/{priorAuthId}/submitRoute 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 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 PUT /api/v1/prior-auth/authorizations/{priorAuthId}/submit. 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 PUT /api/v1/prior-auth/authorizations/{priorAuthId}/submit, 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.
- External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.
Related platform rules
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.
What this endpoint does
Request and response behavior
Errors and retries
Template boundary before examples
Path parameters
| Name | Location | Required | Type | Description | Validation and safety notes |
|---|---|---|---|---|---|
| priorAuthId | path | Yes | string | QuickRCM prior authorization case identifier to submit for review. | 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 |
|---|---|---|---|---|---|
| reportInput | body | No | object | Input-only report fields: internal account number and supplemental/reflex code qualifiers. Never inferred from a second procedure/diagnosis. | Potential PHI; use synthetic examples and avoid logging raw values. |
| reportInput.internalAccountNumber | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 200. |
| reportInput.supplementalDiagnosisCodeQualifier | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 20. Potential PHI; use synthetic examples and avoid logging raw values. |
| reportInput.supplementalProcedureCodeQualifier | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 20. |
| assessmentEvidence | body | No | object[] | Optional supplied policy, plan and clinical excerpts with unique IDs for LLM assessment. Missing evidence is explicitly flagged. | Potential PHI; use synthetic examples and avoid logging raw values. |
| assessmentEvidence[].id | body | Yes | string | Identifier from the nested payer, submitter, provider, or product object. Interpret it within that object's context, not globally. | Minimum length: 1. Maximum length: 100. |
| assessmentEvidence[].kind | body | Yes | policy | clinical | plan | OpenAPI description is missing; publication gap. | Enum values are declared in the Type column. |
| assessmentEvidence[].text | body | Yes | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 12000. |
| requestDetails | body | No | object | Explicit service dates, subscriber details, procedures and requesting/rendering providers. Does not override patient, payer or organization identity. | Tenant context is selected by the API key; do not treat this as a public tenant selector. |
| requestDetails.fromDate | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. |
| requestDetails.toDate | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. |
| requestDetails.requestTypeCode | body | No | HS | AR | SC | OpenAPI description is missing; publication gap. | Enum values are declared in the Type column. |
| requestDetails.serviceTypeCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.placeOfServiceCode | body | No | string | Short place-of-service code used in prior authorization requirement or case context. | Minimum length: 1. Maximum length: 200. |
| requestDetails.serviceLevelCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.quantity | body | No | string | Claim-line quantity serialized as a decimal string. | Pattern constraint declared in OpenAPI. |
| requestDetails.quantityTypeCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider | body | No | object | OpenAPI description is missing; publication gap. | OpenAPI does not declare additional validation metadata. |
| requestDetails.requestingProvider.npi | body | Yes | string | National Provider Identifier. Use a valid 10-digit provider NPI when the payer workflow requires provider identity. | Pattern constraint declared in OpenAPI. |
| requestDetails.requestingProvider.roleCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.firstName | body | No | string | Person first name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.lastName | body | Yes | string | Person last name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.addressLine1 | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.addressLine2 | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.city | body | No | string | City portion of a patient, subscriber, provider, or recipient address. Treat as PHI when linked to a person. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.stateCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.zipCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.phone | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.fax | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.contactName | body | No | string | Name of the payer, patient, agency, or internal contact reached during follow-up. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.requestingProvider.specialtyCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.taxId | body | No | string | Provider or organization tax identifier. Treat as sensitive and use placeholders in examples. | Minimum length: 1. Maximum length: 200. |
| requestDetails.requestingProvider.submitterId | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders | body | No | object[] | OpenAPI description is missing; publication gap. | OpenAPI does not declare additional validation metadata. |
| requestDetails.renderingProviders[].npi | body | Yes | string | National Provider Identifier. Use a valid 10-digit provider NPI when the payer workflow requires provider identity. | Pattern constraint declared in OpenAPI. |
| requestDetails.renderingProviders[].roleCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders[].firstName | body | No | string | Person first name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].lastName | body | Yes | string | Person last name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].addressLine1 | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].addressLine2 | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].city | body | No | string | City portion of a patient, subscriber, provider, or recipient address. Treat as PHI when linked to a person. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].stateCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders[].zipCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders[].phone | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].fax | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders[].contactName | body | No | string | Name of the payer, patient, agency, or internal contact reached during follow-up. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.renderingProviders[].specialtyCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.renderingProviders[].taxId | body | No | string | Provider or organization tax identifier. Treat as sensitive and use placeholders in examples. | Minimum length: 1. Maximum length: 200. |
| requestDetails.subscriber | body | No | object | Insurance subscriber context. Treat nested subscriber values as PHI. | Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriber.firstName | body | No | string | Person first name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriber.lastName | body | No | string | Person last name. Treat as PHI when the person is a patient, subscriber, or contact tied to a patient account. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriber.birthDate | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriber.genderCode | body | No | F | M | U | OpenAPI description is missing; publication gap. | Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriber.groupNumber | body | No | string | Optional coverage group number. Treat as sensitive patient coverage data. | Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.subscriberRelationshipCode | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.patientGenderCode | body | No | F | M | U | OpenAPI description is missing; publication gap. | Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.diagnoses | body | No | object[] | OpenAPI description is missing; publication gap. | OpenAPI does not declare additional validation metadata. |
| requestDetails.diagnoses[].qualifierCode | body | Yes | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.diagnoses[].code | body | Yes | string | Procedure, revenue, Diagnosis-Related Group (DRG), or other local code on a contract rate schedule row. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.procedures | body | No | object[] | OpenAPI description is missing; publication gap. | OpenAPI does not declare additional validation metadata. |
| requestDetails.procedures[].qualifierCode | body | Yes | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| requestDetails.procedures[].code | body | Yes | string | Procedure, revenue, Diagnosis-Related Group (DRG), or other local code on a contract rate schedule row. | Minimum length: 1. Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values. |
| requestDetails.procedures[].fromDate | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. |
| requestDetails.procedures[].toDate | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. |
| requestDetails.procedures[].serviceQuantity | body | No | string | OpenAPI description is missing; publication gap. | Pattern constraint declared in OpenAPI. |
| requestDetails.procedures[].serviceQuantityTypeCode | body | No | string | OpenAPI description is missing; publication gap. | Minimum length: 1. Maximum length: 200. |
| eligibilityServiceTypes | body | No | string[] | Eligibility service types to query before submission; defaults to [30]. This is separate from the prior-auth service type. | OpenAPI does not declare additional validation metadata. |
| reviewedAssessment | body | No | object | Reviewed policy/clinical assessment with reviewer, timestamp and source for the organization report. | Potential PHI; use synthetic examples and avoid logging raw values. |
| reviewedAssessment.reviewedBy | body | Yes | string | Nullable reviewer identifier on a check after human review. | Minimum length: 1. Maximum length: 200. |
| reviewedAssessment.reviewedAt | body | Yes | string (date-time) | ISO datetime when an appeal supporting document was reviewed. | Format: date-time. File, artifact, or raw-payload adjacent; keep examples metadata-only. |
| reviewedAssessment.source | body | Yes | string | Short source label for an ADR document reference. Do not place credentials, signed URLs, raw payloads, or storage keys in this field. | Minimum length: 1. Maximum length: 1000. Sensitive credential or storage-adjacent value; use placeholders only. |
| reviewedAssessment.policyAuthorityTier | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.planApplicabilityCaveat | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.policyCoverageClassification | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.medicalNecessityCriteria | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. File, artifact, or raw-payload adjacent; keep examples metadata-only. |
| reviewedAssessment.exclusionsNonCoveredTriggers | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.requiredClinicalDocumentation | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. Potential PHI; use synthetic examples and avoid logging raw values. |
| reviewedAssessment.frequencyRepeatTestingRule | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.counselingConsentRequirement | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.testConfigurationSpecimenRule | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.providerLaboratoryNetworkRule | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.caseEvidenceAndGapsToVerify | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.likelyCoveragePosture | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.paRequirementSubmissionRoute | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.policyAndCriteriaMatch | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.missingClinicalEvidence | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. Potential PHI; use synthetic examples and avoid logging raw values. |
| reviewedAssessment.recommendedSubmissionPacket | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.codingDiagnosisConcerns | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. Potential PHI; use synthetic examples and avoid logging raw values. |
| reviewedAssessment.primaryDenialRisk | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.nextBestAction | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| reviewedAssessment.confidencePlanVerification | body | No | string | OpenAPI description is missing; publication gap. | Maximum length: 4000. |
| mappingProfileId | body | No | string | Published organization response profile to pin for this authorization. | Minimum length: 1. File, artifact, or raw-payload adjacent; keep examples metadata-only. |
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.
{
"reportInput": {
"internalAccountNumber": "example-internalaccountnumber",
"supplementalDiagnosisCodeQualifier": "example-supplementaldiagnosiscodequalifier",
"supplementalProcedureCodeQualifier": "example-supplementalprocedurecodequalifier"
},
"assessmentEvidence": [
{
"id": "00000000-0000-4000-8000-000000000001",
"kind": "policy",
"text": "example-text"
}
],
"requestDetails": {
"fromDate": "2026-06-08",
"toDate": "2026-06-08",
"requestTypeCode": "HS",
"serviceTypeCode": "30",
"placeOfServiceCode": "example-placeofservicecode",
"serviceLevelCode": "example-servicelevelcode",
"quantity": "example-quantity",
"quantityTypeCode": "example-quantitytypecode"
},
"eligibilityServiceTypes": [
"example-eligibilityservicetypes"
],
"reviewedAssessment": {
"reviewedBy": "example-reviewedby",
"reviewedAt": "2026-06-08T10:15:30Z",
"source": "example-source",
"policyAuthorityTier": "example-policyauthoritytier",
"planApplicabilityCaveat": "2026-06-08T10:15:30Z",
"policyCoverageClassification": "example-policycoverageclassification",
"medicalNecessityCriteria": "example-medicalnecessitycriteria",
"exclusionsNonCoveredTriggers": "example-exclusionsnoncoveredtriggers",
"requiredClinicalDocumentation": "example-requiredclinicaldocumentation",
"frequencyRepeatTestingRule": "example-frequencyrepeattestingrule",
"counselingConsentRequirement": "example-counselingconsentrequirement"
},
"mappingProfileId": "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.
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.
Adjacent endpoints
Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.