CareProgram

Represents a set of activities, such as a patient therapy, financial assistance, education, wellness, or fitness plan, offered to participants by an employer or insurer.

Supported Calls 

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

Fields 

ActiveSiteCount 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of active sites for conducting the research study. This field is available in API version 64.0 and later when Site Management is enabled.

AnnounceDate 

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The date when the provider engagement compliance program becomes available to users.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

BudgetAmount 
  • Type: Currency
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Approved budget for the care program.

CancelDate 

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The date when the provider engagement compliance program cancels.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

CareProgramName 
  • Type: Text
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the care program.

Category 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Represents the category of the care program.

  • Possible values:

    • AdvancedTherapy
    • Patient Services (This field is available with Patient Program Outcome Management permission set in API version 62.0 and later.)
    • ProviderEngagementCompliance
    • TrialManagement (This field is available for the Participant Management feature in API version 61.0 and later.)

CurrentEnrolleeCount 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of enrollees who have joined the care program to date. This field is available for the Participant Management feature in API version 61.0 and later.

Description 
  • Type: Long Text Area
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A short description explaining the program.

EndDate 
  • Type: Date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Program termination date.

ExtensionEndDate 

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The date when the extended provider engagement compliance cycle ends.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

EnrollmentDurationMeasureId 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The unit of measure for the participant enrollment duration. This field is available in API version 64.0 and later when Site Management is enabled.

    This field is a relationship field.

  • Relationship Name: EnrollmentDurationMeasure

  • Refers To: UnitOfMeasure

EnrollmentRate 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The rate of the participant enrollment at the site. This is calculated by dividing the target enrollment count by the target enrollment duration and the number of planned sites. This field is available in API version 64.0 and later when Site Management is enabled.

FirstSiteClosedOutDate 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date on which the first site is closed out.

FirstSiteActivatedDate 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date on which the first site is activated for conducting research studies. This field is available in API version 64.0 and later when Site Management is enabled.

LastSiteActivatedDate 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date on which the last site is activated for conducting research studies. This field is available in API version 64.0 and later when Site Management is enabled.

LastSiteClosedOutDate 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date on which the last site is closed out. This field is available in API version 64.0 and later when Site Management is enabled.

LastReferencedDate 

  • Type: dateTime

  • Properties: Filter, Nillable, Sort

  • Description: The timestamp for when the current user last referenced a record related to this record.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

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.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

ModificationEndDate 

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The date until which users can edit activities related to the provider engagement compliance program.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

Name 

  • Type: string

  • Properties: Create, Filter, Group, idLookup, Sort, Update

  • Description: The name of the provider engagement compliance program.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

OwnerId 

  • Type: reference

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description: The ID of the user who owns this record.

    This field is a polymorphic relationship field.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

  • Relationship Name: Owner

  • Refers To: Group, User

ParentProgram 
  • Type: Lookup(Care Program)
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of another program that this program is a part of, if any.

ProgramSponsor 
  • Type: Lookup(Account)
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of the third-party program sponsor, if any.

PreCycleStartDate 

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The date when the provider engagement compliance pre cycle starts.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

PreferredContactPointType 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Specifies the preferred contact point type used to complete the provider engagement compliance cycle.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

SourceSystem 

  • Type: string

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The name of the system this record came from.

    This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process.

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

StartDate 
  • Type: Date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Effective start date of the program.

Status 

  • Type: Pick list

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

  • Description: Status of the program.

  • Default value: New

  • Possible values:

    • Canceled
    • Completed
    • In Progress
    • New

TargetEnrollmentDuration 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The duration in which the enrollment for the targeted number of participants must be completed. This field is available in API version 64.0 and later when Site Management is enabled.

TargetEnrolleeCount 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The target enrollee count of the care program. This field is available for the Participant Management feature in API version 61.0 and later.

TargetSiteCount 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of sites planned for conducting the research study. This field is available in API version 64.0 and later when Site Management is enabled.

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.

CareProgramChangeEvent (API version 59.0)

Change events are available for the object.

CareProgramFeed

Feed tracking is available for the object.

CareProgramHistory

History is available for tracked fields of the object.

CareProgramShare

Sharing is available for the object.

Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
CarePgmProvHealthcareProvider
CareProgram
CareProgramCampaign
CareProgramEligibilityRule
CareProgramEnrollee
CareProgramEnrolleeProduct
CareProgramEnrollmentCard
CareProgramGoal
CareProgramProduct
CareProgramProvider
CareProgramTeamMember
CareRegisteredDevice
CareSystemFieldMapping
EnrollmentEligibilityCriteria
Clinical Data Model
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
ProductRequest
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
Health Cloud Managed Package
Previous Versions