PurchaserPlan

Represents the payer plan that a purchaser makes available to its members and members’ dependents.

Supported Calls

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

Fields

Field Name Details
Affiliation
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
An affiliation to a government service, such as the army or navy.
EffectiveFrom
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from which this purchaser plan is effective.
EffectiveTo
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which this purchaser plan ceases to be effective.
IsVerifiable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a benefits verification can be performed on this plan.
LineOfBusiness
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The category of insurance policy that the purchaser plan belongs to. For example, whether the plan is a group health insurance, individual health insurance, etc.
This field is available in API version 64.0 and later.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of this plan.
Notes
Type
textarea
Properties
Create, Nillable, Update
Description
Notes about this payer.
Payer
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the payer’s Account object record.
PlanNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The plan’s reference number.
PlanStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates whether the plan is active.
PlanType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of plan, with the following default options:
  • PPO
  • HMO
  • Medicare
  • Medicaid
  • Workers Comp
ServiceType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the service type offered by this plan.
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the system this plan record came from.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of this plan record on its source system.
SourceSystemModified
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date on which this plan record was last changed on the source system.
SponsorType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of sponsor for the plan. For example, if it's self-sponsored, government-sponsored, or company-sponsored.
This field is available in API version 64.0 and later.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

PurchaserPlanFeed
Feed tracking is available for the object.
PurchaserPlanHistory
History is available for tracked fields of the object.
PurchaserPlanOwnerSharingRule
Sharing rules are available for the object.
PurchaserPlanShare
Sharing is available for the object.
PurchaserPlanChangeEvent
Change data capture is available for this object.