Add Objects to the Health Timeline
Learning Objectives
- Set up fields for an object you add to the timeline.
- Select an icon for a timeline object.
- Add an object to the timeline.
List the Fields for a Custom Object
Leif Hansen is a patient manager for the Bloomington Caregivers home healthcare agency. As part of his work there, Leif organizes counseling sessions for patients with anxiety. In these sessions, patients opt for treatments such as behavioral therapy, cognitive behavioral therapy, psychodynamic therapy, and music therapy.
To help Leif track his clients’ attendance at these sessions, Harryette Randall, the Salesforce admin at Bloomington Caregivers, created a custom object called Counseling Session. This object includes fields where the therapists running the sessions can record the patient’s attendance, the date of the session, and the treatment the patient opted for.
The counseling session object includes these fields.
| Field Label | Field Name | Data Type | Description |
|---|---|---|---|
| Created By | CreatedById | Lookup(User) | The user who created the counseling session record |
| Duration | Duration__c | Number(2, 1) | The duration of the counseling session |
| Last Modified By | LastModifiedById | Lookup(User) | The user who last modified the counseling session record |
| Owner | OwnerId | Lookup(User,Group) | The user who owns the counseling session record |
| Patient | Patient__c | Lookup(Account) | The patient who attended the counseling session |
| Session Date | Session_Date__c | Date/Time | The date and time of the counseling session |
| Session Name | Name | Auto Number | A unique number for the counseling session record |
| Session Type | Session_Type__c | Picklist | The type of treatment undertaken in the counseling session |
| Visible on Patient Card | Is_Visible_on_Patient_Card__c | Formula (Checkbox) | A flag to indicate that the counseling session record can appear in the patient card |
The Health Timeline
The Health Timeline enables healthcare professionals to visualize and track the events that affect their patients. The timeline appears in both the Health Cloud console and the Experience Cloud site. The timeline includes these components.
- An event (1), such as a dental appointment and medical check-up.
- Type of event, (such as a screening or an x-ray), represented by an icon (2).
- Details for each event (3).
- Select All Events filter (4), to select a specific event to track.
- Start Date (5) for the timeline (allows you to zoom in on a specific time frame).
- Days to Show (6): Controls the number of days displayed in the timeline.
- Visual representation of the patient's entire history (7), highlighting the time frame for which events are displayed in the event view.
Leif and the other caregivers want a better impression of their patients’ participation in the counseling sessions. So, Leif would like to add events from the Counseling Session custom object to the timeline.
Define the Object’s Timeline Configuration
The timeline can display details from any object related to the patient through the Account object. The object can be a core Salesforce object, a Health Cloud object, or a custom object—such as the Counseling Session object—as long as it has that link to the patient’s Account object record. The Counseling Session custom object includes a lookup to the Account object (Patient__c).
Harryette talks to Leif to find out how he wants to set up the timeline. For hands-on experience setting up a custom object, take the Customize Patient Data Displays project.
Determine Timeline Categories
Every item on the health timeline belongs to a category. That’s how Leif can filter the timeline content using the Select All Events picklist in the console timeline or the filter in the Experience Cloud site timeline.
By default, all items on the timeline are in either the Engagement Data or Medical Data category. Leif asks Harryette to add the Counseling Session object to a new category called Counseling.
Determine Timeline Items and Hover Text
Each item on the timeline displays the content of a field from the item’s underlying object. And each timeline item can display up to seven fields when a user hovers over that item.
Leif asks Harryette to display the type of counseling session as the item’s timeline label, and to display the session duration as hover text. Harryette determines that the type of counseling session is represented by the Session_Type__c field and the session duration is captured in the Duration__c field. Harryette also makes sure to note the API field name, not the field label, for the items Leif wants to add. She must manually enter those values when she sets up the timeline configuration.
Harryette asks Leif if he wants all the counseling session types to show on the timeline, or just some of them. She informs Leif that he can filter the counseling sessions by any field, such as duration or type. But Leif says he wants to see all the session types on the timeline, so Harryette doesn’t filter any of them.
Load a Custom Timeline Icon
For events related to counseling sessions, such as appointments and session dates, Harryette wants to select an icon that resembles a calendar. The icon must be square in shape, the image file must be less than 1 MB. Harryette also knows that the timeline uses a 12 x 12 pixel icon, and that Health Cloud scales a larger icon to this size. She creates a 48 x 48 pixel icon, so that she can use it elsewhere.
Add a Timeline View Configuration
Using the details from her conversation with Leif, Harryette proceeds to set up the timeline configuration. Here’s how.
- From Health Cloud - Lightning Admin, select Timeline View Configurations and click New.
- Define a timeline view configuration:
- Timeline View Configuration Name:
Counseling Sessions - Object Category:
Counseling - Friendly Name:
Counseling Sessions - Object Name:
Counseling_Session__c - Detail Field:
Session_Type__c - Hover Field Name:
Duration__c - Position Field:
Session_Date__c - Graphical Icon: Add the icon name
- Sort Order:
1 - Active: Selected
- Patient Account Lookup:
Patient__c - Filter Criterion: Blank
- Language: English (United States)
- Show on Load: Selected
- Configuration Target: Select Health Cloud Console App and Timeline For Health Cloud Empower
- Timeline View Configuration Name:
- Click Save.
The next time Leif visits one of his patients’ timeline views, he sees details of the counseling sessions the patient has attended.
We know you’d love to do these steps yourself. So complete the Customize Patient Data Displays project to add an icon, set up the timeline view configuration, and more!
