Salesforce Docs Portal

HealthPlanFormularyItem

Represents which drugs, medical devices, or services are covered under specific insurance products within defined time periods. Each record establishes a relationship between Product2 insurance plans and FormularyItem records. This object is available in API version 68.0 and later.

Supported Calls

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

Fields

EffectiveFromDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the date when the formulary item becomes covered under the product.

EffectiveToDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the date when the formulary item is no longer covered under the product.

FormularyItemId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The Formulary Item record associated with the Product Formulary Item Coverage.
  • Referenced Objects:
    • FormularyItem

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

  • 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.

MedicationId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Medication record associated with the Product Formulary Item Coverage.
  • Referenced Objects:
    • Medication

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the medication or formulary item covered associated with the Product Formulary Item Coverage.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the record owner.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

ProductId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The Product2 record that defines the insurance plan associated with this Product Formulary Item Coverage.
  • Referenced Objects:
    • Product2

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.

HealthPlanFormularyItemChangeEvent
Change events are available for the object.
HealthPlanFormularyItemFeed
Feed tracking is available for the object.
HealthPlanFormularyItemHistory
History is available for tracked fields of the object.
HealthPlanFormularyItemOwnerSharingRule
Sharing rules are available for the object.
HealthPlanFormularyItemShare
Sharing is available for the object.