Payer Enrollment

Clone payer enrollment application

Creates a local DRAFT application for a different organization-scoped target payer by copying selected data from a source application.

POSTPublic reference baselineExternal or credentialedPayer EnrollmentoperationId: clonePayerEnrollmentApplicationhttps://dev-api.quickintell.com/api/v1/payer-enrollment/applications/{applicationId}/clone

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 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/{applicationId}/clone. 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/{applicationId}/clone 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	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.
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

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 when a provider needs a similar enrollment application for another payer configuration and source application data should seed the new local draft.

Before calling

Load the source application and choose a `targetPayerConfigId` from the same organization. Check whether an active application already exists for the source provider, target payer, and source application type.

Request and response behavior

Request guidance

`targetPayerConfigId` is required. The handler copies provider id, credentialing session id, application type, application method, and application data from the source, selects an active form template by target payer name when available, and initializes status DRAFT.

The target payer must be an organization-scoped payer configuration.
Duplicate detection uses provider, target payer, source application type, active status, and organization.
Cloned data remains local draft data.

Response semantics

HTTP 201 returns the cloned local application and `meta.organizationId`. The clone is a draft only; it does not submit, notify, or synchronize with the target payer.

Status is DRAFT on clone.
The response may omit or null related provider summary if not reloaded.
No external submission or payer notification occurs.

Errors and retries

Treat 404 as missing source application or target payer configuration in the authenticated organization. Treat 409 as an active duplicate for the provider, target payer, and application type. After timeouts, list applications for the provider and target payer before retrying.

404 can mean source application or target payer configuration is not accessible.
409 means an active duplicate already exists.

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
applicationId	path	Yes	string	QuickRCM payer enrollment application identifier. It 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
targetPayerConfigId	body	Yes	string	Required organization-scoped payer configuration id for the cloned draft.	Minimum length: 1.

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.

{
  "targetPayerConfigId": "00000000-0000-4000-8000-000000000001"
}

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.

201

Payer enrollment application cloned.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "application": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "providerId": "00000000-0000-4000-8000-000000000001",
      "provider": {
        "id": "00000000-0000-4000-8000-000000000001",
        "firstName": "John",
        "lastName": "Smith",
        "npi": "1234567893"
      },
      "payerConfigId": "00000000-0000-4000-8000-000000000001",
      "payerConfig": {
        "id": "00000000-0000-4000-8000-000000000001",
        "payerName": "Example clone_payer_enrollment_application",
        "payerId": "87726"
      },
      "applicationType": "INITIAL",
      "applicationMethod": "CAQH",
      "payerApplicationId": "00000000-0000-4000-8000-000000000001",
      "caqhProviderId": "00000000-0000-4000-8000-000000000001",
      "status": "DRAFT",
      "submissionDate": "2026-06-08T10:15:30Z",
      "acknowledgmentDate": "2026-06-08T10:15:30Z",
      "effectiveDate": "2026-06-08T10:15:30Z",
      "expirationDate": "2026-06-08T10:15:30Z",
      "nextFollowUpDate": "2026-06-08T10:15:30Z",
      "followUpCount": 1,
      "estimatedProcessingDays": 1,
      "assignedToId": "00000000-0000-4000-8000-000000000001",
      "formTemplateId": "00000000-0000-4000-8000-000000000001",
      "formTemplate": {
        "id": "00000000-0000-4000-8000-000000000001",
        "formName": "Example clone_payer_enrollment_application",
        "formVersion": "example-formversion"
      },
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "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 parameters.