Care plan details
Out of the box, the CarePlan (PJN_CarePlan
) Lightning record page is divided into the following sections to organize the different information on a Care Plan (Case
) record:
Note
Several care plan components were updated from Aura components to Lightning Web Components (LWCs) in Komodo Care Connect V2.2.0. With the update, some of the steps to customize and configure Care Plan record pages have also changed and are detailed in the sections below as well as in the V2 release notes.
Care plan progress
The care plan progress section provides a visual presentation of a patient's progress in a program journey and displays details related to the care plan and selected stage.
Progress bar and stages
The progress bar at the top of the section shows the program problems, or stages, of the care plan as defined on the Program Problem (mvn__PJN_Program_Problem__mdt
) custom metadata type. In Komodo Care Connect V2.2.0 and above, the progress bar is the standalone Care Plan Path (pjnCarePlanPath
) Lightning Web Component. In Komodo Care Connect V2.1.5 and below, the progress bar is grouped together with several highlighted and key fields in the PJN_CarePlanPath Aura component. For more information about the fields, reference the Highlighted and key fields section below.
Care plan stages can be either standard, optional, or both. Standard stages are identified and sorted by the Order (mvn__PJN_Order__c
) field and immediately appear in the progress bar when the care plan is created. Optional stages are identified and sorted by the Library Order (mvn__PJN_Library_Order__c
) field, appear in the stage library, and can be added to the actual care plan path as needed. To add an optional stage into the care plan path, click the plus () icon at the far right of the progress bar to open the care plan stage library. Once selected, the optional stage will be added to the end of the progress bar.
Note
If a Program (mvn__PJN_Program__mdt
) metadata record is configured to automatically add a stage to the care plan path to capture missing information when missing information is detected, that stage will appear in the default progress bar when the care plan is created, even if the Program Problem metadata record does not have an Order value. For more information on the configuration of this stage, reference Missing information.
Stages are always initiated sequentially such that the next stage will only be automatically initiated if all of the current Open
stages are completed. However, if the Is Startable (mvn__PJN_Is_Startable__c
) field on the Program Problem metadata record is set to true
, then users can manually start the stage at any time by hovering over the stage in the progress bar and clicking the start () icon. The status of the stage will then be Open
. Additionally, if the Is Skippable (mvn__PJN_Is_Skippable__c
) field or the Is Removable (mvn__PJN_Is_Removable__c
) field on the Program Problem metadata record is set to true
, then users can click the skip () icon or the delete () icon to skip or remove the stage, respectively. When a stage is skipped, the stage and its related activities are Cancelled
and either a skip icon or a check icon will appear in place of the stage name depending on if the Komodo Care Connect instance is V2.2.0 and above or V2.1.5 and below. When a stage is removed, the stage and its activities are deleted. A stage can only be removed if it has not yet been initiated. To hide all action icons from the progress bar in Komodo Care Connect V2.2.0, reference the Hide progress bar icons section below.
To complete a stage, complete all of its activities such that status of all the PJN_Activity
Case records in the stage is Closed
or Cancelled
. Activities can either be defined by the Program Case (mvn__PJN_Program_Case__mdt
) custom metadata type or created ad hoc in the stage. The activities within each stage are displayed in the Activities, notes, and files section in the record page. Once a stage is completed, the status of the stage will be Closed
.
The color of each stage in the progress bar depends on the stage's state or Status field on the Problem (HealthCloudGA__CarePlanProblem__c
) record:
The currently selected stage is dark blue.
An
Open
stage, or the currently active stage, is white.A
Planned
stage, or an upcoming stage, is light gray.A
Closed
stage, or a completed stage, is green.
Hide progress bar icons
While the Program Problem (mvn__PJN_Program_Problem__mdt
) custom metadata type can configure if a care plan stage is startable, skippable, or removable, the Care Plan Path component in Komodo Care Connect V2.2.0 and above lets you hide all of the action icons from the progress bar completely. To hide all of the action icons so that users cannot manually start, skip, or remove any care plan stage, open the Care Plan Path component in the Lightning App Builder and check the Hide Problem Actions field.
You can also override the skip () icon that appears in Komodo Care Connect V2.2.0 and above for care plan stages that were skipped. To hide the skip icon and show a check icon for all completed and skipped stages, open the Care Plan Path component in the Lightning App Builder and check the Hide Skipped Icon field.
Highlighted and key fields
Highlighted fields and key fields both show important information about a care plan, care plan stage, and/or program. The former appears as light grey tiles with configurable icons and can surface data from both Care Plan (Case
) and Problem (HealthCloudGA__CarePlanProblem__c
) fields while the latter appears as standard fields and can only surface data from Case fields. In Komodo Care Connect V2.2.0 and above, highlighted fields can appear in either the Care Plan Highlighted Fields (pjnCarePlanHighlightedFields
) component, the Care Plan Problem Info (pjnCarePlanProblemInfo
) component, or both while key fields can only appear in the Care Plan Problem Info component. Similarly, in Komodo Care Connect V2.1.5 and below, highlighted fields can appear in either the PJN_CarePlanPath Aura component, the PJN_CarePlanStatus Aura component, or both while key fields can only appear in the PJN_CarePlanPath Aura component.
Configure highlighted fields in Komodo Care Connect V2.2.0 and above
In Komodo Care Connect V2.2.0 and above, highlighted fields are defined on the Care Plan Field (mvn__PJN_Care_Plan_Field__mdt
) custom metadata type and grouped by the Care Plan Field Group (mvn__PJN_Care_Plan_Field_Group__mdt
) custom metadata type. If the configured Care Plan Field Group metadata record is related to the Program (mvn__PJN_Program__mdt
) metadata record of the care plan, then the highlighted fields can be added to the Care Plan Highlighted Fields component. If the configured Care Plan Field Group metadata record is related to a Program Problem (mvn__PJN_Program_Problem__mdt
) metadata record, then the highlighted fields can be added to the Care Plan Highlighted Fields component as well as appear in the Care Plan Problem Info component.
To define and show Care Plan or Problem fields as highlighted fields in the Care Plan Highlighted Fields component, such as to display general information about a patient in a care program:
Create a Care Plan Field Group metadata record to group all of the fields that should appear in the Care Plan Highlighted Fields component.
Create a Care Plan Field metadata record for each field that should appear in the Care Plan Highlighted Fields component.
On the Care Plan Field Group (
mvn__PJN_Care_Plan_Field_Group__c
) field, add the Care Plan Field Group metadata record created in step 1.On the Field API Name (
mvn__PJN_Field_API_Name__c
) field, enter the API name of the Care Plan or Problem field to be identified as a highlighted field.
Update the Program metadata record that the care plan is based on to show the highlighted fields for the care plan.
On the Care Plan Field Group (
mvn__PJN_Care_Plan_Field_Group__c
) field, add the Care Plan Field Group metadata record created in step 1.
Add the Care Plan Highlighted Fields component to the Care Plan record page.
On the Display Type field, select Program.
To define and show Care Plan or Problem fields as highlighted fields in either the Care Plan Highlighted Fields component, the Care Plan Problem Info component, or both, such as to display information about a specific care plan stage:
Create a Care Plan Field Group metadata record to group all of the fields that should appear in the component(s).
Create a Care Plan Field metadata record for each field that should appear in the component(s).
On the Care Plan Field Group (
mvn__PJN_Care_Plan_Field_Group__c
) field, add the Care Plan Field Group metadata record created in step 1.On the Field API Name (
mvn__PJN_Field_API_Name__c
) field, enter the API name of the Care Plan or Problem field to be identified as a highlighted field.
Update the Program Problem metadata record that the care plan stage is based on to show the highlighted fields when the stage is selected.
On the Care Plan Field Group (
mvn__PJN_Care_Plan_Field_Group__c
) field, add the Care Plan Field Group metadata record created in step 1.
Add the Care Plan Highlighted Fields component to the Care Plan record page as desired.
On the Display Type field, select Program Problem.
Add the Care Plan Problem Info component to the Care Plan record page as desired.
You can style the highlighted fields, such as add Salesforce icons or reorder the fields, on the corresponding Care Plan Field metadata record. You can also move the highlighted fields to the right or left of the key fields and adjust the width of the highlighted fields in the Care Plan Problem Info component and switch between a horizontal and vertical display in the Care Plan Highlighted Fields component with the Lightning App Builder.
Configure key fields in Komodo Care Connect V2.2.0 and above
In Komodo Care Connect V2.2.0 and above, key fields are defined in field sets on the Case object and only appear in the Care Plan Problem Info component. You can assign a default field set to be used for all care plans of a program as well as assign specific field sets to be used for different stages of a program.
To identify the Care Plan fields that should appear as the default key fields on a Care Plan record page, such as to display general information about the patient, care program, or care team:
Create a field set on the Case object and add the Case fields that should appear as key fields in the Care Plan Problem Info component.
Update the Program metadata record that the care plan is based on to show the key fields for the care plan.
On the Default Key Fields Fieldset (
mvn__PJN_Default_Key_Fields_Fieldset__c
) field, enter the API name of the field set created in step 1.
Add the Care Plan Problem Info component to the Care Plan record page.
To identify the Care Plan fields that should appear for a selected stage on a Care Plan record page, such as to display specific information about the stage:
Create a field set on the Case object and add the Case fields that should appear as key fields for the stage in the Care Plan Problem Info component.
Update the Program Problem metadata record that the care plan stage is based on to show the key fields for the stage.
On the Key Fields Fieldset (
mvn__PJN_Key_Fields_Fieldset__c
) field, enter the API name of the field set created in step 1. If this is left blank, then the field set defined on the Default Key Fields Fieldset field on the parent Program metadata record will be used.
Add the Care Plan Problem Info component to the Care Plan record page.
Configure highlighted and key fields in Komodo Care Connect V2.1.5 and below
In Komodo Care Connect V2.1.5 and below, the highlighted and key fields in the PJN_CarePlanPath Aura component are grouped by the CarePlan Path Coaching Setting (mvn__PJN_CarePlan_Path_Coaching_Setting__mdt
) custom metadata type. Each highlighted field is a Care Plan Field (mvn__PJN_Care_Plan_Field__mdt
) metadata record while each key field is a CarePlan Path Keys Setting (mvn__PJN_CarePlan_Path_Keys_Setting__mdt
) metadata record. Information about the overall care plan that is not specific to a stage is also managed by the Care Plan Field custom metadata type. In such instances, the CarePlan Path Coaching Setting (mvn__PJN_CarePlan_Path_Coaching_Setting__c
) field on the metadata record is blank.
Activities, notes, and files
The left side of the record page displays all of the activities, notes, and files related to the care plan.
Activities
The Open and All tabs both display a care plan activity timeline using the Care Plan Timeline (pjnCarePlanTimeline
) Lightning Web Component to showcase the activities related to the care plan. The Open tab displays only Open
activities while the All tab displays all Open
activities as well as any upcoming, Closed
, and Cancelled
activities. Users can click on New Activity to create ad hoc activities outside of the pre-defined program journey. Activities are managed by the Case object of PJN_Activity
record type. Users can also click on the stage names in the care plan activity timeline to select them in the care plan progress bar. For example, if the currently selected (i.e., blue) stage in the progress bar is Missing Information and a user clicks Consent in the timeline, then the Missing Information stage in the progress bar becomes deselected (i.e., white) and the Consent stage becomes selected (i.e., blue).
Configure activity fields in Komodo Care Connect V2.2.0 and above
In Komodo Care Connect V2.2.0 and above, the fields that appear under each activity can be configured based on the activity's status. To configure the fields for activities with either the Open
, Closed
, and/or Cancelled
status:
Create a field set on the Case object for the group of fields that should appear for activities of the desired status.
Update the Program metadata record that the care plan is based on. On the following respective field(s), enter the API name of the field set(s) created in step 1:
Timeline Open Fieldset (
mvn__PJN_Timeline_Open_Fieldset__c
)Timeline Closed Fieldset (
mvn__PJN_Timeline_Closed_Fieldset__c
)Timeline Cancelled Fieldset (
mvn__PJN_Timeline_Cancelled_Fieldset__c
)
Configure activity fields and icons in Komodo Care Connect V2.1.5 and below
In Komodo Care Connect V2.1.5 and below, the fields that appear under each activity can be configured with the Care Plan Timeline Case Field (mvn__PJN_Care_Plan_Timeline_Case_Field__mdt
) custom metadata type while the icons for each activity status of a given program can be configured with the Care Plan Timeline Case (mvn__PJN_Care_Plan_Timeline_Case__mdt
) custom metadata type.
Configure New Activity button
To configure the available Case record types that can be created from the button, enter a list of comma-separated key-value pairs in the New Activity Button Override (mvn__PJN_New_Activity_Button_Override__c
) field on the Program Problem (mvn__PJN_Program_Problem__mdt
) custom metadata type using the format <button label>:<Case record type API name>,<button label>:<Case record type API name>
. The first key-value pair will appear as the main button while all other key-value pairs will appear in a dropdown menu.
For example, the image above demonstrates how the value of New Request:PJN_Request,New Activity:PJN_Activity
appears in the Missing Information stage. The key-value pair New Request:PJN_Request
appears as the main New Request button for creating new PJN_Request
Case records while the key-value pair New Activity:PJN_Activity
appears as an additional New Activity dropdown option for creating new PJN_Activity
Case records.
To simply relabel the text on the default New Activity button, set the field to <button label>:PJN_Activity
.
If no configurations are made, the New Activity button is the primary button that creates Case records of the PJN_Activity
record type.
Hide New Activity button
There are two ways to hide the New Activity button.
To hide the New Activity button for a specific stage in a program, set the Hide New Activity Button (
mvn__PJN_Hide_New_Activity_Button__c
) field on the Program Problem (mvn__PJN_Program_Problem__mdt
) custom metadata type totrue
.To hide the New Activity button for every stage in the Open or All tabs:
Open the Care Plan record page in the Lightning App Builder.
Click either the Open or All tab.
Click the activity timeline (i.e., the Care Plan Timeline component) inside the tab. The Show Problems field should equal
Open
if you clicked the Open tab andAll
if you clicked the All tab.Check the Hide Actions field.
Click Save.
Notes and files
The Notes and Files tabs display all notes and files related to the care plan, including any related records like ad hoc activities outside of the pre-defined program journey. Users can create, view, and edit notes and files directly in the respective tab. Reference Notes and Files.