Add Objects to the Health Timeline

Learning Objectives

After completing this unit, you’ll be able to:
  • Describe which objects you can add to the timeline.
  • Set up an icon for a timeline object.
  • Add an object to the timeline.


As part of his work at Bloomington Caregivers, a home healthcare agency, patient manager Leif Hansen organizes therapy sessions for patients with memory problems. In these sessions, patients take part in activities that help with memory problems, such as crafting, learning languages, playing bridge, and doing crosswords puzzles.

To help Leif track his clients’ attendance at these sessions, Harryette Randall, the Salesforce admin at Bloomington Caregivers, created a custom object called Therapy Session. This object includes fields where the therapists running the sessions can record client attendance, the date of the session, and the activity the client participated in.

This therapy sessions object includes these fields.

Field Label Field Name Data Type Description
Created By CreatedById Lookup(User) The user who created this therapy session record
Duration Duration__c Number(2, 1) The duration of the therapy session
Last Modified By LastModifiedById Lookup(User) The user who last modified this therapy session record
Owner OwnerId Lookup(User,Group) The user who owns this therapy session record
Patient Patient__c Lookup(Account) The patient this therapy session record is for
Session Date Session_Date__c Date/Time The date and time this therapy session took place
Therapy Session Name Name Auto Number A unique number for this therapy session record
Therapy Type Therapy_Type__c Picklist The type of activity undertaken in the therapy session
Visible on Patient Card HealthCloudGA__IsVisibleOnPatientCard__c Formula (Checkbox) A flag to indicate that this record can appear in the patient card

The Health Timeline

The Health Timeline provides a convenient way for healthcare professionals to visualize the events that affect their patients. It can appear in the Health Cloud console, the patient site, or both. The timeline shows events (1), each highlighted with an icon (2) to denote its type, and offering extra detail (3) when the user hovers over it with the mouse.

Users can include just the right amount of detail by selecting which events to include (4), the start date (5), and the display period (6).

An overview (7) shows how the timeline window fits in with the patient’s full event history.

By default, the timeline is configured to show common events such as assessments, prescriptions, and lab results.

Timeline showing the features described in the text

So Leif and the other caregivers can get a better impression of their patients’ participation in the therapy sessions, he would like to add events from the Therapy 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—like the Therapy Session object—as long as it has that link to the patient’s Account object record. The Therapy Session custom object includes a lookup to the Account object (Patient__c).

Harryette talks to Leif to find out how he wants the timeline set-up.

Determine Where and How Timeline Items Appear

Does Leif want new timeline items to appear in the patient site, the Health Cloud console, or both? Leif says he would like therapy sessions to appear on both timelines. Harryette then explains that Leif can have different information from the new object displayed on the timeline in patient sites and the Health Cloud console. However, Leif is happy for both timelines to display the same information.

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 dropdown in the site timeline.

The Select All Events picklist showing the list of events to be filtered

By default, all items on the timeline are in either the Engagement Data or Medical Data category. Leif asks Harryette for the Therapy Session object to appear in a new category called Therapy.

Determine Timeline Items and Hover Text

Each item on the timeline displays the content of a field from its underlying object. And each timeline item can display up to seven other fields when a user hovers over that item.

Hover-over displays additional information about the timeline item

Leif asks Harryette for the type of therapy session to appear as the item’s timeline label and for the session duration to display as hover text. So Harryette decides that the type of therapy session is represented by the Therapy_Type__c field and the session duration by Duration__c. Harryette also makes sure to note the API field name, not the field label, for the items Leif wants added, because she needs to manually enter those values when she sets up the timeline configuration.

Harryette asks Leif if he wants all the therapy session types to show on the timeline, or just some of them. She informs Leif that he can filter the therapy sessions by any field, such as duration or type. But Leif says he wants to see all the therapy types on the timeline, so Harryette doesn't need to filter any of them.

Choose Icons for Events on the Timeline

Health Cloud uses an icon to indicate the type of object shown on the timeline. Leif would like the icon for therapy sessions to include a craft or game motif.

Timeline showing an icon used to represent the timeline object type

Now that she has a good idea of what Leif wants in the timeline for the Therapy Session custom object, Harryette gets to work setting up the timeline.

Load a Custom Timeline Icon

Harryette knows that the timeline uses a 12 x 12-pixel icon, but that Health Cloud scales a larger icon to this size. She creates a 48 x 48-pixel icon, so she has the flexibility to use it elsewhere if needed.

Here’s how Harryette loads the custom icon.

  1. Switch to Salesforce Classic.
  2. From the Health Cloud Admin home page, select Documents and click New.
  3. Provide the following values and settings on the Upload New Document page:
    1. Document Name: Therapy timeline logo (if Harryette left this field blank, Health Cloud would automatically add the icon file name when the file uploads).
    2. Externally Available Image: Select
    3. Folder: Health Cloud Assets
    4. Description: Timeline icon for therapy sessions
    5. Keywords: timeline, therapy, session
  4. In the Select the File section, click Browse and locate and open the icon file.
  5. Make a note of the Document Unique Name, to add as the Graphical Icon name in the timeline view configuration.
  6. Click Save and return to Lightning Experience.

Add a Timeline View Configuration

Using the details from her conversation with Leif, Harryette proceeds to set up the timeline configuration. Here’s how.

  1. From the Health Cloud Admin home page, select Timeline View Configurations and click New.
  2. Provide these values and settings.
    1. Timeline View Configuration Name: Therapy Sessions
    2. Object Category: Therapy
    3. Friendly Name: Therapy Sessions
    4. Object Name: Therapy_Session__c
    5. Detail Field: Therapy_Type__c
    6. Position Field: Session_Date__c
    7. Graphical Icon: Therapy_timeline_logo (good thing she set that up first!)
    8. Sort Order: 3
    9. Active: Select
    10. Patient Account Lookup: Patient__c
    11. Language: English (United States)
    12. Show on Load: Select
    13. Configuration Target: Select Health Cloud Console App and Timeline For Health Cloud Empower
    14. Filter Criterion: Leave blank
    15. Hover Field Name: Duration__c
  3. Click Save.

Details entered to create a new timeline view configuration

Harryette noted that on saving the configuration record, Health Cloud displays a new section, the Timeline Filter component. If Leif had wanted only some types of therapy sessions to appear on the timeline, this section is where Harryette would have set up the necessary filters. But since Leif wants to see all the therapy session types, she doesn't need to add filters.

Now, the next time Leif visits one of his patients’ timeline views, he sees details of the therapy sessions the patient has attended.

Therapy session displayed on the Health Timeline

Keep learning for
Sign up for an account to continue.
What’s in it for you?
  • Get personalized recommendations for your career goals
  • Practice your skills with hands-on challenges and quizzes
  • Track and share your progress with employers
  • Connect to mentorship and career opportunities