You are here:
Customize the Timeline View (Managed Package Feature)
Add or remove healthcare events from the timeline view to give care coordinators and patients a chronological view of health care events. This topic applies to legacy Timeline, not Enhanced Timeline.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions with Health Cloud |
On the Timeline View Configurations tab, add events to the timeline by exposing fields on custom or standard objects. Then choose icons to represent the data on timeline.
Use filters to narrow down which events appear on the timeline and then specify which timeline the configuration applies to. So you can show only tasks with medium to high priority instead of including tasks that are assigned lower priorities. Or include medications on the timeline in the Health Cloud console and exclude them from the timeline that the patient sees in the site.
You can target a timeline configuration record to appear only in the Health Cloud console, only the Timeline for Health Cloud Empower, or in both. We’ve already added a filter on tasks that appears in both the console and the site.
Users can decide to show or hide tasks based on whether they are open or closed.
In your organization-wide sharing defaults, set the Timeline View Configuration and Filter Criterion objects to Public Read/Write in the Default External Access column. Use permission sets and profiles to give access to the fields you want to expose in the timeline.
- From the Health Cloud - Lightning Admin page, find and select the Timeline View Configurations tab, and click New.
-
Enter the following:
Field Description Timeline View Configuration Name Name of the timeline event. This name appears only on setup pages. Object Category Name of the category of objects that this event is related to. Use this field to create a group of events. This name appears in the Select All Events menu in the console timeline and the filter dropdown in the site timeline. By default, all preconfigured objects are either Engagement Data or Medical Data. Friendly Name Label that appears in the timeline for the event.
NoteThe text in this field isn’t available for localization using the Translation Workbench. To have this text appear in another language, clone the configuration record and enter the text using the language you want to display. Then, set the Language field of the new record to that language. You should also ensure that the cloned record has the same values for the Object, Position Field, Detail Field, and Filter Criterion fields as the original configuration record.
The system displays the label text that matches the user’s language setting.
Object Name Name of the object that contains the field that is shown in the timeline. To ensure correct results, use the exact spelling of the object—for example, EhrMedicationPrescription__c.
Detail Field Name of the field that holds the text you want to display as an event on the timeline.
For example, to display the name of a task, use the Subject field on the Task object. The text from the Subject field shows on the timeline along with the icon that you select for that type of timeline event. To display other fields from the object as hover text, add them to the Hover Field Name field.
Note This field isn’t used in the Timeline for Health Cloud Empower component.Hover Field Name Enter up to seven comma-separated field names from the object you want to display. The values from this field appear as hover text for an event on the timeline. For example, you can display fields like the due date, performer name, status, and the related problem for tasks. Make sure to use the API field name and not the field label. Valid field types are:
- Date
- Combobox
- Number
- Picklist
- Text
Note This field isn’t used in the Timeline for Health Cloud Empower component.Position Field Date field that the system uses to position the event chronologically on the correct date on the timeline. Graphical Icon Name of the image file that represents the event on the timeline. Upload the image file to the Health Cloud Assets folder in the Documents tab.
Note For images to display with the best results in the timeline, they must be within the recommended file and frame size. The recommended file size is up to 1 MB. Salesforce scales the image to roughly 48 x 48 pixels, so smaller images, and images with an aspect ratio of 1:1 (square) provide the best results.Sort Order Indicates the vertical order that the events appear when the timeline has more than one event on the same date. If you clone a configuration record so that you can localize the label, then also modify the sort order. Since you can’t have two records with the same assigned sort order, create a different version number for the new record. For example, if the English record has 3 in the Sort Order field, then assign the Spanish version 3.1.
Note This field isn’t used in the Timeline for Health Cloud Empower component.Active Select to activate this field and have it appear on the timeline. Patient Account Lookup Name of the lookup to display on the timeline when multiple lookups to Account exist. The default for this field is Account__c.
Note To use delivered Account lookups for standard objects like Contact or Task, you must append Id to the lookup field name. For example, to configure a lookup from Contact to Account, use AccountId in this field. Similarly, for a lookup from Task to What, use WhatId.Filter Criterion The name of the collection of filters that apply to this configuration. To create the filter logic for this specific configuration setting, use the Timeline Filter component at the bottom of the tab. Language The setting that specifies the language of the text in the Friendly Name field. Show on Load Select to have this event appear by default on the timeline when the page first loads.
All timeline configurations that have the Active checkbox selected are available to appear on the timeline when they’re selected using the events filter. But only those configuration records with the Show on Load setting selected appear on the timeline by default.
Configuration Target Select the timelines in which to display these fields. You can create one configuration record for patient sites and one for the Health Cloud console. To show the same fields in both the Health Cloud console and the Timeline for Health Cloud Empower component, select them both.
Note If you don’t see a field on the tab, add it to the Timeline View Configuration object’s page layout. You may also have to add it to the patient account lookup. Also be sure to configure visibility for each field according to your organization’s needs. -
Save your changes.
When you create a configuration record, the Timeline Filter doesn’t appear until you’ve saved the configuration.
- The Timeline Filter component comes with a default row. To add filters, click Add Row.
- In the first row, click inside the first lookup and type the name of the record to use as a filter. The field displays a dynamic list of matching records when you start typing in the lookup field.
-
In the second lookup field, type the name of the field in that record to display.
For example, select a priority level for tasks that you want to appear in the timeline.
-
Choose a filter operator.
The operator in a filter is like the verb in a sentence. Use an operator to specify the action you want the filter to take.
-
Enter a value to either match or exclude.
The values that appear in this field are dependent on the type of field you select. For example, if you select High Priority for tasks, a checkbox field with the value True appears.
Note There are some filter criteria limitations to consider.- None is not a value available in picklists.
- If you select an ID field as a criterion, make sure that you enter a valid ID. ID values are not validated.
- If you select a Date field as a criterion, make sure that you don't leave its value blank or null.
- Add more rows, if necessary.
-
If you have multiple filter rows, you can fine-tune your criteria further. Enter a logical
expression in the Filter Logic text box that applies filter logic
operators to your filters.
- You can apply the filter logic operators AND and OR. For example, the expression (1 AND 2) OR 3 finds records that match both Filter 1 and Filter 2, or Filter 3. Filter rows that you don't specify in the expression are ignored.
- If you leave the Filter logic text box empty, the default operator AND is applied to all your filter rows.
- Click Next.
- Enter the name for the list.
- Save your changes.
| Field | Description |
|---|---|
| Timeline View Configuration Name | Tasks |
| Object Category | Engagement Data |
| Friendly Name | Tasks |
| Object Name | Task |
| Detail Field | Subject |
| Hover Field Name | Subject, ActivityDate |
| Position Field | ActivityDate |
| Graphical Icon | timeline_icon_check_png |
| Sort Order | 3 |
| Active | Selected |
| Patient Account Lookup | WhatId |
| Filter Criterion | |
| Language | English (United States) |
| Show On Load | Selected |
| Configuration Target | Health Cloud Console App; Timeline For Health Cloud Empower |
- The patient timeline displays a maximum of 500 records.
- The records appear in descending order of the activity date and the last modified date.
- The patient timeline does not display archived records.

