Coordination of Benefits

Queue COB secondary claim submission

Initiates the public secondary-claim submission workflow for a generated local secondary claim and returns queue/submission tracking metadata without exposing the claim payload.

POSTNeeds publication reviewExternal or credentialedCoordination of BenefitsoperationId: submitCobSecondaryClaimhttps://dev-api.quickintell.com/api/v1/cob/secondary-claims/{secondaryClaimId}/submit

Needs publication reviewExternal or credentialedClaims and remittances

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. 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 claims and remittances contract generated for POST /api/v1/cob/secondary-claims/{secondaryClaimId}/submit. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for POST /api/v1/cob/secondary-claims/{secondaryClaimId}/submit, but keeps the route out of ordinary production API positioning until review is complete.

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

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
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	Needs publication review 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.

Coordination of Benefits public API.

Coordination of Benefits (COB) APIs expose organization-scoped workflows for maintaining a patient's payer order, finding secondary-claim opportunities from primary Electronic Remittance Advice (ERA, commonly X12 835) data, generating local secondary claim records, queueing secondary-claim submission workflow, checking local secondary status, posting local secondary payment state, and voiding non-paid secondary claims. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Medicare Secondary Payer (MSP) fields are local payer-order context unless an endpoint-specific response says otherwise. Read endpoints accept Coordination of Benefits read or write scope, while payer-order, detection, generation, submission, payment, and void endpoints require Coordination of Benefits write scope. Referenced patients, insurance identifiers, primary claims, remittances, secondary claims, payer identifiers, and generated records must resolve inside the authenticated organization. Use the secondary-claim lifecycle as local QuickRCM workflow state: generation creates or returns local `SC_GENERATED` records, submission accepts generated records and returns queue/submission metadata, status check reads submitted or acknowledged local status, payment posting can move eligible records to `SC_PAID` or `SC_DENIED`, and voiding marks eligible non-paid records `SC_VOID`. Crossover states (`SC_CROSSOVER_PENDING`, `SC_CROSSOVER_SENT`) are local lifecycle labels, not proof of payer completion by themselves. These endpoints coordinate QuickRCM local workflow state. They do not return raw X12 837P professional claim Electronic Data Interchange (EDI), raw X12 835 ERA, raw X12 276/277 claim-status EDI, payer portal, Amazon S3 object-storage, or Electronic Health Record (EHR) payloads; they do not prove payer acceptance, final adjudication, EHR writeback, patient accounts receivable balance transfer, cash posting, or external reversal by themselves. Use synthetic examples and keep notes/reasons free of unnecessary Protected Health Information (PHI), raw EDI, credentials, tokens, payer portal data, transcripts, and vendor payloads.

What this endpoint does

Use case

Use this only after a secondary claim has been generated, reviewed, and is ready for configured submission workflow.

Before calling

Authenticate with `cob:write` scope. Confirm the secondary claim belongs to the organization and is in `SC_GENERATED` state. Provide the required `queueOnly: true` safety flag.

Request and response behavior

Request guidance

The body requires `queueOnly` and the only allowed value is true. The path `secondaryClaimId` is required. Do not send raw X12 837P professional claim EDI, payer credentials, or a request to force direct payer submission.

`queueOnly` must be true in the public schema.
The endpoint is side-effect-sensitive and requires COB write scope.
Use generated secondary claim IDs from COB APIs; do not guess IDs across tenants.

Response semantics

HTTP 202 returns `{ queued: true, submissionId }` and `meta.organizationId`. It confirms QuickRCM accepted the workflow request. It is not payer acceptance, a clearinghouse acknowledgment, final adjudication, or proof of externally delivered Electronic Data Interchange (EDI). The success path is live-side-effect-sensitive and should not be used as a live smoke test without an approved clearinghouse sandbox and synthetic data.

`queued: true` means the public workflow request was accepted by QuickRCM.
`submissionId` can be null.
Do not interpret 202 as clearinghouse acceptance or payer adjudication.
The example is illustrative only and should not be used as a live smoke test because the success path can route toward clearinghouse submission.

Errors and retries

400 can indicate invalid body or an invalid current secondary-claim status. 404 means missing or wrong-tenant secondary claim. 502 means the submission workflow failed before a successful public response. For timeouts, read secondary-claim detail before retrying.

400 can mean the claim is not in a submittable local status.
502 indicates the submission workflow failed.
The success path has been classified unsafe for automated live tests because it can route toward clearinghouse submission.

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
secondaryClaimId	path	Yes	string	QuickRCM secondary-claim generation identifier in the path. It must belong to the API key organization.	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
queueOnly	body	Yes	true	Required safety flag. Public schema permits only `true`.	Enum values are declared in the Type column.

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.

{
  "queueOnly": 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.

202

Secondary claim submission workflow queued locally.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "queued": true,
    "submissionId": "00000000-0000-4000-8000-000000000001"
  },
  "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 body or claim status.