Claims

List claims

Returns claim records owned by the authenticated organization and lets integrators filter by workflow status, claim type, patient, payer, facility, and service date.

GETPublic reference baselineExternal or credentialedClaimsoperationId: listClaimshttps://dev-api.quickintell.com/api/v1/claims

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 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 GET /api/v1/claims. 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/claims 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.

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 endpoint to build claim worklists, reconcile claim creation with downstream submission tasks, or find claims before opening a detail page.

Before calling

Authenticate with a tenant-scoped API key and decide whether the caller needs a narrow patient, payer, facility, or service-date filter.

Request and response behavior

Request guidance

Use pagination and filters together. Avoid broad unbounded claim searches because claims can include PHI-adjacent workflow context.

Use filters to keep the result set relevant.
Use pagination for every production list call.

Response semantics

The response is a list of local QuickRCM claim summaries, not proof that a payer accepted or adjudicated the claim.

Returned claims are local records.
Submission and payer status require separate endpoints.

Errors and retries

Treat 401 and 403 as API-key or scope issues, 400 as invalid filters, and 429 as a signal to back off before polling again.

Retry 429 with backoff.
Do not retry authorization failures without changing credentials.

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
skip	query	No	integer	Number of records to skip for pagination. Use with take when the endpoint exposes skip/take pagination.	Minimum value: 0. Maximum value: 10000. Default: 0.
take	query	No	integer	Maximum number of records to take for skip/take pagination.	Minimum value: 1. Maximum value: 100. Default: 50.
status	query	No	DRAFT \| QUEUED \| SUBMITTED \| ACKNOWLEDGED \| IN_PROCESS \| PAID \| PARTIALLY_PAID \| DENIED \| REJECTED \| VOID	Workflow status filter or target status. Valid values depend on the endpoint schema and module state machine.	Enum values are declared in the Type column.
claimType	query	No	PROFESSIONAL \| INSTITUTIONAL \| DENTAL	Claim form family such as professional, institutional, or dental. The value determines which downstream claim fields are relevant.	Enum values are declared in the Type column.
patientId	query	No	string	QuickRCM patient identifier. The patient must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
payerConfigId	query	No	string	QuickRCM payer configuration identifier used for routing, payer metadata, and organization-specific payer settings.	Minimum length: 1.
facilityId	query	No	string	QuickRCM facility identifier scoped to the authenticated organization.	Minimum length: 1.
search	query	No	string	Free-text search filter. Avoid placing PHI in logs that include search terms.	Minimum length: 1. Maximum length: 200.
serviceFrom	query	No	string	Start date for the healthcare service period. Use an ISO date string.	Minimum length: 1.
serviceTo	query	No	string	End date for the healthcare service period. Use an ISO date string and keep it on or after serviceFrom.	Minimum length: 1.

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

Claims for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "claims": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "claimType": "PROFESSIONAL",
        "status": "DRAFT",
        "claimControlNumber": "example-claimcontrolnumber",
        "totalCharges": "example-totalcharges",
        "totalPaid": "00000000-0000-4000-8000-000000000001",
        "patientBalance": "example-patientbalance",
        "patientId": "00000000-0000-4000-8000-000000000001",
        "payerConfigId": "00000000-0000-4000-8000-000000000001",
        "facilityId": "00000000-0000-4000-8000-000000000001",
        "datesOfServiceStart": "2026-06-08T10:15:30Z",
        "datesOfServiceEnd": "2026-06-08T10:15:30Z",
        "lineCount": 1,
        "payerConfig": {
          "id": "00000000-0000-4000-8000-000000000001",
          "payerName": "Example claim",
          "payerId": "87726"
        },
        "facility": {
          "id": "00000000-0000-4000-8000-000000000001",
          "name": "Example claim"
        },
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "total": 1,
    "skip": 1,
    "take": 1
  },
  "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.