Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Care Plan Selector for Health Cloud Empower Component

The Care Plan Selector for Health Cloud Empower component (HcCommunityCarePlanPicker) lets users select a patient or member’s care plan.

If the user has access to only one care plan, the plan is selected automatically. When a user is a member of multiple care teams, the picklist shows all the user’s plans. If the user doesn’t belong to any care team, the picklist doesn’t appear. Only users who are members of the care team or the owner of the care plan can see the plan.

Includes only case record types that are in the Care Plan Record Type custom metadata records.

In the tables, the labels listed reflect the field in the Experience Builder and the Lightning App Builder. Attributes that do not have a label use a default, unless set by a custom use of the component.

Note

Table 1. Care Plan Selector Component Attributes
Attribute Field Label Type Description
carePlans map[] List of care plan IDs and descriptions. If no value is set, the attribute is populated with values based on other selections and the list obtained from a SOQL query.
picklistDefaultOptionText Placeholder text for picklist string Enter the text to display in the picklist before anything is selected. The default is Select a name and care plan... Placeholder text can’t be translated using the Translation Workbench.
showBirthDate Show birthdate boolean Add the person's birthdate to the picklist in addition to their name and the care plan name. Default is false.
includeYearOfBirth Include birth year boolean Include year of birth. Default is true.
useMonthText Show birth month as text boolean Show the person's birth month as text, such as Jan or Feb. Default is true.
includeAllCarePlanOption Show all care plans boolean Add an item to a picklist to show details for all care plans at once when the user has multiple care plans. ALL CARE PLANS is shown as the name of the care plan. Default is true.
Table 2. Care Plan Selector Component Events Handled
Name (Type) Description
forceCommunity:routeChange (Application) When a user navigates within the site, the navigation change is captured. The care plan selector fires the eventCarePlanSelected event to keep all components in sync with the currently selected option.
Table 3. Care Plan Selector Component Events Fired
Name (Type) Attributes (Type) Description
HcCommunity:EventCarePlanSelected (Application)
  • carePlanId (string)
  • patientId (string)
 Fire this event when an option is selected or changed so that dependent components are kept in sync.

Usage

This component registers and fires on an event called HcCommunityEventCarePlanSelected.

If you build a component that responds to the user selection at runtime, include an event handler for the HcCommunityEventCarePlanSelected event.

The Health Cloud package provides two Lightning components, Care Team List and Care Plan Picker, that handle this event.