Patient Lists Style Guide

Many columns (PAF records) are available for use within Patient Lists (ERS records). Those from the foundation system can have duplicative names without clear distinctions about how the content, formatting or interaction of column contents differ. The following guides emphasize conventions that can make it easier for end-users to select columns for personalized patient lists ("My Lists"), based on what information the column contains, what happens with a hover event and what happens when the user double-clicks within a column.

Patient List Columns (PAF records)

Epic's PAF records are used to define the properties, behaviors and actions associated with columns of information that may be selected for inclusion in patient lists. Although our focus here is on Personal My Lists, the same column configuration principles apply to System Lists (typically managed by Analysts, not Builders).

The Column Editor (use global search for "col" to find and open the editor in a builder environment) is used to configure patient list columns, which are a special case of Reporting Workbench columns. There will be Epic released columns that cannot be edited. If a released column is important, but not configured appropriately for Connect Care, then Builders should copy the released column, using a standards-compliant title and identifier. The Column editor includes the fields described below. Builders should heed guidance for AHS-appropriate use of those fields. Fields not listed here should be avoided.

Record ID

Column (PAF) record numbers should, ideally, follow AHS record naming conventions (e.g., "304" prefix + foundation number copied from + incremental digit extensions). Note that PAF IDs can be a maximum of 9 digits, so incremental end-digits may be limited from 1-9.

  • Example: 30434201 as a copy of Epic release record 3420

Column Name

Column names should follow AHS record naming conventions (e.g., "AHS IP " prefix to indicate that the record is approved for use in AHS for the inpatient context), capitalized, and as succinct as possible. Title words should reflect key concepts, progressing from more general to more specific. Groupings (e.g., Rapid Rounds) can be reflected by an abbreviation after the prefix.



This appears at the top of columns in the header section and so should be as succinct as possible. It is just a label. Verbose captions frustrated the auto-sizing of list columns. Note any existing columns with similar function and use the same column header label, as this is not useful for differentiating in list property editors. Use Title font.

  • Example: "Room/Bed"

Technical Description

This description is seen by analysts and builders when looking up columns. The information is not easily available to end users. Accordingly, keep brief but without need for a specific formatting convention.

Used By

Check to ensure that "INPATIENT EMR [26]" is included in the list of contexts in which the column can be used. This is needed for Patient Lists (an inpatient activity).

Width and Alignment (Definition and Formatting tab)

Patient list columns "auto-resize" within typical lists. However, the minimum (and sometimes default) column width is controlled by this setting. The following widths are good starting values (can be adjusted after testing) for columns with different types of information (be sure to use short captions for narrow columns):

  • Icon or Dot - 200 Centre

  • Score - 300 Centre

  • Date - 500 Centre

  • Name (e.g., patient or physician name) - 700 Left

  • Block (e.g., name plus photo) - 1000 Left

  • Text (e.g., Sticky Note text) - 1200 left

Basic Description (Application Specific Features tab)

This is the descriptive information seen by users when building or customizing "My Lists". Little room (one line) is available in the list editor for skimming the content of this field. Keep content brief and follow a standardized convention so that this information is consistent and easy to recognize. Note that this field also controls the bubble text wording when a patient list user hovers over a column header.

  • Required content: indication of AHS approval, what information is displayed, what information appears on hover and what happens on double-click.

  • Format: [AHS] Display = AAAA. Hover = BBBB. Double-click = CCCC.

  • Example:

    • "[AHS] Display = overall discharge readiness. Hover = multidisciplinary readiness summary. Double-click = multidisciplinary readiness editor. "

Release Status (Application Specific Features tab)

Leave this blank until a new column has been reviewed and tested in a pre-production environment. When features are finalized, select and save "Released" in this field.

Hover Bubble Ext (Application Specific Features tab)

Builders should not edit the content of this field unless they have competence and experience creating and editing program extensions (LPP records). Only certain types of information can be shown reliably in the context of a multi-patient list. Tested and approved bubble extensions are listed in the Patient Lists Catalogue.

Launch Activity (Application Specific Features tab)

Builders should also take care with Launch Activity settings. These control what happens when a user double-clicks on patient information within the column. The default (no entry) behaviour is to open the patient's chart. Alternatively, most activities and reports that can be opened by EpicACT links can be entered as column launch activities. The Patient Lists Catalogue lists activities that have been tested.

Lists (ERS)

More Information