ADR

Add an ADR document reference

Validates or registers an external document reference for an organization-scoped ADR.

POSTPublic reference baselineFile or artifactADRoperationId: addAdrDocumenthttps://dev-api.quickintell.com/api/v1/adr/requests/{adrId}/documents

Public reference baselineFile or artifactClaims 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 E4 file and artifact governance 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

File or artifact

Touches documents, reports, transcripts, PDFs, EDI, or generated artifacts. Metadata is safer than raw content.

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/{adrId}/documents. 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/{adrId}/documents contract as a file or artifact 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	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	Potential file or artifact	Documents, PDFs, reports, transcripts, EDI, OCR, or generated artifacts need E4 classification before public examples.
Ownership and storage keys	Evidence required	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.
File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.

Related platform rules

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

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 a supporting document already exists in an external system or local workflow and QuickRCM needs a document-reference record tied to the ADR and claim.

Before calling

Resolve adrId and confirm the document reference is appropriate for the claim and ADR. Write calls require adr:write scope.

Request and response behavior

Request guidance

Send documentType, title, and source. validateOnly defaults to true and returns a dry-run preview. Set validateOnly to false only when you intentionally want QuickRCM to create a ClaimAttachmentDocument metadata row. externalDocumentId is optional and should be an opaque reference, not a signed URL or credential.

documentType, title, and source are required.
validateOnly true is the safe default and creates no record.
validateOnly false creates metadata only; it does not upload a file.

Response semantics

With validateOnly true, the response is 200 with mode SIMULATED_ONLY and wouldCreateDocument. With validateOnly false, the response is 201 with mode SAFE_WRITE_DB_ONLY and a created document metadata record. In both cases, writesToStorage is false and no file contents are uploaded.

SIMULATED_ONLY responses preview the document reference.
SAFE_WRITE_DB_ONLY responses create a ClaimAttachmentDocument metadata row with s3Key null.
externalDocumentId is returned only when stored in document metadata.

Errors and retries

After a timeout with validateOnly false, inspect the ADR documents before retrying to avoid duplicate references. Fix 400 validation errors and 404 wrong-tenant ADR references before retrying.

400 means document metadata is invalid.
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. It must resolve inside the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

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
documentType	body	Yes	string	Supporting document category attached to the ADR, such as clinical_notes or operative_report in local workflows.	Minimum length: 1. Maximum length: 100. Potential PHI; use synthetic examples and avoid logging raw values.
title	body	Yes	string	Human-readable document title. Avoid embedding PHI beyond what the ADR workflow requires.	Minimum length: 1. Maximum length: 200. File, artifact, or raw-payload adjacent; keep examples metadata-only.
source	body	Yes	string	Short source label for the document reference, such as external_reference or manual. Do not put credentials or URLs here.	Minimum length: 1. Maximum length: 80. Sensitive credential or storage-adjacent value; use placeholders only.
externalDocumentId	body	No	string	Optional opaque identifier from an external document system. Do not use signed URLs, S3 keys, or credentials.	Minimum length: 1. Maximum length: 160. Sensitive credential or storage-adjacent value; use placeholders only.
validateOnly	body	No	boolean	When true or omitted, validates and previews the reference without creating a row. When false, creates metadata only.	Default: true.

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.

{
  "documentType": "example-documenttype",
  "title": "Example add_adr_document",
  "source": "example-source",
  "externalDocumentId": "00000000-0000-4000-8000-000000000001",
  "validateOnly": true
}

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

Document add simulation

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SIMULATED_ONLY",
    "status": "validated",
    "wouldCreateDocument": {
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "adrId": "00000000-0000-4000-8000-000000000001",
      "claimId": "00000000-0000-4000-8000-000000000001",
      "documentType": "example-documenttype",
      "title": "Example add_adr_document",
      "source": "example-source",
      "externalDocumentId": "00000000-0000-4000-8000-000000000001"
    },
    "sideEffects": {
      "createsClaimAttachmentDocument": false,
      "writesToStorage": false
    }
  }
}

201

Document reference registered

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SIMULATED_ONLY",
    "status": "validated",
    "wouldCreateDocument": {
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "adrId": "00000000-0000-4000-8000-000000000001",
      "claimId": "00000000-0000-4000-8000-000000000001",
      "documentType": "example-documenttype",
      "title": "Example add_adr_document",
      "source": "example-source",
      "externalDocumentId": "00000000-0000-4000-8000-000000000001"
    },
    "sideEffects": {
      "createsClaimAttachmentDocument": false,
      "writesToStorage": false
    }
  }
}

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