Payer Enrollment

Validate payer enrollment bulk import

Dry-runs a bulk payer enrollment import by validating provider NPIs and payer names against organization-scoped QuickRCM records.

POSTPublic reference baselineExternal or credentialedPayer EnrollmentoperationId: bulkImportPayerEnrollmentshttps://dev-api.quickintell.com/api/v1/payer-enrollment/applications/bulk-import

Public reference baselineExternal or credentialedProvider 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, 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 provider and payer setup contract generated for POST /api/v1/payer-enrollment/applications/bulk-import. 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/payer-enrollment/applications/bulk-import 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.

Payer Enrollment public API.

Payer Enrollment APIs expose organization-scoped provider enrollment profiles, payer-specific enrollment applications, local enrollment status tracking, follow-up notes, deficiencies, assignment, and safe validation workflows for credentialing sync and bulk import. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Read endpoints require payer-enrollment read or write scope; mutation endpoints require payer-enrollment write scope. Referenced provider profiles, payer configurations, credentialing sessions, enrollment rows, deficiencies, applications, and assignees must resolve inside the authenticated organization. Provider identity fields include National Provider Identifier (NPI) values, Council for Affordable Quality Healthcare (CAQH) identifiers, Medicare identifiers, and other sensitive operational enrollment data. This public surface is intentionally conservative. Application, provider-profile, follow-up, deficiency, assignment, enrollment, status, and clone endpoints update local QuickRCM records only. `submitPayerEnrollmentApplication`, `simulateSyncPayerEnrollmentProfileFromCredentialing`, and `bulkImportPayerEnrollments` are validation or dry-run surfaces that return `SIMULATED_ONLY` metadata and do not submit to payer portals, write provider data from credentialing, or import rows. When an application method names Electronic Data Interchange (EDI) or the Provider Enrollment, Chain, and Ownership System (PECOS), it is local workflow metadata unless a future private workflow provides separate evidence. Keep examples synthetic and keep notes free of Protected Health Information (PHI), portal credentials, OAuth tokens, raw EDI, raw payer payloads, S3 keys, and vendor responses. Iteration 3 adds final materialization guidance for the reference pages: list responses are ordered by most recently updated application first, and simulated-only flows should show small synthetic examples that keep tenant selection implicit in the bearer API key.

What this endpoint does

Use case

Use this to validate a spreadsheet or integration feed before requesting a private or future bulk write workflow.

Before calling

Create provider profiles and payer configurations for the organization first. Prepare 1 to 100 enrollment rows with 10-digit National Provider Identifier (NPI), provider names, payer name, and enrollment status. Send `dryRun: true`.

Request and response behavior

Request guidance

`dryRun` must be true. The current dry-run handler validates every row against the public schema, including names, status enum, optional dates, and optional payer provider id. After schema validation, it matches only unique `enrollments[].npi` values against provider profiles and unique `enrollments[].payerName` values against payer configurations in the authenticated organization. `idempotencyKey` is accepted by the schema but is not used for dedupe or replay because no rows are written.

`dryRun: true` is required.
`enrollments` must contain 1 to 100 rows.
The API matches providers by unique `npi` and payers by exact `payerName`; `firstName`, `lastName`, `enrollmentStatus`, dates, and payer provider id are schema-validated but not used for row lookup.
The endpoint is simulated-only and does not use `idempotencyKey` for dedupe.

Response semantics

HTTP 202 returns `mode: SIMULATED_ONLY`, `totalRows`, `matchedProfiles`, `matchedPayers`, and an `errors` array. It does not create or update provider profiles, payer configurations, applications, or enrollment rows. A 202 response can still include row-indexed lookup errors such as provider profile not found or payer not found.

`errors` contains row-indexed validation findings for missing providers or payers.
`matchedProfiles` and `matchedPayers` count unique matched NPIs and payer names, not successful row count.
No rows are written by this public endpoint.

Errors and retries

Fix schema-level 400s and row-level 202 errors before attempting any write workflow. Treat 400 as malformed body, missing `dryRun: true`, invalid National Provider Identifier (NPI), invalid status, invalid datetime, missing required row fields, or too many rows. Retry 429 with backoff.

400 covers schema-level validation; row-level lookup misses are returned inside the 202 response.
Do not rely on `idempotencyKey` for dedupe because no write occurs.

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
dryRun	body	Yes	true	Required literal true safety flag. The public bulk import endpoint is validation-only.	Enum values are declared in the Type column.
idempotencyKey	body	No	string	Optional caller retry marker capped at 128 characters. Current dry-run behavior does not use it for dedupe, replay, or row matching.	Minimum length: 1. Maximum length: 128. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.
enrollments	body	Yes	object[]	Array of 1 to 100 enrollment rows to validate. Rows are schema-validated first, then only unique National Provider Identifier (NPI) and payer-name values are used for organization-scoped lookups.	OpenAPI does not declare additional validation metadata.
enrollments[].npi	body	Yes	string	Required 10-digit provider National Provider Identifier (NPI). The dry-run handler matches unique NPI values against provider profiles in the authenticated organization.	Pattern constraint declared in OpenAPI. File, artifact, or raw-payload adjacent; keep examples metadata-only.
enrollments[].firstName	body	Yes	string	Required provider first name capped at 100 characters. It is schema-validated but not used for current dry-run matching; examples must use synthetic names.	Minimum length: 1. Maximum length: 100.
enrollments[].lastName	body	Yes	string	Required provider last name capped at 100 characters. It is schema-validated but not used for current dry-run matching; examples must use synthetic names.	Minimum length: 1. Maximum length: 100.
enrollments[].payerName	body	Yes	string	Required payer configuration name capped at 200 characters. The dry-run handler matches unique payer names against payer configurations in the authenticated organization.	Minimum length: 1. Maximum length: 200.
enrollments[].enrollmentStatus	body	Yes	NOT_ENROLLED \| APPLICATION_PENDING \| ENROLLED_ACTIVE \| ENROLLED_RESTRICTED \| RECREDENTIALING_DUE \| RECREDENTIALING_IN_PROGRESS \| SUSPENDED \| TERMINATED_ENROLLMENT \| DENIED_ENROLLMENT \| EXPIRED_ENROLLMENT	Required local payer enrollment status enum value for the proposed row. It is schema-validated but no enrollment row is written.	Enum values are declared in the Type column.
enrollments[].effectiveDate	body	No	string (date-time)	Optional ISO datetime for the proposed enrollment effective date. It is schema-validated only in the current dry-run handler.	Format: date-time.
enrollments[].payerProviderId	body	No	string	Optional payer-assigned provider identifier capped at 100 characters. It is schema-validated only and is not written by this dry-run endpoint.	Minimum length: 1. Maximum length: 100.
enrollments[].nextRecredentialingDue	body	No	string (date-time)	Optional ISO datetime for the proposed next recredentialing due date. It is schema-validated only in the current dry-run handler.	Format: date-time. Sensitive credential or storage-adjacent value; use placeholders 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.

{
  "dryRun": true,
  "enrollments": [
    {
      "npi": "1234567893",
      "firstName": "John",
      "lastName": "Smith",
      "payerName": "Example import_payer_enrollment",
      "enrollmentStatus": "NOT_ENROLLED",
      "effectiveDate": "2026-06-08T10:15:30Z",
      "payerProviderId": "00000000-0000-4000-8000-000000000001",
      "nextRecredentialingDue": "2026-06-08T10:15:30Z"
    }
  ],
  "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.

202

Bulk import validation completed without writing rows.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SIMULATED_ONLY",
    "applicationId": "00000000-0000-4000-8000-000000000001",
    "submissionMethod": "example-submissionmethod",
    "credentialingSessionId": "00000000-0000-4000-8000-000000000001",
    "wouldSubmit": true,
    "wouldCreateProfile": true,
    "totalRows": 1,
    "matchedProfiles": 1,
    "matchedPayers": 1
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "smokeCategory": "SIMULATED_ONLY"
  }
}

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