Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Contracts

Create a new contract for the authenticated tenant

Creates a new Contract record and returns the persisted object with server-assigned identifiers.

What it does: Registers a new contract for the tenant identified by the tenant-id header. The server assigns id (a UUID); any id supplied in the request body is ignored and discarded before the request reaches storage. createdBy and updatedBy are always set from the authenticated caller's user ID - any values supplied in the body are ignored.

When to use: Use this endpoint to introduce a net-new contract. To modify an existing contract, use PUT /contracts/{id} instead.

Preconditions: Requires the CREATE_CONTRACT permission. documentId, networkId, and planId are required top-level identifiers (caller-supplied, not server-generated). Within generalInfo, contractId, contractName, contractType, and contractStatus are required; all other fields and sections are optional.

Response: Returns 201 Created with the full Contract object, including the server-assigned id. No async jobs, webhooks, or downstream events are triggered by this operation as of this writing.

post/contracts

Headers

tenant-idstring required

Tenant ID the new contract will belong to.

Request body

idstring

Server-assigned unique identifier (UUID). Ignored if supplied in a create request; on replace (PUT), the existing contract's id is always preserved regardless of what is sent.

planIdstring

Identifier of the plan this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's planId is always preserved.

networkIdstring

Identifier of the network this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's networkId is always preserved.

documentIdstring

Caller-supplied business document identifier for this contract. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's documentId is always preserved.

createdBystring

User ID of the caller who originally created the contract. Always set by the server from the authenticated caller on create; any value supplied in the request body is ignored. Preserved unchanged on every subsequent replace (PUT), regardless of the request body.

updatedBystring

User ID of the caller who most recently created or replaced the contract. Always set by the server from the authenticated caller; any value supplied in the request body is ignored.

Example request

{
  "id": "ctr_8a2f3e91",
  "planId": "plan_40921",
  "networkId": "network_58213",
  "documentId": "doc_2026_04821",
  "createdBy": "user_30172",
  "updatedBy": "user_58890",
  "generalInfo": {
    "contractId": "GC-2026-0417",
    "contractName": "Acme Health Network FFS Agreement",
    "contractTemplate": "Standard FFS Template v3",
    "contractRate": "100% Medicare",
    "reimbursementCode": "RC-1042",
    "contractType": "FFS",
    "contractStatus": "Active",
    "contractAgreementType": "Single",
    "groupId": "group_12345",
    "networkId": "network_58213",
    "planId": "plan_40921"
  },
  "lifecycle": {
    "contractEffectiveDate": "2026-01-01",
    "initialTermDate": "2027-01-01",
    "terminationInformedDate": "2026-11-01",
    "terminationDate": "2026-12-31",
    "billingEffectiveDate": "2026-01-01",
    "billingTerminationDate": "2026-12-31"
  },
  "financial": {
    "feeSchedule": "Medicare FFS 2026",
    "contractPaymentType": "Per Claim",
    "providerRateCalculation": "Standard Medicare fee schedule",
    "claimSubmissionCycle": "Monthly"
  },
  "administrativeAndLegal": {
    "practitionersTerminationNoticePeriod": "90",
    "providersManualUpdatesNoticePeriod": "60",
    "claimFilingLimit": "180 days from date of service",
    "reimbursementScheduleUpdateFrequency": "Quarterly",
    "timelyPaymentCommitment": 30
  },
  "clinicalAndQuality": {
    "averageStarsAndPmpmBonus": "4.5 stars / $10 PMPM",
    "performanceReportingRequirements": "Quarterly HEDIS and CAHPS reporting",
    "recredentialingInterval": "3 yr",
    "providerRosterUpdateFrequency": "Monthly"
  }
}

Response

The newly created Contract, including its server-assigned id.

idstring

Server-assigned unique identifier (UUID). Ignored if supplied in a create request; on replace (PUT), the existing contract's id is always preserved regardless of what is sent.

planIdstring

Identifier of the plan this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's planId is always preserved.

networkIdstring

Identifier of the network this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's networkId is always preserved.

documentIdstring

Caller-supplied business document identifier for this contract. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's documentId is always preserved.

createdBystring

User ID of the caller who originally created the contract. Always set by the server from the authenticated caller on create; any value supplied in the request body is ignored. Preserved unchanged on every subsequent replace (PUT), regardless of the request body.

updatedBystring

User ID of the caller who most recently created or replaced the contract. Always set by the server from the authenticated caller; any value supplied in the request body is ignored.

Example response

{
  "id": "ctr_8a2f3e91",
  "planId": "plan_40921",
  "networkId": "network_58213",
  "documentId": "doc_2026_04821",
  "createdBy": "user_30172",
  "updatedBy": "user_58890",
  "generalInfo": {
    "contractId": "GC-2026-0417",
    "contractName": "Acme Health Network FFS Agreement",
    "contractTemplate": "Standard FFS Template v3",
    "contractRate": "100% Medicare",
    "reimbursementCode": "RC-1042",
    "contractType": "FFS",
    "contractStatus": "Active",
    "contractAgreementType": "Single",
    "groupId": "group_12345",
    "networkId": "network_58213",
    "planId": "plan_40921"
  },
  "lifecycle": {
    "contractEffectiveDate": "2026-01-01",
    "initialTermDate": "2027-01-01",
    "terminationInformedDate": "2026-11-01",
    "terminationDate": "2026-12-31",
    "billingEffectiveDate": "2026-01-01",
    "billingTerminationDate": "2026-12-31"
  },
  "financial": {
    "feeSchedule": "Medicare FFS 2026",
    "contractPaymentType": "Per Claim",
    "providerRateCalculation": "Standard Medicare fee schedule",
    "claimSubmissionCycle": "Monthly"
  },
  "administrativeAndLegal": {
    "practitionersTerminationNoticePeriod": "90",
    "providersManualUpdatesNoticePeriod": "60",
    "claimFilingLimit": "180 days from date of service",
    "reimbursementScheduleUpdateFrequency": "Quarterly",
    "timelyPaymentCommitment": 30
  },
  "clinicalAndQuality": {
    "averageStarsAndPmpmBonus": "4.5 stars / $10 PMPM",
    "performanceReportingRequirements": "Quarterly HEDIS and CAHPS reporting",
    "recredentialingInterval": "3 yr",
    "providerRosterUpdateFrequency": "Monthly"
  }
}