Claims

Create attachment file upload

Creates a presigned upload target for a claim attachment file after verifying claim ownership.

POSTPublic reference baselineFile or artifactClaimsoperationId: uploadClaimAttachmentFilehttps://dev-api.quickintell.com/api/v1/claims/{claimId}/attachments/files

Public reference baselineFile or artifactClaims and remittances

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 remittances contract generated for POST /api/v1/claims/{claimId}/attachments/files. 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/claims/{claimId}/attachments/files 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.

Claims processing for professional, institutional, dental, attachment, claim-status, and predetermination workflows.

Claims APIs manage QuickRCM claim records and safe local workflow tasks around X12 837 claim submission, X12 276/277 claim status checks, and X12 275-style supporting attachment metadata. Public endpoints are organization-scoped by the bearer API key and currently emphasize validation, local task creation, queueing, and metadata capture before any live clearinghouse execution is treated as publication-ready.

What this endpoint does

Use case

Use this after attachment metadata exists and your integration is ready to upload a PDF, image, or other supported document.

Before calling

Know the file name, file size, MIME type, and document type. Keep the actual binary upload separate from metadata creation.

Request and response behavior

Request guidance

Request an upload target with file metadata only. Do not send file contents to this endpoint.

Use fileSize and fileType to validate client-side before upload.
Keep presigned upload details out of logs.

Response semantics

The response provides local upload instructions or metadata. Treat any upload URL as sensitive and short-lived.

The response is upload setup, not attachment submission.
The file still needs the downstream submitClaimAttachment workflow when applicable.

Errors and retries

Retry upload-target creation only if you are sure the previous target was not used. Re-request a target after expiration.

400 can mean unsupported file metadata.
Expired upload targets should be replaced, not reused.

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
claimId	path	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.

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
fileName	body	Yes	string	Original or display name for a file attachment. Do not include PHI beyond what the receiving workflow requires.	Minimum length: 1. Maximum length: 255. File, artifact, or raw-payload adjacent; keep examples metadata-only.
fileType	body	Yes	string	MIME type or file classification for an uploaded attachment, such as application/pdf or image/png.	Minimum length: 1. Maximum length: 255. File, artifact, or raw-payload adjacent; keep examples metadata-only.
fileSize	body	Yes	integer	Attachment size in bytes. Enforce upload limits before using the presigned target.	Minimum value: 1. File, artifact, or raw-payload adjacent; keep examples metadata-only.
reasonCode	body	No	string	Reason code captured from payer, denial, collection, or appeal workflows. Preserve the source code when available.	Minimum length: 1.
codeType	body	No	string	Code set or classification used for a denial, appeal, collection, or claim workflow reason.	Minimum length: 1.
documentType	body	No	string	Attachment or supporting document category, such as medical record, EOB, operative note, or payer form.	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.

{
  "fileName": "Example upload_claim_attachment_file",
  "fileType": "example-filetype",
  "fileSize": 1,
  "reasonCode": "example-reasoncode",
  "codeType": "example-codetype",
  "documentType": "example-documenttype"
}

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.

201

Created attachment file upload target.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "uploadUrl": "https://example.quickintell.com/resource",
    "fileRecord": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "claimId": "00000000-0000-4000-8000-000000000001",
      "filename": "Example upload_claim_attachment_file",
      "mimeType": "example-mimetype",
      "sizeBytes": 1,
      "documentType": "example-documenttype",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

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.