OIG Exclusion

Simulate organization-wide OIG exclusion check

Returns an organization-scoped dry-run summary for screenable employees and providers, including latest run metadata, without calling LEIE or SAM.gov sources.

POSTPublic reference baselineValidate or simulateOIG ExclusionoperationId: runOrganizationExclusionCheckhttps://dev-api.quickintell.com/api/v1/oig-exclusion/checks/bulk

Public reference baselineValidate or simulateProvider and payer setup

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 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

Validate or simulate

Produces validation, preview, dry-run, or simulation output. Treat results as local compatibility behavior.

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 provider and payer setup contract generated for POST /api/v1/oig-exclusion/checks/bulk. 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/oig-exclusion/checks/bulk contract as a validate or simulate 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	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

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

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

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.

OIG Exclusion public API.

OIG Exclusion APIs expose organization-scoped exclusion-check records for Office of Inspector General (OIG) screening against List of Excluded Individuals/Entities (LEIE) and System for Award Management (SAM.gov) summary data. The bearer API key selects the authenticated organization; public request bodies should not be documented as tenant selectors. The current public surface is intentionally conservative. organizationId`. The create endpoint accepts provider checks with a legal display name, `checkType: PROVIDER`, a 10-digit NPI, and a two-uppercase-letter state code; successful calls can return a recent existing check because the runtime deduplicates matching checks within the recent-check window. The bulk endpoint is dry-run only and returns `SIMULATED_ONLY` counts plus latest-run metadata without calling LEIE or SAM sources. The resolution endpoint records a human false-positive or confirmed-excluded decision for resolvable local checks, and a confirmed-excluded decision can attempt internal organization-scoped follow-up. Do not describe public responses as raw federal-source exports, external EHR write-back, payer notification, or guaranteed claim holds.

What this endpoint does

Use case

Use this endpoint to estimate screening scope, display compliance coverage counts, or check latest organization run metadata before using internal scheduled or manual screening workflows.

Before calling

Authenticate with `oig-exclusion:write` scope. Send `dryRun: true`; public callers should not use this endpoint to start live bulk federal-source screening.

Request and response behavior

Request guidance

`scope` can be `EMPLOYEES`, `PROVIDERS`, or `ALL` and defaults to `ALL`. `dryRun` defaults to true and must remain true for the public bulk endpoint. Runtime count semantics are implementation-specific: employee count uses active `OrganizationMember` rows for the authenticated organization, and provider count uses non-deleted `CredentialingSession` rows for the authenticated organization.

This endpoint is simulation-only; document `dryRun=true` as required for public callers.
`scope=ALL` estimates both employee and provider screening counts.
`scope=EMPLOYEES` returns provider count as 0; `scope=PROVIDERS` returns employee count as 0.
Do not describe this endpoint as creating OIG exclusion checks or making external LEIE/SAM.gov calls.

Response semantics

A 200 response returns `data.status: SIMULATED_ONLY`, the requested scope, `dryRun: true`, employee/provider/screenable counts, nullable `latestRun`, and `meta.organizationId`. `latestRun` contains run id, organization id, run date, completion timestamp, total checked, clear count, match count, error count, and next run date when available.

`status` is documented as `SIMULATED_ONLY` for the public endpoint.
`latestRun` can be null when no prior organization run metadata is available.
`employeeCount`, `providerCount`, and `estimatedScreenableCount` are counts, not matched-exclusion totals.
`estimatedScreenableCount` is the sum of the employee and provider counts returned for the selected scope.
`meta.organizationId` identifies the authenticated organization used for count queries and latest-run lookup.

Errors and retries

Correct invalid scope or dry-run body values before retrying. Back off on 429. Retry transient 5xx responses only within normal operational limits because this endpoint is intended for summary views, not tight polling.

400 can indicate an unsupported scope or `dryRun: false`.
401/403 require credential, scope, or tenant authorization correction.
429 means the caller should slow summary polling.

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

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
scope	body	No	EMPLOYEES \| PROVIDERS \| ALL	Screening population to simulate: `EMPLOYEES`, `PROVIDERS`, or `ALL`. Defaults to `ALL`.	Enum values are declared in the Type column. Default: ALL.
dryRun	body	No	boolean	Boolean flag required to remain true. The public endpoint only simulates organization-wide screening.	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.

{
  "scope": "ALL",
  "dryRun": 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

Simulated organization-wide exclusion screening summary.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "status": "SIMULATED_ONLY",
    "scope": "EMPLOYEES",
    "dryRun": true,
    "employeeCount": 1,
    "providerCount": 1,
    "estimatedScreenableCount": 1,
    "latestRun": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "runDate": "2026-06-08T10:15:30Z",
      "completedAt": "2026-06-08T10:15:30Z",
      "totalChecked": 1,
      "clearCount": 1,
      "matchCount": 1,
      "errorCount": 1,
      "nextRunDate": "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.