Salesforce Health Cloud Developer Guide
jNewer Version Available
Health Cloud Managed Package Aura Components
The Health Cloud managed package has many Aura components for handling different
functions. Aura components are the self-contained and reusable units of an application. They
represent a reusable section of the user interface, and can range in granularity from a
single-line of text to an entire app.
The managed package includes Aura components for performing various operations. The functionality of these components is built into the core Salesforce platform as part of the equivalent platform features, making the transition smooth for customers who migrate from the package to the platform. You can set up and customize these equivalent platform features according to your business needs. When planning to migrate data from the package to the platform, refer to the equivalent platform features listed in this table and contact your Salesforce admin for help.
| Package Component Name | Description | Equivalent Platform Feature |
|---|---|---|
| CareGaps.cmp | Displays unaddressed patient care opportunities or care gaps. The component uses a Lightning Card for visual containment and shows a header with a custom label and a standard icon. A child component retrieves and displays the care gap data. You can use this component on Lightning record pages and in any context with an available record ID. | None |
| CarePlanTasks.cmp | Tracks and measures patient activities, specifically tasks that address identified problems. This component provides an interface for managing and viewing patient-related tasks, likely within a care plan context. You can place it on record pages related to care plans, patients, or cases. The component functions best on record pages where the record ID represents a care plan or a closely related record for accessing care plan activities. | Integrated Care Management |
| CareTeamList.cmp | Presents details for members of a care team. The component includes a header with a label and icon, and a child component that shows the care team member details in a tabular format. You can use the component on Lightning record pages such as Case record pages. The component also works effectively on record pages where the record ID represents the relevant context for the care team. | Integrated Care Management |
| CareTeamMap.cmp | Shows a graphical view of relationships among a patient's care team members. You can use the component on Case record pages to visualize the network of individuals involved in a specific case's care. While the component implements record ID functionality, its primary purpose is to retrieve and display case record data. | Actionable Relationship Center |
| contactTracing.cmp | Displays all related household members and social contacts for a patient to assess the risk of contact infection. The component helps to visualize these relationships, such as in a network graph. You can place this component on a record page, such as a patient record, to visualize their related contacts. This component also functions well within the Salesforce Console environment. | Actionable Relationship Center |
| HcCandidatePatientListView.cmp | Allows users to view a list of candidate patients and open a workflow to convert candidate patients into actual patient records. This component is available on all types of Lightning pages including App pages, Home pages, and Record pages. The component facilitates reviewing and converting potential patient records. The component improves workflow for patient record management. | Referral Management |
| HcCarePlanTemplateContainer.cmp | Serves as a container for tabs, managing care plan templates and guides users through a multistep process within a Lightning Flow. Users use it to select, customize, and apply templates for creating or modifying care plans. The component is intended specifically for Lightning Flow screens and helps users navigate and manage templates in a guided flow experience. | Integrated Care Management |
| HcCommunityCarePlanPicker.cmp | Presents a list of care plan records for Health Cloud community users. Users use the component to select a care plan, which triggers further actions within the community. This component is available in Salesforce Communities and on all types of Lightning pages, including App pages, Home pages, and Record pages. | Integrated Care Management |
| HcCommunityCareTeamList.cmp | Displays a list of care team members for Health Cloud community users, showing the individuals involved in a patient's care within the community. Users can use this component in Salesforce Communities and on all types of Lightning pages including App pages, Home pages, and Record pages. The component adapts to the context of the record it's placed on, showing care teams related to specific patients or care plans. Users use this component in both community and internal Salesforce contexts. | Integrated Care Management |
| HcCommunitySurveyContainer.cmp | Acts as a container for surveys in communities and presents a list of available surveys. The component also lets users navigate to a detailed view of a specific survey and tracks the active view between the survey list and details. The component is primarily intended for Salesforce Communities. | Assessments |
| HcCommunityTaskList.cmp | Shows a list of tasks specifically for Health Cloud community users and allows them to view and interact with their assigned tasks. Users can filter tasks by predefined list views. Users can use this component in Salesforce Communities on any page, as well as on all types of Lightning pages including App pages, Home pages, and Record pages. Additionally, the component adapts its behavior based on the record ID it's placed on. | Integrated Care Management |
| HcCommunityTimeline.cmp | Displays a chronological timeline of key medical events for a patient within a community. Patients and providers can both edit events in the timeline. Users can view past, present, and future activities and apply filters on both desktop and mobile devices. Users use this component in Salesforce Communities and on all types of Lightning pages including App pages, Home pages, and Record pages. The component adapts to the specific record it's placed on. | Enhanced Timeline |
| HcPatientListView.cmp | Displays a list of patient records and lets users perform actions on them. You can use it on all types of Lightning pages, including App pages, Home pages, and Record pages. The component serves as a central interface for managing and interacting with patient records across Health Cloud. Therefore, it provides a versatile interface for patient list management. |
You can also create persona-specific list views in the platform. |
| HcTodayPageContainers.cmp | Acts as a container for patient minicards and focuses on tasks that are overdue, due for the current day, and due for the next day. Users can quickly identify and manage time-sensitive patient activities with the component. Users use this component on all types of Lightning pages, including App pages, Home pages, and Record pages. The component provides a dedicated page view for the current day and a consolidated view of patients needing immediate attention. | Use the persona-specific list views in Integrated Care Management, Referral Management, Utilization Management, and more. |
| PatientCard.cmp | Displays medical record field data and allows customization for specific organizational requirements. A separate component handles the actual data retrieval and display. You can add the component to Lightning record pages where displaying medical record information related to a record is relevant. The component functions best on record pages where the record ID can be used as the patient ID or to derive the patient ID. | Advanced Patient Card |
| PatientDetail.cmp | Displays navigation options, patient identifying information, and patient medical information, but this component is deprecated. The component currently functions as a container to show these three information types for a given patient. You can add the component to Lightning record pages representing a patient or related account. However, use the constituent child components for a more modular approach instead of this deprecated component. | Advanced Patient Card |
| PatientInfo.cmp | Displays essential patient identifying information, including a photograph. A custom component retrieves and renders the patient data. The component is suitable for Lightning record pages where displaying key patient identification details is necessary. The component's primary and most effective use is on record pages where the record ID directly corresponds to or easily identifies the patient. | Advanced Patient Card |
| PatientTimeline.cmp | Provides a chronological representation of key events from a patient's medical history. Both patients and providers can edit events directly within the timeline, based on access permissions. This component is supported on both desktop and mobile devices. You can embed the component on record pages where a patient's medical history timeline is relevant, such as Patient or related Account records. | Enhanced Timeline |