Salesforce Docs Portal

FormularyItem

Represents details of products within the formulary, including the drug tier, coverage, and copay. This object is available in API version 65.0 and later.
Important

Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Supported Calls

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

Fields

CopayAmount

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The copayment amount for the product within the formulary.

Description

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The additional details of the formulary product record.

EffectiveEndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The effective end date of the product within the formulary.

EffectiveStartDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The effective start date of the product within the formulary.

FormularyId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The ID of the parent formulary record associated with the formulary item.

    This field is a relationship field.

  • Relationship Name: Formulary
  • Relationship Type: Master-detail
  • Refers To: Formulary (the master object)

HasQuantityLimit

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the product within the formulary has a quantity limit (true) or not (false).
  • Default value: false

ItemId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The ID of the product associated with the formulary.

    This field is a polymorphic relationship field.

  • Relationship Name: Item
  • Refers To: Product2

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the formulary item.

PriorAuthorizationRequiredType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of prior authorization required for the product within the formulary.

QuantityLimitDescription

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The detailed description of quantity limits the formulary imposes on a product. This may include a rolling dispense limit, maximum daily, or therapy days for a time period.

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The identifier of the record in the source system.

SourceSystemName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the system from which data is loaded into the object.

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the status of the product within the formulary.

StepTherapyLimitType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of step therapy required for the product within the formulary.

TierType

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the tier of the product within the formulary.

TotalCoveredLifeCount

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total number of patients covered for a product within the formulary.

TotalCoveredPharmacyLifeCount

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total number of pharmacy lives covered for a product within the formulary.

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.

FormularyItemFeed
Feed tracking is available for the object.
FormularyItemHistory
History is available for tracked fields of the object.