ADR

Record ADR outcome

Records an approved or denied outcome for an organization-scoped ADR that is already in ADR_SUBMITTED status.

PUTPublic reference baselineExternal or credentialedADRoperationId: recordAdrOutcomehttps://dev-api.quickintell.com/api/v1/adr/requests/{adrId}/outcome

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 PUT /api/v1/adr/requests/{adrId}/outcome. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated PUT /api/v1/adr/requests/{adrId}/outcome 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. 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	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	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

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

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 the reviewer, payer, CMS contractor, RAC, or internal workflow has a final ADR outcome and QuickRCM should update local tracking and recovery reporting.

Before calling

Load the ADR and confirm it has status ADR_SUBMITTED. Write calls require adr:write scope. Capture only outcome facts that are known and supportable.

Request and response behavior

Request guidance

outcome is required and must be ADR_OUTCOME_APPROVED or ADR_OUTCOME_DENIED. outcomeNotes is optional and capped at 2,000 characters. recoveredAmount is optional, non-negative, and should be supplied only for confirmed approved recoveries.

Only ADR_SUBMITTED records can receive an outcome.
Keep outcomeNotes concise and free of raw payer payloads, raw EDI, credentials, or unnecessary PHI.
Use recoveredAmount only when it is confirmed and non-negative.

Response semantics

The response uses mode SAFE_WRITE_DB_ONLY and returns the updated ADR. Approved outcomes can retain recoveredAmount, including explicit zero. Denied outcomes store recoveredAmount as null in the public handler.

status becomes ADR_OUTCOME_APPROVED or ADR_OUTCOME_DENIED.
mode SAFE_WRITE_DB_ONLY means the endpoint updates local ADR state only.
recoveredAmount is serialized as a string or null in ADR responses.

Errors and retries

A 400 can mean invalid outcome, invalid amount, or attempting to record an outcome before ADR_SUBMITTED. Re-read the ADR after a timeout before retrying to avoid duplicate outcome note changes.

400 means invalid outcome data or invalid ADR status.
404 means adrId is unavailable to this tenant.
403 means the API key lacks adr:write scope.

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

Name	Location	Required	Type	Description	Validation and safety notes
adrId	path	Yes	string	QuickRCM ADR identifier in the path.	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
outcome	body	Yes	ADR_OUTCOME_APPROVED \| ADR_OUTCOME_DENIED	Final ADR outcome enum. Use ADR_OUTCOME_APPROVED or ADR_OUTCOME_DENIED.	Enum values are declared in the Type column.
outcomeNotes	body	No	string	Optional staff-readable notes explaining the outcome. Avoid raw payloads, credentials, or unnecessary PHI.	Minimum length: 1. Maximum length: 2000. Sensitive credential or storage-adjacent value; use placeholders only.
recoveredAmount	body	No	number	Optional non-negative amount recovered for an approved ADR outcome. Denied outcomes store recoveredAmount as null.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.

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.

{
  "outcome": "ADR_OUTCOME_APPROVED",
  "outcomeNotes": "Example adr_outcome note",
  "recoveredAmount": 125.5
}

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 outcome recorded

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SAFE_WRITE_DB_ONLY",
    "adr": {
      "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_outcome",
      "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_outcome",
          "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