ADR

Create ADR request

Creates a local, claim-linked ADR request after verifying that the claim belongs to the authenticated organization.

POSTPublic reference baselineLocal writeADRoperationId: createAdrRequesthttps://dev-api.quickintell.com/api/v1/adr/requests

Public reference baselineLocal writeClaims and documentation

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. 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 claims and documentation contract generated for POST /api/v1/adr/requests. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated POST /api/v1/adr/requests contract as a local write baseline endpoint.

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

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

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

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	Public reference baseline 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.

ADR public API.

Additional Documentation Request (ADR) APIs manage claim-linked documentation request intake and local response tracking for records owned by the organization selected by the bearer API key. Use these endpoints to list and retrieve ADR work items, create local claim-linked ADR records, mark responses as submitted, preview document assembly gaps, register document-reference metadata, and record approved or denied outcomes. The public ADR surface is intentionally metadata-oriented and conservative. Document assembly is simulation-only, document registration does not upload files or write storage objects, and response submission records local workflow state rather than proving payer receipt or adjudication. Treat requester details, tracking identifiers, document titles, outcome notes, and recovered amounts as sensitive healthcare workflow context. Do not put real protected health information (PHI), credentials, raw electronic data interchange (EDI), payer portal payloads, transcripts, S3 keys, or signed URLs in examples, logs, or retry keys.

What this endpoint does

Use case

Use this when an external payer, Centers for Medicare & Medicaid Services (CMS), a Recovery Audit Contractor (RAC), or an internal intake workflow identifies a documentation request that should be tracked against an existing QuickRCM claim.

Before calling

Resolve claimId from QuickRCM in the same tenant. Choose the ADR type, received date, response deadline, requested document types, and any requester tracking number. Use idempotencyKey only for safe retries when no requester tracking number exists.

Request and response behavior

Request guidance

Send claimId, adrType, receivedDate, responseDeadline, and at least one requestedDocType. receivedDate and responseDeadline must be valid ISO 8601 date or datetime strings. requestedDocTypes accepts 1 to 50 non-empty values. idempotencyKey is capped at 200 characters and must not contain PHI.

The API key selects the organization; body organizationId is not a public tenant selector.
Use trackingNumber when the requester provides a stable reference.
Use idempotencyKey for network retries of tracking-less ADR intake and keep it free of PHI.

Response semantics

A new ADR returns 201 with a local ADR record. An idempotent retry returns 200 with the existing ADR when the same organization, claimId, and trackingNumber match, or when a tracking-less retry uses the same idempotencyKey. New records start in ADR_RECEIVED and include an isOverdue flag computed from responseDeadline.

201 means a new local ADR was created.
200 means an existing ADR was returned for an idempotent retry.
For tracking-less idempotency, the internal marker is not returned as a public trackingNumber.

Errors and retries

Fix 400 validation errors before retrying. A 404 means the claim could not be resolved inside the API key organization. Reuse the same idempotencyKey only for the same create attempt.

400 can indicate invalid dates, missing requestedDocTypes, or invalid enum values.
404 means claimId is missing or unavailable to this tenant.
429 should be retried with backoff and the same idempotency key when applicable.

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
claimId	body	Yes	string	QuickRCM claim identifier. The claim must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
adrType	body	Yes	ADR_PREPAYMENT_REVIEW \| ADR_POST_PAYMENT_REVIEW \| ADR_RAC_REQUEST \| ADR_PAYER_CLINICAL_REVIEW \| ADR_PRIOR_AUTH_SUPPORT \| ADR_HOSPICE_AUDIT	ADR category enum used to classify the request workflow, including prepayment review, post-payment review, Recovery Audit Contractor (RAC) request, payer clinical review, prior-authorization support, and hospice audit values.	Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values.
receivedDate	body	Yes	string	Date or datetime when the ADR request was received. Must be a valid ISO 8601 date or datetime string.	Minimum length: 1.
responseDeadline	body	Yes	string	Date or datetime by which the response is due. Must be a valid ISO 8601 date or datetime string.	Minimum length: 1.
requestedDocTypes	body	Yes	string[]	Array of requested supporting document categories. Use stable operational labels such as clinical_notes or operative_report when your workflow uses those values.	Potential PHI; use synthetic examples and avoid logging raw values.
requestorName	body	No	string	Optional staff-readable requester name or department label. Avoid unnecessary personal details.	Minimum length: 1. Maximum length: 160.
requestorEntity	body	No	string	Optional requester organization, reviewer, CMS contractor, RAC, or payer label.	Minimum length: 1. Maximum length: 160.
trackingNumber	body	No	string	Requester, portal, or internal ADR request tracking reference. It is used with claimId for duplicate detection when provided.	Minimum length: 1. Maximum length: 120.
idempotencyKey	body	No	string	Caller-supplied retry key for tracking-less ADR intake. Reuse only for safe retries of the same request and do not include PHI.	Minimum length: 1. Maximum length: 200. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.
assignedTo	body	No	string	QuickRCM user identifier for local assignment when known. It should refer to a user in the same organization.	Minimum length: 1. Maximum length: 128.

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.

{
  "claimId": "00000000-0000-4000-8000-000000000001",
  "adrType": "ADR_PREPAYMENT_REVIEW",
  "receivedDate": "2026-06-08",
  "responseDeadline": "2026-06-30",
  "requestedDocTypes": [
    "example-requesteddoctypes"
  ],
  "requestorName": "Example adr_request",
  "requestorEntity": "example-requestorentity",
  "trackingNumber": "example-trackingnumber",
  "idempotencyKey": "example-idempotencykey",
  "assignedTo": "example-assignedto"
}

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

Existing ADR request returned for an idempotent retry

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "claimId": "00000000-0000-4000-8000-000000000001",
    "adrType": "ADR_PREPAYMENT_REVIEW",
    "status": "ADR_RECEIVED",
    "receivedDate": "2026-06-08T10:15:30Z",
    "responseDeadline": "2026-06-08T10:15:30Z",
    "isOverdue": true,
    "requestedDocTypes": [
      "example-requesteddoctypes"
    ],
    "requestorName": "Example adr_request",
    "requestorEntity": "example-requestorentity",
    "trackingNumber": "example-trackingnumber",
    "submittedAt": "2026-06-08T10:15:30Z",
    "submissionMethod": "ATT_ELECTRONIC_275",
    "submissionTrackingId": "00000000-0000-4000-8000-000000000001",
    "outcomeDate": "2026-06-08T10:15:30Z",
    "recoveredAmount": "example-recoveredamount",
    "assignedTo": "example-assignedto",
    "createdAt": "2026-06-08T10:15:30Z",
    "updatedAt": "2026-06-08T10:15:30Z",
    "documents": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "documentType": "example-documenttype",
        "title": "Example adr_request",
        "source": "example-source",
        "externalDocumentId": "00000000-0000-4000-8000-000000000001",
        "createdAt": "2026-06-08T10:15:30Z"
      }
    ]
  }
}

201

ADR request created

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "claimId": "00000000-0000-4000-8000-000000000001",
    "adrType": "ADR_PREPAYMENT_REVIEW",
    "status": "ADR_RECEIVED",
    "receivedDate": "2026-06-08T10:15:30Z",
    "responseDeadline": "2026-06-08T10:15:30Z",
    "isOverdue": true,
    "requestedDocTypes": [
      "example-requesteddoctypes"
    ],
    "requestorName": "Example adr_request",
    "requestorEntity": "example-requestorentity",
    "trackingNumber": "example-trackingnumber",
    "submittedAt": "2026-06-08T10:15:30Z",
    "submissionMethod": "ATT_ELECTRONIC_275",
    "submissionTrackingId": "00000000-0000-4000-8000-000000000001",
    "outcomeDate": "2026-06-08T10:15:30Z",
    "recoveredAmount": "example-recoveredamount",
    "assignedTo": "example-assignedto",
    "createdAt": "2026-06-08T10:15:30Z",
    "updatedAt": "2026-06-08T10:15:30Z",
    "documents": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "documentType": "example-documenttype",
        "title": "Example adr_request",
        "source": "example-source",
        "externalDocumentId": "00000000-0000-4000-8000-000000000001",
        "createdAt": "2026-06-08T10:15:30Z"
      }
    ]
  }
}

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