Claims

Submit claim

Queues a safe local claim submission task for a professional, institutional, or dental claim.

POSTPublic reference baselineExternal or credentialedClaimsoperationId: submitClaimhttps://dev-api.quickintell.com/api/v1/claims/{claimId}/submit

Public reference baselineExternal or credentialedClaims 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, E3 async and idempotency 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 remittances contract generated for POST /api/v1/claims/{claimId}/submit. 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}/submit 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	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	202	Treat the response as accepted or queued work, not completed workflow execution.
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	Possible	Queued work may later cause local or external effects only where endpoint evidence says so.

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

HTTP 202 or queued behavior requires endpoint-specific polling, terminal-state, retry, and retention guidance.
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 Async Jobs

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 a claim draft has been reviewed and is ready for QuickRCM's submission workflow.

Before calling

Confirm the claim is complete, organization-owned, and ready for submission. Use validateOnly or dryRun before production automation.

Request and response behavior

Request guidance

Use queueOnly, validateOnly, or dryRun to control side effects. idempotencyKey should be reused only for the same retry of the same claim submission request.

queueOnly is safest for automation pilots.
validateOnly checks readiness without creating a task.

Response semantics

The response represents local task creation, validation, or simulation. It is not payer acceptance and not a clearinghouse acknowledgment.

202 or task-like responses mean local workflow accepted.
Payer acknowledgments require later status or ERA evidence.

Errors and retries

Use idempotencyKey for network retries. Fix validation errors before retrying and back off on 429 responses.

400 indicates claim readiness or request-shape failure.
409 can indicate duplicate idempotency or invalid workflow state when exposed.

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
queueOnly	body	No	boolean	Creates or queues a local QuickRCM task instead of attempting direct payer or clearinghouse execution.	Default: true.
validateOnly	body	No	boolean	Validates ownership, authorization, and request shape without creating a task or external submission.	Default: false.
dryRun	body	No	boolean	Simulates the action without creating a task or making an external submission. Use this to verify request shape safely.	Default: false.
idempotencyKey	body	No	string	Caller-provided compatibility key used to detect repeated workflow requests. Reuse the same key only for safe retries of the same request.	Minimum length: 1. Maximum length: 200. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.

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.

{
  "queueOnly": true,
  "validateOnly": false,
  "dryRun": false,
  "idempotencyKey": "example-idempotencykey"
}

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

Validated or simulated claim submission.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "claimId": "00000000-0000-4000-8000-000000000001",
    "claimType": "PROFESSIONAL",
    "status": "QUEUED",
    "taskId": "00000000-0000-4000-8000-000000000001",
    "mode": "queueOnly",
    "externalSubmission": false
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

202

Queued local claim submission task.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "claimId": "00000000-0000-4000-8000-000000000001",
    "claimType": "PROFESSIONAL",
    "status": "QUEUED",
    "taskId": "00000000-0000-4000-8000-000000000001",
    "mode": "queueOnly",
    "externalSubmission": false
  },
  "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.