ContractPaymentAgreement

Stores information about the contract payment agreement associated with a contract. This object is available in API version 54.0 and later with the Provider Network Management permission set license.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AgreementType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The payment type supported in the contract payment agreement.
Possible values:
- Bundled Care Fee Agreement
- Capitation Care Fee Agreement
- Categorized Care Fee Agreement
- Percentile Based Care Fee Agreement
- Preventive Care Agreement
- Shared Saving Payment Agreement
- Standard Care Fee Agreement

ContractId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The contract associated with the contract payment agreement.

This is a relationship field.
Relationship Name: Contract
Relationship Type: Master-Detail
Refers To: Contract

ContractPaymentAgreementKey

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: A unique key assigned to the Contract Payment Agreement record.

Description

Type: textarea
Properties: Create, Nillable, Update
Description: The description of the contract payment agreement.

EligibleProcedureCodeList

Type: textarea
Properties: Create, Nillable, Update
Description: The procedure codes that are covered in the contract payment agreement. This value is applicable for Capitation and Shared Savings payment type.

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date until when the contract payment agreement is effective.

FeeScheduleDefinitionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The fee schedule definition record associated with the contract payment agreement. This value is applicable only for Fee-for-Service payment types.

This is a relationship field.
Relationship Name: FeeScheduleDefinition
Relationship Type: Lookup
Refers To: FeeScheduleDefinition

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced the record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed the record.

LineofBusiness

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The line of business to which the contract payment agreement is applicable.
Possible values:
- Commercial
- Medi-Cal
- Medicaid
- Medicare

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the contract payment agreement associated with the contract.

StandardFeeCalculationPercentage

Type: percent
Properties: Create, Filter, Nillable, Sort, Update
Description: The percentage of the baseline fees of the fee schedule definition that’s used to calculate the negotiated fees for the Fee-for-Service payment types.

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date from when the contract payment agreement is effective.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The status of the contract payment agreement.
Possible values:
- ACTIVATED—Activated
- DEACTIVATED—Deactivated
- DRAFT—Draft

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ContractPaymentAgreementFeed: Feed tracking is available for the object.
ContractPaymentAgreementHistory: History is available for tracked fields of the object.
ContractPaymentAgreementChangeEvent (API version 61.0): Change events are available for the object.