Medical Coding

List supported medical coding code systems

Returns the static list of medical coding code systems accepted by the async outpatient coding API.

GETNeeds publication reviewRead-onlyMedical CodingoperationId: getMedicalCodingCodeSystemshttps://dev-api.quickintell.com/api/v1/medical-coding/code-systems
Needs publication reviewRead-onlyPrior auth and clinical

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.

Authentication

Auth exception unclassified

OpenAPI does not declare bearer security here; this needs security review before public use.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

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 prior auth and clinical contract generated for GET /api/v1/medical-coding/code-systems. 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 GET /api/v1/medical-coding/code-systems, 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.

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.

HeaderRequiredCurrent statusNotes
AuthorizationNoUnclassified exceptionOpenAPI does not declare bearer security; review this exception before public use.
Idempotency-KeyNoTarget/futureDo not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-IdNoTarget/futureUse 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.

TopicStatusGuidance
Current idempotencyRead request; no mutation idempotency contract needed.Use ordinary safe-read retry behavior with rate-limit backoff.
Universal headerNot declaredDo not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behaviorUnresolvedSame-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.

TopicStatusGuidance
Immediate responseNo 202 response declaredOpenAPI does not declare HTTP 202 for this operation.
Polling and terminal statesEndpoint-specificUse only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
Later side effectsNot provenDo 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.

TopicStatusGuidance
Content classNo file/artifact class inferredOpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keysNot applicable unless a file field is presentTenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retentionUnresolved unless endpoint-specific evidence existsShort-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.
  • OpenAPI does not declare bearer security for this operation; generic auth language is unsafe here.

Evidence

EvidenceStatusCaveat
OpenAPI artifactdocs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.Generated baseline contract only.
Route registryNeeds publication review from documentation classification overlay.E6 route registry evidence is still required before external publication.
Example validationGenerated examples are internal baseline aids.No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewedImplementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.Refresh this evidence for release workspaces.
Release evidenceE9 required.No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Medical Coding public API.

Medical Coding APIs expose organization-scoped CodingJob list/detail reads, local CodingJob creation, safe workflow-field updates, simulated extraction and rerun markers, coded-item review metadata, import-batch metadata, clarification answer capture, claims-handoff markers, outpatient upload and batch metadata, local outpatient check and draft state, Clinical Documentation Improvement (CDI) query lifecycle state, coding automation-rule configuration, and an unauthenticated static code-system directory. Authenticated Medical Coding public API routes also use the module public API rate-limit action with a 60-request / 60-second window. If a caller is throttled, back off before retrying instead of polling tightly. The code-systems directory endpoint is declared without bearer authentication and returns static code-system metadata. For authenticated Medical Coding operations, the bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Read endpoints accept Medical Coding read or write scopes; write endpoints require Medical Coding write scope. Path identifiers and linked records such as CodingJob, Appointment, ScribeJob, Claim, Patient, BillingEncounter, upload, CDI query, automation rule, and assignee user records must resolve inside the authenticated organization or the handler returns a not-found or authorization-style error. Most mutation endpoints manage QuickRCM local workflow state. They do not directly invoke a large language model (LLM), optical character recognition (OCR), electronic health record (EHR) write-back, payer or clearinghouse submission, claim creation, claim adjudication, electronic data interchange (EDI) exchange, or binary file upload unless a specific endpoint says otherwise. Safe markers such as `VALIDATED_ONLY`, `SIMULATED_ONLY`, `QUEUED_ONLY`, and `SAFE_WRITE_DB_ONLY` are local workflow markers, not external processing results. Examples must use synthetic identifiers and generic clinical/coding text only, with no protected health information (PHI), credentials, tokens, raw EDI, transcripts, S3 keys, payer portal credentials, signed URLs, or vendor payloads.

What this endpoint does

Use case
Use this to populate code-system selectors or validate user choices before creating outpatient coding requests in clients.
Before calling
No bearer auth is declared for this endpoint. No path, query, or body parameters are declared.

Request and response behavior

Request guidance
Call with an empty request body. Because the endpoint is unauthenticated, examples should avoid implying tenant-specific results.
  • No authorization header is required by the contract.
  • No organization selector is accepted.
  • No request body is declared.
Response semantics
HTTP 200 returns `success: true` and `codeSystems`, where each item has `value`, `label`, `category`, and `description`. Categories are `US`, `International`, `Clinical`, or `Device`.
  • `codeSystems` is a static array from the medical coding module.
  • `category` is one of US, International, Clinical, or Device.
  • The response is not tenant-specific.

Errors and retries

Only HTTP 200 is declared in the public contract. Retry transient transport failures with normal client backoff.
  • The contract declares only a 200 success response.
  • Do not infer code validation or payer coverage from this static directory.

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.

This endpoint does not define a JSON request body.

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.

No request example is declared.

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
Supported medical coding code systems
Generated from the OpenAPI response schema.
{
  "success": true,
  "codeSystems": [
    {
      "value": "example-value",
      "label": "example-label",
      "category": "US",
      "description": "Example medical_coding_code_system note"
    }
  ]
}

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.

Adjacent endpoints

Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.

List supported medical coding code systems | QuickRCM API Docs | QuickRCM API Docs