Newer Version Available

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

Care Plan Tasks for Health Cloud Empower Component

The Care Plan Tasks for Health Cloud Empower component (HcCommunityTaskList) lets users see tasks associated with a care plan. Members can view only their own tasks, and they can filter the task list to keep track of which tasks are completed.
Table 1. Care Plan Tasks Component Attributes
Attribute Field Label Type Description
carePlanId string ID of the care plan or case for a given care team.
patientId string The account ID of the patient for whom list of care plan tasks need to be shown. Setting the patientId shows all tasks for the patient (when they have multiple). Setting the carePlanId only shows the details for the referenced care plan. If both are set we prioritize carePlanId and show only one list of care plan tasks.
taskFieldSet Field Set Name string Name of the field set that contains the fields you want to display for tasks. The default is HcCarePlanTaskFields (which is part of the Health Cloud managed package).
showLabels Show labels boolean Boolean attribute to toggle visibility of the labels that appear in the task list. Default: true
showAll Show all tasks boolean Toggle visibility of all tasks. (Currently unavailable and has no effect.) Default:true
Table 2. Care Plan Tasks Component Events Handled
Name (Type) Attributes (Type) Description
HcCommunityEventCarePlanSelected (Application)
  • carePlanId (string)
  • patientId (string)
Event that is fired when a care plan option is selected in the Health Cloud Care Plan Picker component.
HcCommunityGlobalEvent
  • taskId (string)
  • selected (boolean)
Event used to update the status of a task when it is checked.
Use Alongside Another Component

This component has an event handler for HcCommunityEventCarePlanSelected event.

Your custom component needs to fire the HcCommunityEventCarePlanSelected event that this component handles. The value passed in the event is CaseId (type string). The Health Cloud package provides the Care Plan Selector component, which registers and fires the HcCommunityEventCarePlanSelected event with CaseId.

Use as a Child or Nested Component

This component requires carePlanId (type string) (or accountId or patientId) as input from its parent component. The value of carePlanId must be a valid CaseId value.

Use in a Case Record or Account Page

You can use this component in a Lightning record page for the Case and Account object. The Case or Account record page fires the Aura attribute force:hasRecordId that this component handle.