Contract Management

Resolve underpayment case

Closes one organization-owned underpayment case with a recovery, write-off, or no-recovery resolution and records local activity/audit evidence.

PUTNeeds publication reviewLocal writeContract ManagementoperationId: resolveContractManagementUnderpaymentCasehttps://dev-api.quickintell.com/api/v1/contract-management/underpayment-cases/{caseId}/resolve

Needs publication reviewLocal writeRevenue integrity

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

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

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 revenue integrity contract generated for PUT /api/v1/contract-management/underpayment-cases/{caseId}/resolve. 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 PUT /api/v1/contract-management/underpayment-cases/{caseId}/resolve, 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	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

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

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.

Contract Management public API.

Contract Management APIs expose organization-scoped insurance contract inventory and local revenue-integrity workflow controls for contract list, detail, create, and update operations; what-if rate simulation drafts; fee schedule validation/import; underpayment detection; dispute-letter request recording; assignment; and resolution. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Every referenced payer configuration, facility, contract, claim, underpayment case, assignee, fee schedule, rate schedule, simulation, activity, and audit row must resolve inside the authenticated organization. These endpoints manage QuickRCM local state and audit evidence. They do not call payer systems, prove payer acceptance, upload or return contract files, generate or transmit live dispute letters, post cash, adjudicate claims, update Electronic Health Record (EHR) billing resources, or guarantee external recovery. Use synthetic examples and keep names, notes, rate-change context, dispute text, and import data free of real protected health information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), payer portal payloads, S3 keys, and vendor responses.

What this endpoint does

Use case

Use this endpoint after staff review determines that an underpayment case was recovered, should be written off, or should be closed without recovery.

Before calling

Authenticate with `contract-management:write`, read the current case, and verify it is not already resolved. Decide whether `resolvedAmount` is appropriate for recovered outcomes and keep notes sanitized.

Request and response behavior

Request guidance

`resolution` is required and must be `RECOVERED`, `CLOSED_WRITE_OFF`, or `CLOSED_NO_RECOVERY`. `resolvedAmount` is optional and non-negative. `notes` is optional and capped at 2000 characters.

`resolution` controls the final local case status.
`resolvedAmount` is stored as recovered amount only for recovered cases in the current handler.
Do not put raw payer responses, raw EDI, credentials, or unnecessary PHI in `notes`.

Response semantics

A successful response returns the local case id, final status, and `resolvedAt` timestamp. This endpoint closes local workflow state; it does not post cash, update patient balances, transmit dispute results to an Electronic Health Record (EHR), or prove payer reimbursement.

`resolvedAt` is an ISO datetime when the case was resolved.
The response is local case closure evidence.
Patient Accounts Receivable (AR), cash posting, appeal submission, and EHR write-back are separate workflows.

Errors and retries

Fix invalid resolution values, negative amounts, or excessive notes before retrying 400 responses. Treat 404 as missing or wrong-tenant case context. The current handler can reject already resolved cases as a conflict, but the OpenAPI response list should be updated before documenting 409 as a formal public response.

400 can indicate invalid request fields.
404 can mean the case is missing or outside the authenticated organization.
Already-resolved cases can be rejected by the handler; keep the OpenAPI/implementation discrepancy explicit before publishing 409 details.

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
caseId	path	Yes	string	QuickRCM underpayment case identifier from the path. It must belong to the authenticated organization.	Minimum length: 1. Financial value; preserve decimal precision and avoid real account details.

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
resolution	body	Yes	RECOVERED \| CLOSED_WRITE_OFF \| CLOSED_NO_RECOVERY	Required final resolution value: `RECOVERED`, `CLOSED_WRITE_OFF`, or `CLOSED_NO_RECOVERY`.	Enum values are declared in the Type column.
resolvedAmount	body	No	number	Optional non-negative recovery amount. In the current handler it is persisted as recovered amount only when resolution is `RECOVERED`.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
notes	body	No	string	Optional sanitized local resolution note, capped at 2000 characters.	Maximum length: 2000.

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.

{
  "resolution": "RECOVERED",
  "resolvedAmount": 125.5,
  "notes": "Example contract_management_underpayment_case note"
}

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

Underpayment case resolution result.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "status": "active",
    "resolvedAt": "2026-06-08T10:15:30Z"
  }
}

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.