Contract Management

Create insurance contract

Creates an organization-scoped insurance contract after validating the body and verifying the referenced payer configuration and optional facility are owned by the authenticated organization.

POSTNeeds publication reviewExternal or credentialedContract ManagementoperationId: createContractManagementContracthttps://dev-api.quickintell.com/api/v1/contract-management/contracts

Needs publication reviewExternal or credentialedRevenue 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 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 revenue integrity contract generated for POST /api/v1/contract-management/contracts. 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/contract-management/contracts, 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.
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

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 when an integration needs to create the local contract header that rate schedules, fee schedule imports, simulations, and underpayment workflows can reference later.

Before calling

Authenticate with `contract-management:write`. Resolve `payerConfigId` and optional `facilityId` from QuickRCM for the same tenant. Decide the base reimbursement type and effective date before creating the contract.

Request and response behavior

Request guidance

`payerConfigId`, `contractName`, `effectiveDate`, and `baseRateType` are required. `contractName` is capped at 255 characters, `contractNumber` at 100, and `notes` at 10000. `effectiveDate` and `terminationDate` must be ISO datetimes. `baseRate` and `medicarePercent` are non-negative numeric inputs when supplied.

`baseRateType` controls the primary reimbursement model label for the contract.
Do not put real contract PDFs, payer portal exports, credentials, or raw payer payloads in `notes`.
The body does not accept `organizationId`; tenant context comes from the bearer API key.
`payerConfigId` is a QuickRCM payer configuration id, not the optional external payer id shown as `payer.payerId` in responses.

Response semantics

A 201 response returns the created local contract detail, including payer/facility summary and active rate schedule array. Newly created contract headers are marked active by the public handler. This endpoint does not upload a contract document, import fee schedule rows, or contact a payer. The implementation can return not-found errors when the payer configuration or facility fails the organization ownership check, but the current OpenAPI response map for this operation does not formally declare 404.

`data.organizationId` is returned as record metadata and must match the authenticated organization.
`rateSchedules` is a local active schedule array and may be empty on a newly created contract.
Returned decimal values are strings even when request values were numeric.

Errors and retries

Fix validation failures before retrying 400 responses. Treat formally documented errors as 400, 401, 403, 429, and 500. If an implementation-observed not-found error occurs for a wrong-tenant or missing payer/facility, resolve the tenant-local identifiers before retrying. After a timeout, list contracts by payer/facility/name before creating another contract to avoid duplicates.

400 can indicate missing required fields, invalid date-time strings, invalid enum values, negative money fields, or excessive note/name length.
Implementation-observed 404 can indicate the payer configuration or facility was not found in the authenticated organization; update the OpenAPI response map before presenting that as a formal response code.
Retry transient failures only after checking whether the contract already exists.

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
payerConfigId	body	Yes	string	Required QuickRCM payer configuration identifier. It must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
facilityId	body	No	string	Optional QuickRCM facility identifier. When supplied, it must belong to the authenticated organization.	Minimum length: 1.
contractName	body	Yes	string	Human-readable local contract name, capped at 255 characters.	Minimum length: 1. Maximum length: 255.
contractNumber	body	No	string	Optional payer or internal contract number, capped at 100 characters.	Maximum length: 100.
effectiveDate	body	Yes	string (date-time)	ISO datetime when the contract becomes effective.	Format: date-time.
terminationDate	body	No	string (date-time)	Optional ISO datetime when the contract terminates; null means no termination date is recorded.	Format: date-time.
baseRateType	body	Yes	FEE_SCHEDULE \| PER_DIEM \| DRG_BASED \| CASE_RATE \| PERCENT_OF_CHARGE \| MEDICARE_PERCENT \| CAPITATED \| STOP_LOSS \| OUTLIER \| CARVE_OUT	Primary reimbursement model for a contract or rate schedule: FEE_SCHEDULE, PER_DIEM, DRG_BASED, CASE_RATE, PERCENT_OF_CHARGE, MEDICARE_PERCENT, CAPITATED, STOP_LOSS, OUTLIER, or CARVE_OUT.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.
baseRate	body	No	number	Optional non-negative base rate input for reimbursement types that use an amount.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
medicarePercent	body	No	number	Optional non-negative percentage input for Medicare-percent style contracts.	Minimum value: 0. File, artifact, or raw-payload adjacent; keep examples metadata-only.
notes	body	No	string	Optional local contract notes. Keep notes free of secrets, raw payer payloads, and unnecessary PHI.	Maximum length: 10000. Sensitive credential or storage-adjacent value; use placeholders only.

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.

{
  "payerConfigId": "00000000-0000-4000-8000-000000000001",
  "contractName": "Example contract_management_contract",
  "effectiveDate": "2026-06-08T10:15:30Z",
  "baseRateType": "FEE_SCHEDULE",
  "facilityId": "00000000-0000-4000-8000-000000000001",
  "contractNumber": "example-contractnumber",
  "terminationDate": "2026-06-08T10:15:30Z",
  "baseRate": 1.25,
  "medicarePercent": 1.25,
  "notes": "Example contract_management_contract 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.

201

Insurance contract created for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "payerConfigId": "00000000-0000-4000-8000-000000000001",
    "facilityId": "00000000-0000-4000-8000-000000000001",
    "contractName": "Example contract_management_contract",
    "contractNumber": "example-contractnumber",
    "effectiveDate": "2026-06-08T10:15:30Z",
    "terminationDate": "2026-06-08T10:15:30Z",
    "isActive": true,
    "baseRateType": "FEE_SCHEDULE",
    "baseRate": "example-baserate",
    "medicarePercent": "example-medicarepercent",
    "payer": {
      "id": "00000000-0000-4000-8000-000000000001",
      "payerName": "Example contract_management_contract",
      "payerId": "87726"
    },
    "facility": {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "Example contract_management_contract",
      "state": "example-state"
    },
    "rateSchedulesCount": 1,
    "createdAt": "2026-06-08T10:15:30Z",
    "updatedAt": "2026-06-08T10:15:30Z",
    "rateSchedules": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "rateType": "FEE_SCHEDULE",
        "code": "ERROR",
        "codeType": "example-codetype",
        "description": "Example contract_management_contract note",
        "rate": "example-rate",
        "ratePercent": "example-ratepercent",
        "perDiemRate": "example-perdiemrate",
        "caseRate": "example-caserate",
        "minRate": "example-minrate",
        "maxRate": "example-maxrate",
        "effectiveDate": "2026-06-08T10:15:30Z",
        "terminationDate": "2026-06-08T10:15:30Z",
        "isActive": true,
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "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.