PlanBenefit
Represents the standard benefits available under a plan that the purchaser offers to their members.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information about the benefits available to members under this plan’s coverage.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Information about the contribution a member makes towards treatment.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information on the copayment amounts that members contribute.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information about a member’s deductibles.
- Type: url
- Properties: Create, Nillable, Update
- Description: Hyperlink to internal or external resources.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date on which these benefits are communicated to plan members.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date on which these benefits become effective.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date on which these benefits ceased to be effective.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: Patient’s portion of payment for using emergency department services.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member pays for health care provided by the health plan’s preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during a coverage year for health care provided by the health plan’s preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but is in addition to premiums.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member pay for health care provided by non-preferred providers for all family members before this plan starts to contribute towards treatment.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during a coverage year for health care provided by non-preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but is in addition to premiums.
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-
Description: The frequency type of the plan benefit associated with the home healthcare visit.
This field is available in API version 66.0 and later with the Home Health add-on license.
-
Possible values:
DailyFortnightlyMonthlyQuarterlyWeeklyYearly
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member pays for health care provided by the health plan’s preferred providers to any one family member. When this amount is reached, the plan starts to contribute towards treatment.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during a coverage year for health care provided by the health plan’s preferred providers for any one family member. It includes deductibles, copayments, and coinsurance, but excludes premiums.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member pays for health care provided by non-preferred providers to any one family member before this plan starts to contribute towards treatment.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during a coverage year for health care provided by non-preferred providers for any one family member. It includes deductibles, copayments, and coinsurance, but excludes premiums.
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member contributes towards each treatment undertaken by the health plan’s preferred providers.
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The percentage of treatment cost the member pays for each treatment undertaken by the health plan’s preferred providers.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during the lifetime membership on this plan for health care provided by the health plan’s preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums.
- Type: datetime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed a record related to this record.
- Type: datetime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information about a member’s maximum lifetime payments.
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Description: Name of these plan coverage benefits.
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member contributes towards treatment undertaken by non-preferred providers.
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The percentage of treatment cost the member pays for treatment undertaken by non-preferred providers.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The most a member pays during the lifetime membership on this plan for health care provided by non-preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums.
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information about the out-of-pocket payment a member makes.
- Type: reference
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The ID of the user who owns this record.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member contributes towards primary care treatment.
- Type: reference
- Properties: Create, Filter, Group, Sort
- Description: The ID of the purchaser plan offering these benefits.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the system this benefits record came from.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of this benefits record on its source system.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date on which these benefits were last changed on their source system.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member contributes towards specialist consultations.
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The status of these benefits. The default the picklist
-
Possible values:
- Active
- Inactive
-
Type: currency
-
Properties: Create, Filter, Nillable, Sort, Update
-
Description: The total amount of the plan benefit associated with the home healthcare visit.
This field is available in API version 66.0 and later with the Home Health add-on license.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The amount a member contributes towards urgent care.
This object has the following associated objects. Unless noted, they are available in the same API version as this object.
- PlanBenefitChangeEvent (API version 60.0)
Change events are available for the object.
- PlanBenefitFeed
Feed tracking is available for the object.
- PlanBenefitHistory
History is available for tracked fields of the object.
- PlanBenefitOwnerSharingRule
Sharing rules are available for the object.
- PlanBenefitShare
Sharing is available for the object.