ADR

List ADR requests

Returns ADR requests owned by the authenticated API key organization, with filters for status, ADR type, claim, assignee, overdue state, requestor entity, submission method, received date, response deadline, and search text.

GETPublic reference baselineExternal or credentialedADRoperationId: listAdrRequestshttps://dev-api.quickintell.com/api/v1/adr/requests

Public reference baselineExternal or credentialedClaims 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 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 claims and documentation contract generated for GET /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 GET /api/v1/adr/requests contract as a external or credentialed baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.

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	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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

External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes

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 endpoint to build ADR worklists, find requests approaching response deadlines, reconcile documentation requests, or select an ADR before viewing detail or recording a lifecycle event.

Before calling

Authenticate with a tenant-scoped API key that has adr:read or adr:write scope. Decide the narrowest useful filters and use skip/take pagination for production list calls.

Request and response behavior

Request guidance

Use bounded pagination; take defaults to 25 and is capped at 100. overdueOnly is the string true or false. Date filters accept ISO 8601 date or datetime strings. Date-only filter values are interpreted at 00:00:00.000Z on that UTC date, including upper bounds, so callers that need the whole final day should send an explicit end-of-day datetime. searchTerm matches local trackingNumber, requestorName, or requestorEntity, so avoid logging raw search values if they contain sensitive context.

Use status, adrType, claimId, overdueOnly, and date filters to avoid broad PHI-heavy worklists.
Use skip and take together; take must remain between 1 and 100.
The API key selects the organization; do not send organizationId as a public tenant selector.
For receivedDateTo or responseDeadlineTo date-only filters, send an explicit end-of-day timestamp if records later on that day should be included.

Response semantics

The response contains local QuickRCM ADR records plus document-reference metadata, total, skip, and take. Records are ordered by responseDeadline ascending in the handler. A listed ADR is not proof that documents have been externally submitted or accepted by a payer.

data.adrs contains local ADR workflow records and document metadata.
documents are references only; they are not binary file contents.
submission fields reflect local tracking state, not payer adjudication.

Errors and retries

Treat 400 as invalid filters, 401 as missing or invalid bearer credentials, 403 as insufficient ADR scope, and 429 as a backoff signal. Do not retry authorization failures without changing credentials or scopes.

400 can indicate malformed ISO dates, invalid enum values, or pagination bounds.
429 should be retried with backoff.
401 and 403 require credential or scope correction.

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

Name	Location	Required	Type	Description	Validation and safety notes
status	query	No	ADR_RECEIVED \| ADR_IN_PROGRESS \| ADR_DOCS_ASSEMBLED \| ADR_SUBMITTED \| ADR_OUTCOME_APPROVED \| ADR_OUTCOME_DENIED \| ADR_OVERDUE \| ADR_EXPIRED	Optional ADR workflow status filter. Valid values include ADR_RECEIVED, ADR_IN_PROGRESS, ADR_DOCS_ASSEMBLED, ADR_SUBMITTED, ADR_OUTCOME_APPROVED, ADR_OUTCOME_DENIED, ADR_OVERDUE, and ADR_EXPIRED.	Enum values are declared in the Type column.
adrType	query	No	ADR_PREPAYMENT_REVIEW \| ADR_POST_PAYMENT_REVIEW \| ADR_RAC_REQUEST \| ADR_PAYER_CLINICAL_REVIEW \| ADR_PRIOR_AUTH_SUPPORT \| ADR_HOSPICE_AUDIT	Optional ADR request category filter. Public enum values include prepayment review, post-payment review, RAC request, payer clinical review, prior-authorization support, and hospice audit categories.	Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values.
claimId	query	No	string	Optional exact QuickRCM claim identifier filter. The list still returns only ADRs in the API key organization.	Minimum length: 1. Maximum length: 128. Sensitive credential or storage-adjacent value; use placeholders only.
assignedTo	query	No	string	Optional exact QuickRCM assignee identifier filter for local ADR ownership or queue routing.	Minimum length: 1. Maximum length: 128.
overdueOnly	query	No	true \| false	String boolean filter. Use true to return only records whose local isOverdue flag is true.	Enum values are declared in the Type column.
requestorEntity	query	No	string	Optional exact requester entity filter, such as the payer, Centers for Medicare & Medicaid Services (CMS) contractor, reviewer, or internal requester label captured on the ADR.	Minimum length: 1. Maximum length: 160. File, artifact, or raw-payload adjacent; keep examples metadata-only.
submissionMethod	query	No	ATT_ELECTRONIC_275 \| ATT_PWK_LOOP \| ATT_PAYER_PORTAL \| ATT_FAX \| ATT_MAIL \| ATT_AVAILITY_ATTACHMENTS	Optional submission-channel enum filter. Valid values include ATT_ELECTRONIC_275, ATT_PWK_LOOP, ATT_PAYER_PORTAL, ATT_FAX, ATT_MAIL, and ATT_AVAILITY_ATTACHMENTS.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.
receivedDateFrom	query	No	string	Inclusive lower bound for receivedDate. Use an ISO 8601 date or datetime string; date-only values start at 00:00:00.000Z.	Minimum length: 1.
receivedDateTo	query	No	string	Inclusive upper bound for receivedDate. Date-only values are treated as 00:00:00.000Z on that UTC date, so send an explicit end-of-day datetime to include the full final day.	Minimum length: 1.
responseDeadlineFrom	query	No	string	Inclusive lower bound for responseDeadline. Use an ISO 8601 date or datetime string; date-only values start at 00:00:00.000Z.	Minimum length: 1.
responseDeadlineTo	query	No	string	Inclusive upper bound for responseDeadline. Date-only values are treated as 00:00:00.000Z on that UTC date, so send an explicit end-of-day datetime to include the full final day.	Minimum length: 1.
searchTerm	query	No	string	Free-text filter across trackingNumber, requestorName, and requestorEntity. Keep search terms out of logs when they include sensitive workflow context.	Minimum length: 1. Maximum length: 128.
skip	query	No	integer	Zero-based number of records to skip for pagination. Defaults to 0.	Minimum value: 0. Default: 0.
take	query	No	integer	Maximum records to return for this page. Defaults to 25 and cannot exceed 100.	Minimum value: 1. Maximum value: 100. Default: 25.

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

ADR request list

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "adrs": [
      {
        "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"
          }
        ]
      }
    ],
    "total": 1,
    "skip": 1,
    "take": 1
  }
}

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