Beta | Revamped Note

Overview #

The revamped note is a redesigned note body that organizes commands into clinical sections and lets providers arrange the Assessment & Plan the way they think about it, with each order, prescription and plan sitting under the condition it treats. Notes keep all of their existing commands and data; the beta changes how the note is laid out, organized and printed.

Expected Benefits #

Clinical sections: The note body is grouped into History, Exam, Assessment & Plan and Internal sections, ordered to match the note’s SOAP or APSO format. Each section has its own prompt for adding commands, and a Sections / All toggle in the note header switches between the sectioned view and the whole note.

Commands nested under their Assessment: Plan and Procedure commands, along with Prescribe, Refill, Adjust Prescription, Change Medication, Lab Order, Imaging Order, Order DME, Refer and Educational Material, appear nested under the Assess Condition command they are linked to.

  • Drag a command onto an Assessment to link it, or drag it out to unlink it.
  • Linking a prescription or order adds the assessed condition to its Indications.
  • Changes show up live for everyone who has the note open.

Printed in the note’s sections: A printed note in the revamped format shows the History, Exam and Assessment & Plan sections in the note’s SOAP or APSO order, the same sections it shows on screen. Commands in each section print in the order the provider arranged them, and each Assess Condition command prints with its linked commands indented beneath it. The Internal section isn’t printed, and free text prints under Notes at the end. Faxed notes, the copy saved when a note is locked, and the patient’s entire-record print use the same layout.

Collapsible commands: Commands that haven’t been committed yet can be collapsed to keep a long note readable, and they stay collapsed when you come back to the note.

Search the note: Type in the Search note box in the note header to narrow the note to the commands that match, with the matching text highlighted.

  • A command matches on its name or on the content the note shows for it, such as a field’s text, a selected option’s label or a questionnaire answer. Matching ignores case and starts at two characters.
  • In the Sections view, each section shows only its matching commands. In the All view, only the commands that don’t match are hidden; free text stays in place.
  • A command added while a search is active stays in view. Commands can’t be dragged to a new position until the search is cleared.
  • When nothing matches, the box shows No matches. Select the clear button or press Escape to show the whole note again.

Easier drag and drop: Commands are picked up by a grip in the left gutter, so clicks inside a command’s fields always go to the fields.

For developers #

Plugins can link commands to an Assessment in the same note with assessment_id, and read the link back from each data model’s assessment field. See Commands linked to an assessment and the commands module. Links are recorded on every instance; the nested display and sectioned print are what the beta adds.

Plugins can also add their own content to the revamped note. Respond to the NOTE__GET_CUSTOM_CONTENT event with one or more NoteCustomContent effects (canvas_sdk.effects.note_custom_content), each giving either content (HTML) or a url, not both. See the Note Custom Content effect for every attribute, URL block permissions, keeping content current, and more examples.

  • section places the content at the top of a section: NoteCustomContent.Section.HISTORY, EXAM, ASSESSMENT_PLAN or INTERNAL, and shows only in the Sections view. Leave it unset to place the content above the note body, where it shows in both the Sections and All views.
  • Content returned for the same section stacks in the order the handlers ran.
  • Each entry renders in its own frame, which starts 120 pixels tall. To fit the frame to the content, send a RESIZE message with the content’s height over the frame’s message channel, as shown in Frame height.
  • Outside the beta, Canvas doesn’t send the event, so the content doesn’t appear.
from canvas_sdk.effects.note_custom_content import NoteCustomContent
from canvas_sdk.events import EventType
from canvas_sdk.handlers.base import BaseHandler


class NoteBanner(BaseHandler):
    RESPONDS_TO = [EventType.Name(EventType.NOTE__GET_CUSTOM_CONTENT)]

    def compute(self):
        return [
            NoteCustomContent(
                section=NoteCustomContent.Section.ASSESSMENT_PLAN,
                content="<p>Remember to link each order to its assessment.</p>",
            ).apply()
        ]
On this page