EOB to ERA

Trigger EOB processing safely

Simulates processing or records a safe local PROCESSING status transition for one organization-owned Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion.

POSTPublic reference baselineQueue or asyncEOB to ERAoperationId: processEob2EraConversionhttps://dev-api.quickintell.com/api/v1/eob2era/conversions/{conversionId}/process

Public reference baselineQueue or asyncClaims and remittances

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 E3 async and idempotency 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

Queue or async

May return queued work or HTTP 202. Queueing is not completion, and terminal job semantics are endpoint-specific.

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/eob2era/conversions/{conversionId}/process. 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/eob2era/conversions/{conversionId}/process contract as a queue or async 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	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.

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.

EOB to ERA public API.

Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) public APIs expose organization-scoped conversion tracking for EOB documents and safe local ERA classification workflow metadata. The bearer API key selects the organization; public requests should not include an `organizationId` tenant selector. The current public surface is intentionally conservative. Read endpoints return sanitized conversion summaries and file-presence booleans, not file names, storage keys, signed URLs, raw EOB text, raw X12 835 Electronic Remittance Advice transaction payloads, or parser output. Write endpoints validate requests, create local records from existing organization-owned `File` rows, perform safe local status updates, or classify caller-supplied ERA summary fields. These endpoints do not upload files, generate Amazon Simple Storage Service (S3) presigned URLs, enqueue Amazon Simple Queue Service (SQS) work, run optical character recognition (OCR) or large language model (LLM) extraction, parse raw payer payloads, submit claims, post payments, create denial records, or prove payer adjudication. Use synthetic examples and keep all notes, file names, and classification summaries free of real Protected Health Information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), transcripts, S3 keys, payer portal credentials, and vendor payloads.

What this endpoint does

Use case

Use dry-run mode to verify that a conversion exists and that the request is shaped correctly. Use queue-only mode when a public integration should mark the local conversion as ready for processing without invoking the actual processing pipeline.

Before calling

Authenticate with `eob2era:write` and resolve `conversionId` from the same tenant. Decide whether this is a no-write simulation (`dryRun: true`) or a safe local DB status update (`queueOnly: true`).

Request and response behavior

Request guidance

Send `dryRun: true` for simulation or `queueOnly: true` for a safe local update. If both are false or omitted, the handler rejects the request. `priority` accepts low, normal, or high and is echoed in the response, but the public endpoint does not send an Amazon Simple Queue Service (SQS) message.

`dryRun` defaults to false for this endpoint.
`queueOnly` defaults to false and is required for the DB update path.
`queued: true` in the response means safe local status recording, not an Amazon Simple Queue Service (SQS) enqueue.

Response semantics

HTTP 202 with mode SIMULATED_ONLY means no database update occurred. HTTP 202 with mode SAFE_WRITE_DB_ONLY means the conversion status was updated to PROCESSING through an organization-scoped update. In both cases, Amazon Simple Queue Service (SQS), optical character recognition (OCR), large language model (LLM), and Amazon Simple Storage Service (S3) side effects are not performed.

SIMULATED_ONLY returns status PROCESSING_NOT_STARTED and `queued: false`.
SAFE_WRITE_DB_ONLY returns status PROCESSING and `queued: true` after the local update.
The response is workflow metadata, not conversion completion.

Errors and retries

Treat 400 as missing safe-mode controls, 404 as missing or wrong-organization conversion context, and 429 as a backoff signal. After a timeout in queue-only mode, read the conversion before retrying to avoid repeated status transitions.

400 means neither dryRun nor queueOnly enabled an allowed safe path.
404 can intentionally hide wrong-tenant conversions.
Do not retry 202 responses as if they were live processing acknowledgements.

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
conversionId	path	Yes	string	QuickRCM EOB to ERA conversion identifier from the path.	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.

Name	Location	Required	Type	Description	Validation and safety notes
queueOnly	body	No	boolean	When true, performs only a safe local database status transition; no Amazon Simple Queue Service (SQS) message is sent.	Default: false.
dryRun	body	No	boolean	When true, simulates the processing trigger without changing the database.	Default: false.
priority	body	No	low \| normal \| high	Requested processing priority label. Valid values are low, normal, and high; the current public handler echoes it without queueing external work.	Enum values are declared in the Type column. Default: normal.

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,
  "priority": "normal"
}

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

Processing was simulated or recorded without external side effects.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SIMULATED_ONLY",
    "conversionId": "eob_job_example_1",
    "queued": false,
    "simulated": true,
    "priority": "normal",
    "status": "PROCESSING_NOT_STARTED"
  },
  "meta": {
    "organizationId": "org_example_1"
  }
}

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.