Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Contracts

Fully replace an existing contract's data

Replaces the generalInfo/lifecycle/financial/administrativeAndLegal/clinicalAndQuality data of an existing Contract with the values supplied in the request body.

What it does: This is a full-replace operation for the contract's data sections - the stored data object is entirely overwritten with the request payload, not merged field by field, so any previously-set optional field left out of the request body is removed from the stored record. The contract's identity fields - id, planId, networkId, and documentId - are always preserved from the existing record; any values supplied for them in the request body are silently ignored, so this endpoint cannot be used to move a contract to a different plan or network. createdBy is likewise always preserved from the original record. updatedBy is set from the authenticated caller's user ID on every call.

When to use: Use this endpoint to update a contract you have previously created. There is no partial-update (PATCH) path for this resource - every call must supply the complete data payload, including the required generalInfo fields. Do not use this endpoint to create a new contract - use POST /contracts instead.

Preconditions: Requires the UPDATE_CONTRACT permission. The {id} path parameter is the server-assigned id of the contract to replace. generalInfo.contractId, contractName, contractType, and contractStatus are required in the request body; all other fields and sections are optional.

Response: Returns 200 OK with the full updated Contract object. This operation is not idempotent, since updatedBy changes on every successful call.

put/contracts/{id}

Path parameters

idstring required

Server-assigned id of the Contract to replace.

Headers

tenant-idstring required

Tenant ID that owns the contract being replaced.

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 updated Contract, with data fully replaced and updatedBy set to the caller.

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