Billing

Queue billing CDM import

Queues a CDM rate import for the authenticated organization.

POSTPublic reference baselineQueue or asyncBillingoperationId: importBillingCdmhttps://dev-api.quickintell.com/api/v1/billing/cdm/import

Public reference baselineQueue or asyncBilling and claims

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 billing and claims contract generated for POST /api/v1/billing/cdm/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/billing/cdm/import 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	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.

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.

Billing public API.

Billing public API endpoints expose organization-scoped hospital billing encounters, coding review actions, physician query responses, batch imports, and Charge Description Master (CDM) maintenance. The surface is centered on `BillingEncounter` records and related review artifacts: code entries, POA indicators, DRG/E/M summaries, processing logs, physician queries, and CDM rate records. Tenant scope is resolved from the bearer API key. Read endpoints accept `billing:read` or `billing:write`; create, update, queue, finalize, code-edit, physician-response, and CDM mutation endpoints require `billing:write`. Callers should pass QuickRCM identifiers returned by prior reads, imports, or adjacent setup workflows; do not send organization IDs as an authority signal, raw EDI, payer portal credentials, transcripts, S3 keys, signed URLs, full vendor payloads, or unnecessary clinical narrative. The current Billing OpenAPI contract has detailed schemas for reads and queued workflows, but several mutation endpoints still use the generic mutation schema in generated OpenAPI while their handlers return concrete data. Client-facing docs should distinguish generated-schema guarantees from handler-observed runtime response fields, avoid promising unrelated Prisma columns as stable contract, and still recommend a follow-up read after queued workflows or state transitions when downstream processing is asynchronous.

What this endpoint does

Use case

Use this to hand off a bounded set of CDM/rate rows from an external source for asynchronous import.

Before calling

Prepare a source label and rate rows with code, description, allowed amount, and optional RVU/global period fields. Use synthetic or system labels, not vendor credentials or raw files.

Request and response behavior

Request guidance

Send `queueOnly: true`, `source` with 1 to 100 characters, and `rates` with 1 to 1000 rows. Each rate requires `code`, `description`, and nonnegative `allowedAmount`; optional RVU fields and `globalPeriod` must be nonnegative when supplied.

`rates` minimum is 1 and maximum is 1000.
`allowedAmount` is required and nonnegative.
`queueOnly` is required and must be true.

Response semantics

HTTP 202 returns `queued: true`, `operation: IMPORT_BILLING_CDM`, and nullable `queueJobId`. The import runs asynchronously.

Queue acknowledgement uses HTTP 202.
Use listBillingCdmEntries or getBillingCdmEntry to inspect imported records after processing.

Errors and retries

Fix validation errors for row count and nonnegative numeric fields. Reuse `idempotencyKey` when retrying the same import request after a transport failure.

Fix validation errors for row count and nonnegative numeric fields. Reuse `idempotencyKey` when retrying the same import request after a transport failure.

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
queueOnly	body	Yes	true	Creates or queues a local QuickRCM task instead of attempting direct payer or clearinghouse execution.	Enum values are declared in the Type column.
idempotencyKey	body	No	string	Caller-provided compatibility key used to detect repeated workflow requests. Reuse the same key only for safe retries of the same request.	Minimum length: 1. Maximum length: 255. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.
source	body	Yes	string	Import source label, 1 to 100 characters.	Minimum length: 1. Maximum length: 100.
rates	body	Yes	object[]	CDM rate rows, minimum 1 and maximum 1000.	OpenAPI does not declare additional validation metadata.
rates[].code	body	Yes	string	Procedure, revenue, Diagnosis-Related Group (DRG), or other local code on a contract rate schedule row.	Minimum length: 1. Maximum length: 32. Potential PHI; use synthetic examples and avoid logging raw values.
rates[].description	body	Yes	string	Human-readable description of the queue, workflow, or record. Avoid secrets and unnecessary PHI.	Minimum length: 1. Maximum length: 1000. Sensitive credential or storage-adjacent value; use placeholders only.
rates[].allowedAmount	body	Yes	number	Required nonnegative allowed amount for a rate row.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
rates[].rvuWork	body	No	number	OpenAPI description is missing; publication gap.	Minimum value: 0.
rates[].rvuPeFacility	body	No	number	OpenAPI description is missing; publication gap.	Minimum value: 0.
rates[].rvuPeNonfacility	body	No	number	OpenAPI description is missing; publication gap.	Minimum value: 0.
rates[].rvuMp	body	No	number	OpenAPI description is missing; publication gap.	Minimum value: 0.
rates[].globalPeriod	body	No	integer	Nullable nonnegative integer period field on CDM entries or CDM import rows.	Minimum value: 0.

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,
  "source": "example-source",
  "rates": [
    {
      "code": "ERROR",
      "description": "Example import_billing_cdm note",
      "allowedAmount": 125.5,
      "rvuWork": 1.25,
      "rvuPeFacility": 1.25,
      "rvuPeNonfacility": 1.25,
      "rvuMp": 1.25,
      "globalPeriod": 1
    }
  ],
  "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.

200

Billing public API operation completed.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {}
}

202

Billing CDM import queued.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "queued": true,
    "operation": "example-operation",
    "queueJobId": "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.