Eligibility

Get bulk eligibility batch

Returns sanitized bulk eligibility batch progress and aggregate check status for a batch owned by the authenticated organization.

GETPublic reference baselineRead-onlyEligibilityoperationId: getEligibilityBatchhttps://dev-api.quickintell.com/api/v1/eligibility/batches/{batchId}

Public reference baselineRead-onlyEligibility and discovery

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.

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

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

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 eligibility and discovery contract generated for GET /api/v1/eligibility/batches/{batchId}. 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/eligibility/batches/{batchId} contract as a read-only 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.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness

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.

Eligibility public API.

Eligibility APIs let integrations submit and retrieve tenant-scoped eligibility check summaries, then create, validate, inspect, and queue bulk eligibility batch wrappers. The bearer API key selects the organization for every operation; caller-supplied tenant selectors are not the public source of truth. Public reference copy should make the safety boundary explicit. These endpoints return sanitized QuickRCM workflow summaries with local identifiers, status fields, and aggregate batch progress. They do not return patient demographics in responses, raw X12 271 Health Care Eligibility Benefit Response payloads, raw payer or clearinghouse payloads, raw Electronic Data Interchange (EDI), or proof of final payer payment. Batch endpoints work with comma-separated values (CSV) content or placeholder Amazon Simple Storage Service (Amazon S3) object metadata, while external worker and payer behavior is documented as local or queued state rather than inline Amazon Simple Queue Service (Amazon SQS) or payer execution.

What this endpoint does

Use case

Use this to poll or display batch progress after createEligibilityBatch or queueEligibilityBatch returns a batchId.

Before calling

Use a batchId from the same tenant context and choose a polling interval that respects API key rate limits.

Request and response behavior

Request guidance

Pass only the path batchId. Do not send raw CSV, Amazon S3 credentials, signed URLs, object contents, payer credentials, or organization selectors.

Use batchId from createEligibilityBatch or queueEligibilityBatch.
Avoid tight polling loops; batch progress is local workflow state.

Response semantics

A 200 response returns success, data.batch, and meta.organizationId. The batch object includes local fileName, status, row counts, progressPercentage, nullable lifecycle timestamps, createdAt, updatedAt, and checkSummary. It does not return row-level CSV data or raw payer payloads.

checkSummary aggregates total, eligible, ineligible, pending, and failed checks.
startedAt and completedAt may be null until the batch reaches those lifecycle points.
The response does not include raw CSV rows, Amazon S3 object contents, or payer payloads.

Errors and retries

Treat 404 as missing or unavailable to this organization. Treat 403 as an authorization, scope, or authenticated-organization access failure rather than the normal wrong-ID outcome for a resource lookup. Back off on 429 and retry only transient 5xx responses.

404 can mean the batch does not exist or is outside the authenticated organization.
403 indicates the authenticated API key lacks required access, scope, or organization authorization; wrong-tenant batch IDs should be documented as 404 when the endpoint hides resource existence.
429 requires backoff before polling again.

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
batchId	path	Yes	string	QuickRCM bulk eligibility batch identifier scoped to the authenticated organization.	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.

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

Bulk eligibility batch status for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "batch": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "fileName": "Example eligibility_batch",
      "status": "active",
      "totalRows": 1,
      "processedRows": 1,
      "failedRows": 1,
      "progressPercentage": 1,
      "startedAt": "2026-06-08T10:15:30Z",
      "completedAt": "2026-06-08T10:15:30Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z",
      "checkSummary": {
        "total": 1,
        "eligible": 1,
        "ineligible": 1,
        "pending": 1,
        "failed": 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.