ContractsV2

Update contract

Beta
PATCH
https://api.joincandidhealth.com/api/contracts/v2/:contract_id

Path parameters

contract_id
UUID

Request

This endpoint expects an object.
rendering_provider_ids
optional set of UUIDs
A rendering provider isn't contracted directly with the payer but can render services under the contract held by the contracting provider. Max items is 100.
effective_date
optional string
The starting day upon which the contract is effective
expiration_date
optional union
An optional end day upon which the contract expires
regions
optional union
If present, the contract's rendering providers will be patched to this exact value, overriding what was set before.
contract_status
optional enum
Allowed values: pendingeffectivecancelled
authorized_signatory
optional union
commercial_insurance_types
optional union
medicare_insurance_types
optional union
medicaid_insurance_types
optional union

Response

This endpoint return an object.
commercial_insurance_types
union
The commercial plan insurance types this contract applies.
contract_id
UUID
contracting_provider
object
The provider under contract
effective_date
string
The starting day upon which the contract is effective
medicaid_insurance_types
union
The Medicaid plan insurance types this contract applies.
medicare_insurance_types
union
The Medicare plan insurance types this contract applies.
provider_count
integer
The number of linked providers who can render medical services under this contract
regions
union
The state(s) to which the contract's coverage extends. It may also be set to "national" for the entirety of the US.
rendering_provider_ids
set of UUIDs
The providers who can render medical services under the contract
authorized_signatory
optional object
contract_status
optional enum
Allowed values: pendingeffectivecancelled
expiration_date
optional string
An optional end day upon which the contract expires
payer
optional object
The insurance company under contract

Errors

PATCH
/api/contracts/v2/:contract_id
curl -X PATCH https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"commercial_insurance_types": {
"type": "allApply"
},
"contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"contracting_provider": {
"employment_status": "ACTIVE",
"is_billing": true,
"is_rendering": true,
"license_type": "MD",
"npi": "string",
"organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"provider_type": "INDIVIDUAL",
"addresses": [
{
"address": {
"address1": "string",
"city": "string",
"state": "AA",
"zip_code": "string",
"zip_plus_four_code": "string",
"address2": "string"
},
"address_type": "DEFAULT"
}
],
"employment_start_date": "string",
"employment_termination_date": "string",
"first_name": "string",
"last_name": "string",
"medicaid_provider_id": "string",
"organization_name": "string",
"ptan": "string",
"tax_id": "string",
"taxonomy_code": "string"
},
"effective_date": "string",
"medicaid_insurance_types": {
"type": "allApply"
},
"medicare_insurance_types": {
"type": "allApply"
},
"provider_count": 0,
"regions": {
"type": "states",
"states": [
"AA"
]
},
"rendering_provider_ids": [
"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
],
"authorized_signatory": {
"first_name": "string",
"last_name": "string",
"title": "string",
"email": "string",
"phone": "string",
"fax": "string"
},
"contract_status": "pending",
"expiration_date": "string",
"payer": {
"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer_id": "string",
"payer_name": "string"
}
}