How to group items on a patient chart section

This guide explains how to group items on a patient chart section. With this, you can define custom groups to organize medications or conditions.

Currently, we are only supporting this for the Conditions and Medications sections.

What you’ll learn: #

Patient Chart Group #

The PatientChartGroup effect allows you to group items in a patient chart section. You can define multiple groups with a name, priority, and the items that belong to each group.

3. The plugin #

Here’s an example of a plugin that groups conditions based on their codes - here we are creating a “Psychiatry” group for ICD-10 codes F01-F99 and R45.x and placing all matching conditions in that group.


from canvas_sdk.effects.patient_chart_group import PatientChartGroup
from canvas_sdk.effects import Effect
from canvas_sdk.effects.group import Group
from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler
from canvas_sdk.commands.constants import CodeSystems

class Protocol(BaseHandler):
    RESPONDS_TO = EventType.Name(EventType.PATIENT_CHART__CONDITIONS)

    def compute(self) -> list[Effect]:
        groups: dict[str, Group] = {}
        groups.setdefault("Psychiatry", Group(priority=100, items=[], name="Psychiatry"))

        for condition in self.event.context:
           for coding in condition["codings"]:
               if coding["system"] == CodeSystems.ICD10 and ("F01" <= coding["code"] <= "F99" or coding["code"].startswith("R45.")):
                   groups["Psychiatry"].items.append(condition)
                   break

        return [PatientChartGroup(items=groups).apply()]

4. The Output #

Below, you can see how it will appear in the app.

patient chart group
On this page