Salesforce Docs Portal

CareProgramEligibilityRule

Represents a rule defining the criteria for patient care program enrollment eligibility. This entity creates an association between Care Program and an Enrollment Eligibility Criteria.

Supported Calls

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

Fields

CareProgramId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Identifier of a care program. Represents a set of activities, such as therapy, wellness, or a fitness plan, offered to participants by a healthcare provider, life sciences organization, employer, or insurer.

EligibilityCriteriaId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Criteria that define patient enrollment eligibility for a care program.

IsInclusionRule

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the rule is included or excluded when determining care program eligibility. This field is available in API version 62.0 and later.
  • Default value: false

IsRequired

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the care program eligibility rule is required.

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.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, Sort
  • Description: Name for the care program eligibility rule.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The ID of the user who owns this record.

SourceSystem

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: System from which the record was sourced.

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the system from which the record was sourced.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Defines whether the eligibility rule is in force or not.

Type

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Type of the eligibility Rule. This field is available for the Participant Management feature in API version 61.0 and later.
  • Possible values:
    • Inclusion Rule
    • Exclusion Rule
    • Age Rule
    • Gender Rule

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.

CareProgramEligibilityRuleChangeEvent (API version 59.0)
Change events are available for the object.
CareProgramEligibilityRuleFeed
Feed tracking is available for the object.
CareProgramEligibilityRuleHistory
History is available for tracked fields of the object.
CareProgramEligibilityRuleOwnerSharingRule
Sharing rules are available for the object.
CareProgramEligibilityRuleShare
Sharing is available for the object.