21. Reports
A Report in clearPath is a saved definition that tells the system what to produce, how often, and in what format. Once you set a report up, clearPath runs it on a schedule (generally just after midnight) so the latest version is always waiting for you. You can also run a report by hand at any time to get a fresh copy immediately.
Every report definition carries:
A name — how the report is shown everywhere in clearPath.
A report type — what the report is actually measuring (for example, a compliance trend, an anatomy breakdown, or a facility summary).
A format —
PDF,CSV,XML,HTML,PNG, orExcel.A period — a dynamic time range such as
Last Month,This Quarter,Fiscal Year, orLast 90 Days.A scope — the facility, patient care area, program, or unit the report covers.
An owner — the clearPath user responsible for the definition.
Because the period is dynamic, a report defined once keeps producing meaningful output month after month without anyone having to edit it.
To open the list, go to Reports | Reports.
21.1. The Reports Page
Summary cards across the top of the page show:
Total Reports — how many report definitions exist on the account.
PDF Reports, CSV Reports, Excel Reports — counts by output format.
Report Formats — the number of distinct formats in use.
Updated <1hr — how many reports finished refreshing in the last hour.
Unique Types — how many different report types are in use.
Stale Reports — reports whose last-run date is older than the cadence the system expects.
Running Reports — reports currently generating. While any reports are running the chip turns red so you can see at a glance that work is in progress.
21.1.2. Searching and Filtering
The toolbar above the table holds the search box and a row of filter drop-downs:
Search box — matches on the report name.
All Facilities — narrow to a single facility.
All Patient Care Areas — narrow to a patient care area inside the selected facility.
All Owners — narrow to a specific owner.
All Report Types — narrow to one type of report.
All Report Formats — narrow to one output format (
PDF,CSV,Excel, and so on).All Periods — narrow to a specific time period.
All Categories — narrow to a user category.
All Reports — filter by status:
Running(generating right now) orCompleted.
A refresh button on the right reloads the page from the server.
21.1.3. Table Columns
Report Name— the name of the definition. Click the heading to sort.Owner— the user who owns the report.Report Type— the kind of report being produced.Report Format— the output format.Period— the time range the report covers.Lang— the language the report is rendered in.Age— how long ago the report was last refreshed.Size— the size of the most recent generated file.
Tick the checkbox at the left of a row to select it; tick the
header checkbox to select every row on the page. Selecting rows
lights up the Actions and Export buttons.
21.1.4. Row Actions
Click the three-dot button at the end of a row to open the row menu:
Refresh— re-runs just this report so the latest numbers are ready.View Report— opens the most recent copy of the report.Edit— opens the report definition in the editor.Clone Report— makes a copy of the definition you can rename and tweak.Delete— removes the report definition after a confirmation prompt.
The rest of this chapter covers the pieces that make up a report definition — the logo, the definition fields, dynamic report-name tags, the anatomy of a report, legends, how to handle empty periods, the report request policy, report styles, the Keyword Manager, distribution lists, the archive, and report groups.
21.2. Report Logo
Your organization’s logo can be included in the header of all your reports. If no custom logo is uploaded, clearPath will default to clearPath logo.
Sample Logo
Note
For best results the logo must be 210 by 40 pixels at 600 dpi. The logo must be png format, with a transparent background.
21.3. Report Definitions
A report definition is the recipe clearPath follows to produce a report. Every row on the Reports page is one definition, and the editor for a definition is organised as a dialog with a strip of tabs along the top. Each tab covers one aspect of the report.
21.3.1. Report List
The list itself is described on the Reports page at the top of this chapter — including the stat chips, the search and filter toolbar, every table column, and the page header buttons.
21.3.2. The Editor
When you click New Report at the top of the page or Edit on
a row’s menu, clearPath opens the report editor. The editor is a
dialog with a strip of tabs along the top; the sections below
describe each tab.
21.3.3. General
The General tab collects the basics: the report’s name, a short description, the owner (a clearPath user), and the high-level settings that control which kind of report this is and what language it comes out in.
21.3.4. Scope
The Scope tab decides which data the report covers. Pick the facility, patient care area, program, and unit the report should draw from. Leaving a level blank includes every child beneath it, so an empty facility list means “every facility on the account”.
21.3.5. Auditors
Use the Auditors tab to limit the report to observations made by specific auditors. Leave the list empty to include observations from every auditor.
21.3.6. Indicators
The Indicators tab picks which indicators roll into the report. Leave the list empty to include every indicator.
21.3.7. HCP
The HCP tab chooses which healthcare provider types the report covers. You have two options:
Leave every checkbox unselected — clearPath treats this as “include every active HCP type”.
Tick a subset of HCP types — only those types are included.
Tip
Leaving the HCP list empty is usually what you want. It means the report keeps including every HCP type as new ones are added to the system, with no manual editing.
Note
If the list has any HCP types ticked, adding a new HCP to the system does not automatically add it to the report. You need to edit each affected report and tick the new type by hand.
21.3.8. Period
The Period tab sets the time range the report covers. clearPath
periods are dynamic — a report defined with Last Month
keeps producing a fresh “last month” view automatically without
any edits.
The period drop-down includes choices such as Today,
Yesterday, This Week, Last Week, This Month,
Last Month, This Quarter, Last Quarter, Fiscal Year,
Last Fiscal Year, individual calendar months and fiscal
quarters, and rolling windows like Last 30/60/90/120/180 Days.
Pick Custom to set a specific From and To date for a
one-off report.
21.3.9. Output
The Output tab decides what the finished report looks like. It
covers the output format (PDF, CSV, XML, HTML,
PNG, or Excel) and the styling options applied during
rendering.
21.5. Report Anatomy
The numbered callouts in the image above correspond to the following elements, which appear on most clearPath reports.
# |
Description |
|---|---|
1 |
Your corporate logo, uploaded under account preferences. |
2 |
The report title, which is normally the name of the report type (for example “Hand Hygiene Moment Compliance”). In the example above this line is blank because the title was not set on the report definition. |
3 |
The scope of the report. This can be Corporate, Facility, Patient Care Area, Program, or Unit, and reflects the filter selected when the report was run. |
4 |
Your corporate name. This is blank in the example image. |
5 |
The report content area. This is where the tables, graphs, or other report-specific output appear. |
6 |
The report footer, which shows the Period, Filter, and Created date. The Period includes the start and end dates covered by the report. The Filter indicates whether the report is for All data or is scoped to a specific Facility, Patient Care Area, Program, or Unit, and whether the Patient Care Areas are Reportable or Non-Reportable. |
21.6. Report Legends
By default all reports with the exception of Certificate of Excellence and Poster Reports contain a legend. The default is to show the legend, but it can be disabled in the report definition.
Hint
It is recommended to include the legend with the report. It may be obvious as to what data is included in the report but it may lead to unnecessary question from stakeholders if they cannot easily determine the period or the scope of the report.
21.7. Reports by Edition
21.7.1. Report Matrix
21.7.2. Export Reports
Report Type |
Outputs |
Styles |
COM |
PRO |
ENT |
ULT |
|---|---|---|---|---|---|---|
CSV, Excel |
1 |
|
|
|
|
|
CSV, Excel |
1 |
|
|
|
|
|
CSV, Excel |
1 |
|
|
|
|
21.7.3. System Reports
Report Type |
Outputs |
Styles |
COM |
PRO |
ENT |
ULT |
|---|---|---|---|---|---|---|
PDF, CSV, Excel |
1 |
|
|
|
|
|
PDF, CSV, Excel |
1 |
|
|
|
|
|
PDF, CSV, Excel |
1 |
|
|
|
|
21.8. No Data Condition
Any report can display the This Report Contains No Data message. This can occur if the date range or any of the other filters have been set to exclude any results, or no data has been collected for the period.
21.9. New Report Requests
We will always consider customer submissions for new reports. To set expectations, new reports can take weeks of development and testing and maybe further be delayed due to other feature requests and plans already in the development backlog (schedule). This realistically means report requests can take be a minimum of six weeks or more to take a report from concept to deployment.
Before we accept a report submission, we need an an example of the report which can be either a:
sketched version of report
or an existing clearPath report marked up with the requested changes, or a report your organization uses internally. The report should be in one of the following formats:
PDF
CSV
HTML
Excel
image format (PNG, JPG, or SVG)
21.9.1. Report Development Process
New Report request added to the development backlog
Development of new report scheduled
Report Development Begins
Report Testing
Road Test the alpha version of the report
Share report and request for fixes and/or changes
Schedule Upgrade to clearPath
Road Testing on clients instance of clearPath
21.9.2. Accepting Submissions
Requests from accounts must have an active subscription. If your account is inactive your request will be held until the subscription is renewed and then placed in the development queue.
Only accounts with Enterprise or Ultimate editions of clearPath can submit request for new reports.
21.10. Report Styles
clearPath currently supports 51 unique report styles. Some reports include multiple versions, and most reports support PDF, CSV, and/or Excel output formats. If you don’t see what you’re looking for, please contact us at support@clearpathhealthsolutions.com and we will see if there is something close. If not, we will work with you to add a custom report.
Each section below ends with an indicator bar that summarises the available output formats and the editions in which the report is included.
21.10.1. Indicator By HCP
The Indicator By HCP report shows hand hygiene compliance for a single indicator (moment), broken down by health care provider type. It is typically used by infection prevention staff and unit managers who want a quick, at-a-glance view of how each HCP type is performing against a single moment of care. This report is ideal for highlighting the best and worst performing provider groups in a compact format.
Tip
If you need a report where all indicators are broken out in a single report, or you need a version where the data can be exported to CSV or Excel, check out Indicators by HCP.
Outputs: PDF CSV Excel PNG |
21.10.2. Moment Compliance
The Moment Compliance report is one of the original six Ontario Ministry of Health reports. It displays the distribution of hand hygiene techniques (rub, wash, or both) across a Facility, Patient Care Area, Unit, or Program, expressed as a percentage. This report does not show overall hand hygiene compliance; rather, it shows how hand hygiene is being performed when it is performed. Infection prevention teams use it to validate that alcohol-based hand rub is the predominant technique in clinical areas.
Note
This report was previously known as Type by Indicator.
Outputs: PDF CSV Excel PNG |
21.10.3. Indicators By HCP
The Indicators By HCP report shows compliance for every indicator (moment) broken out by health care provider type in a single report. It is used by quality leads, educators, and unit managers who need to identify which moments a specific HCP group struggles with so that targeted education can be provided. Two layout styles are available so the report can be consumed both on screen and in downstream spreadsheets.
21.10.3.1. Style A - Original
Style A presents the data in the standard side-by-side layout for on-screen review and PDF distribution.
21.10.3.2. Style B - Grouped by Facility and Unit
Style B allows you to group HCP types by Facility and Patient Care Area, which is useful for organisations that want to compare the same HCP type across multiple units.
Outputs: PDF CSV Excel PNG |
21.10.4. Week In Review
The Week In Review report provides a one-page recap of auditing activity over the previous week. It highlights the number of observations collected, compliance at a glance, and notable events. It is typically circulated to front-line managers and infection prevention leads as a quick status update without the overhead of a full monthly report.
Outputs: PDF PNG |
21.10.5. Audit Form
We recognise that paper audits can still be useful, so clearPath includes a printable audit form. The form is generated with your unique set of health care providers and indexes them based on your instance of clearPath, so the paper form matches what auditors see in the mobile app. It is commonly used in settings where a mobile device is not practical or as a training aid for new auditors.
Note
Out of the box clearPath supports English, Spanish, and French. Other languages can be added on request.
Outputs: PDF PNG |
21.10.6. Observation Note Frequency
The Observation Note Frequency report lets you determine how often each canned and custom comment is used by auditors across your organisation. It is most useful when predefined comments have been configured, because all custom comments entered by auditors are rolled up into a single line on the report. Quality and education leads use this report to surface recurring issues and to decide which canned comments are worth keeping. To manage custom comments, from the main menu go to Accounts | Notes.
Outputs: PDF CSV Excel PNG |
21.10.7. Technique Distribution
The Technique Distribution report is one of the original six Ontario Ministry of Health reports. It shows the breakdown of hand hygiene technique (rub, wash, or both) for a Facility, Patient Care Area, Unit, or Program, expressed as a percentage. This report does not show hand hygiene compliance; it shows how hand hygiene is being performed when it is performed. Infection prevention programs use it to monitor adoption of alcohol-based hand rub versus soap and water.
Note
One change in this version of the report compared to the previous version is that we now show the missed technique as well. This breaks compatibility with the original Ontario Ministry of Health report; however, that report always raised questions because the numbers did not add up.
Outputs: PDF CSV Excel PNG |
21.10.8. Observation Summary By Indicator
The Observation Summary By Indicator report summarises observations for each observer, broken down by indicator (moment). It is used by audit program leads to review how individual observers are distributing their observations across the different moments of care, which helps detect bias or gaps in coverage.
Outputs: PDF CSV Excel PNG |
21.10.9. Indicators by Patient Care Area
The Indicators by Patient Care Area report shows compliance for every indicator (moment) broken out by Patient Care Area. Unit managers and quality teams use it to compare moment-level performance across units and to identify where to focus improvement efforts. Two layout styles are available to accommodate both on-screen review and legacy CSV exports.
Style A
Style B
Style B maintains the older file format where the facility and patient care area share a single line. This style was retained for clients that have existing downstream pipelines which consume the CSV export.
Note
Both Style A and Style B support CSV, Excel, and PDF file formats.
Outputs: PDF CSV Excel PNG |
21.10.10. Calendar
The Calendar report contains key contact information for the facility along with any key dates that have been defined. It is often printed and posted in staff areas so that auditing milestones, hand hygiene week, and other events are visible at a glance.
Outputs: PDF PNG |
21.10.11. Compliance Over Time Graph
The Compliance Over Time Graph plots hand hygiene compliance across the report period so that trends can be evaluated visually. Each data point represents a time slice (typically a month) and the shape of the line makes it easy to see whether compliance is improving, flat, or regressing. Quality leaders typically pair this graph with the Trend Line Graph when presenting to senior leadership.
Outputs: PDF CSV Excel PNG |
21.10.12. Compliance By Month by Indicators
The Compliance By Month by Indicators report breaks compliance down by calendar month and by indicator (moment), so you can see which moments are driving overall performance in any given month. It is most often used to support root-cause analysis when a dip in compliance is observed for a particular month.
Outputs: PDF CSV Excel PNG |
21.10.13. Summary of Audits
The Summary of Audits report lists the audits completed by month and day, along with facility, unit, observer, compliance, session state, and reportable unit status. It is typically used by audit program managers as an operational log to confirm that auditing is happening as scheduled and that no sessions were left in an incomplete state.
Legend:
A = Active Audit Session
R = Reportable Unit
Note
The observer column shows either the observer ID or the observer name, depending on report settings.
Outputs: PDF CSV Excel PNG |
21.10.14. Glove Compliance
The Glove Compliance report shows compliance when glove usage is observed versus compliance when glove usage is ignored. Infection prevention teams use it to confirm that glove use is not being substituted for hand hygiene, particularly around moments 2 (Before Aseptic) and 3 (After Body Fluid).
Note
One would expect the totals for moments 2 and 3 (BEF-ASP and AFT-BFL) in the gloves column to closely match the totals in the compliance column. Any large difference between those two columns indicates a lack of glove compliance.
Outputs: PDF CSV Excel PNG |
21.10.15. Nails Compliance
The Nails Compliance report shows hand hygiene compliance for observations where artificial or long nails were observed, versus observations where they were not. It is used by infection prevention committees that enforce a no-artificial-nails policy for clinical staff.
Outputs: PDF CSV Excel PNG |
21.10.16. Rings Compliance
The Rings Compliance report shows hand hygiene compliance for observations where rings were observed, versus observations where no rings were observed. It supports dress-code policies that restrict jewellery on hands in clinical settings.
Outputs: PDF CSV Excel PNG |
21.10.17. Bracelet Compliance
The Bracelet Compliance report shows hand hygiene compliance for observations where bracelets were observed, versus observations where no bracelets were observed. Like the Rings and Nails reports, it supports enforcement of hand and wrist dress-code policies.
Outputs: PDF CSV Excel PNG |
21.10.18. Audit Progress Summary
The Audit Progress Summary is a convenient way to ensure that the number of observations collected is tracking
to the targets defined in each patient care area’s audit schedule. The report breaks activity down by month
and displays the number of observations collected for the patient care area in each month. Months in which no
observations were collected are shown with ----. Months where the number of observations falls below the
schedule plan target are shown in red; months where the total meets or exceeds the target are shown in green.
The total column on the far right shows the overall status of the patient care area.
Note
The Goal (M/A) column displays the (M)onthly and (A)nnual targets for the patient care area.
Warning
The monthly/annual targets column may appear to be slightly off depending on the patient care area settings. For example, if the annual target for a patient care area is set to 400 observations, clearPath calculates a monthly target of 33.3 (400 divided by 12), which is then rounded to 33.
Outputs: PDF CSV Excel PNG |
21.10.19. Quarterly Status
The Quarterly Status report displays compliance broken down by hospital and quarter. Each moment is shown along with the overall compliance. Quarters with no data are shown blank, and the current (incomplete) quarter only displays data collected to date. The precision for each moment column and the overall column follows the precision set on the report definition.
Outputs: PDF CSV Excel PNG |
21.10.20. Last Six Months
The Last Six Months report shows hand hygiene compliance for each of the six most recently completed months. The report period is defined by the report itself, so the “from” and “to” dates on the report definition are ignored. This report is commonly used on monthly quality scorecards.
Outputs: PDF CSV Excel PNG |
21.10.21. Last Six Quarters
The Last Six Quarters report shows hand hygiene compliance for each of the six most recently completed quarters. Like the Last Six Months report, the period is defined by the report itself and the date fields on the report definition are ignored. It is frequently used on board-level dashboards.
Outputs: PDF CSV Excel PNG |
21.10.22. Three Month Rolling
The Three Month Rolling report displays compliance for each of the three most recently completed months and is intended for rolling quality reporting where quarterly granularity is too coarse. The report period is defined by the report itself, so the “from” and “to” dates on the report definition are ignored.
Outputs: PDF CSV Excel PNG |
21.10.23. Year End Summary
The Year End Summary report provides a simplified, ready-to-publish annual summary and intentionally removes most of the options found on other reports. Only units that are active, unlocked, and reportable are included in the results. It is commonly used to prepare an organisation’s public annual report on hand hygiene performance.
Outputs: PDF CSV Excel PNG |
21.10.24. Observations Completed
The Observations Completed graph shows the number of completed observations by month over the report period. The goal trend line is calculated from the number of observations defined in your auditing schedule plan, and the number of observations is calculated across the patient care areas included in the report. Audit program leads use it to confirm that auditing volume is keeping pace with plan.
Outputs: PDF CSV Excel PNG |
21.10.25. Histogram of Total Observations
The Histogram of Total Observations is actually six different histogram reports. Data can be shown as:
Distribution of Percentage
Day of the Week
Day of the Year
Week of the Month
Week of the Year
Month of the Year
This family of histograms is useful when there is a concern about bias in auditing — for example, when an auditor consistently audits on the same day of the week and therefore other days have an insignificant sample size. The specific histogram produced is controlled under the Interval tab of the report definition. That tab remains disabled until the report type (under the General tab) is set to Hand Hygiene Histogram of Total Observations.
Outputs: PDF CSV Excel PNG |
21.10.26. Observation Per Day
The Observations Per Day report displays the total number of observations collected for each day in the report period. Each day is colour coded based on the ranges shown in the example below. Days on which no observations were collected are shown with a white background, and weekend days default to a light-gray background. This report helps audit program leads spot clustering and gaps in daily coverage at a glance.
Outputs: PDF PNG |
21.10.27. Compliant Days
The Compliant Days report shows the hand hygiene compliance percentage for each day of the report period. The report analyses all audit sessions collected on a given day and calculates a composite percentage, which is then colour coded based on the colour ranges configured for your account. Days with no observation data are shown in white or light gray, and weekends are shaded with a light-gray background.
Outputs: PDF PNG |
21.10.28. Certificate of Excellence
The Certificate of Excellence report is unique among clearPath reports: it is the only report that is generated only when the facility, unit, or group achieves a hand hygiene compliance at or above the corporate threshold. It is intended to be printed, signed, and presented to teams that meet the performance bar.
Outputs: PDF |
21.10.29. Word Tree
The Word Tree report identifies trends and keywords in the free-text comments collected by auditors during hand hygiene audits. It analyses session comments, scratchpad notes, and observational comments. Each comment is split into individual words, which are then checked against a do-not-include list and a minimum-length requirement (the default is three characters) so that common words such as “a” or “the” are excluded. The resulting report draws a rectangle for each remaining word; the size and colour of the rectangle represents how often the word appears. Smaller, dimmer rectangles indicate lower frequency. The report is useful for uncovering recurring themes (equipment, location, workflow) that may warrant follow-up.
Outputs: PDF CSV Excel PNG |
21.10.30. Compliance Ranked By PCA
The Compliance Ranked By PCA report displays compliance ranked by patient care area. The target for the corporation is shown along with the average compliance across all units, which appears at the bottom of the report. Colour coding follows your account’s colour range settings, and the red or green bar to the left of each unit name indicates whether the unit meets the target (green) or falls short of it (red). Senior leaders use this ranking to quickly identify the top and bottom performers in the organisation.
Outputs: PDF CSV Excel PNG |
21.10.31. QIP Indicators Last 12 Months
The QIP Indicators Last 12 Months report is designed to support Quality Improvement Plan reporting. It shows indicator performance for the trailing twelve months against the organisation’s targets. Two styles are available so that you can choose between a dense tabular layout and a combined table-plus-graph layout.
Style A
Style A contains only the table of results and a full legend. This is the original style of the report.
Style B
Style B includes the table of results along with a graph and an abbreviated legend.
The colour coding of the data in the table and in the legend is fixed.
Note
xx is the percentage specified in the target definition’s “within” parameter. The default “within”
setting is 25 %.
Outputs: PDF CSV Excel PNG |
21.10.32. QIP HCP Last 12 Months
The QIP HCP Last 12 Months report focuses on health care provider performance over the trailing twelve months. Like the QIP Indicators report, it is designed to support Quality Improvement Plan submissions and uses the same three-colour scheme to flag metrics that meet, approach, or miss target.
Outputs: PDF CSV Excel PNG |
21.10.33. QIP HCP by Quarter
The QIP HCP by Quarter report presents health care provider compliance broken down by quarter, which makes it easy to spot seasonal patterns or the impact of education campaigns that were rolled out in a particular quarter.
Note
This report automatically moves the chart to a second page when the number of selected health care providers exceeds ten.
Outputs: PDF CSV Excel PNG |
21.10.34. Indicator Trend Last Five Years
The Indicator Trend Last Five Years report plots compliance for each indicator (moment) over the last five fiscal years. It is a long-range view useful for senior leadership and board reports, and is especially helpful when evaluating the multi-year impact of a sustained improvement program.
Outputs: PDF CSV Excel PNG |
21.10.35. Indicator Trend Table and Graph
The Indicator Trend Table and Graph report pairs a table of per-indicator compliance values with a companion graph in a single output. It is designed for audiences that want both the underlying numbers and an at-a-glance visual on the same page.
Outputs: PDF CSV Excel PNG |
21.10.36. Trend Line Graph
The Hand Hygiene Trend Line Graph is a two-series report that shows weekly hand hygiene compliance over the report period along with a best-fit (trend) line for the same period. Each bar represents a single week; weeks with no completed audits are shown as spaces. The legend reports the slope of the trend line, expressed as the percent increase (positive) or decrease (negative) in compliance projected in thirty-week increments. In the screenshot below, for example, if the trend were to continue, overall compliance for the year would decrease by 1.3 %.
Outputs: PDF |
21.10.37. Observation Notes
The clearPath Observation Notes report displays the comments entered by the auditor during an audit session, organised by date and time. The report can include the main session comment, scratchpad notes, and health care provider-specific notes. Quality leads use this report to review the qualitative context around quantitative compliance numbers.
Tip
If the Observation Notes output format is set to PDF, long comments may not render correctly because the row does not automatically resize. If you have many long comments, set the output format to Excel, rerun the report, open the resulting xlsx file in Excel, and save as PDF. Excel will resize the rows automatically.
Note
Previously known as the Comment Report.
Hint
If you are looking to see how frequently canned notes are used versus custom notes, check out the Observation Note Frequency Report.
Outputs: PDF CSV Excel PNG |
21.10.38. Observer Summary
The Observer Summary report lists every auditor active during the report period along with the number of sessions and observations they collected. Audit program leads use it to confirm that the workload is evenly distributed across the auditor pool and to identify auditors who may need additional support or coaching.
Outputs: PDF CSV Excel PNG |
21.10.39. HCP Audit Distribution
The HCP Audit Distribution report highlights whether one or more health care provider types are being audited too frequently or not frequently enough. If an HCP type is over- or under-represented, it can bias the overall compliance results. clearPath compares the total number of observations collected for each HCP type against the total FTE (Full Time Equivalent) employees in that role for the organisation. The variance column shows the percentage and the number of observations that are (O) over-represented (positive) or (U) under-represented (negative).
Ideally, the share of observations for each HCP type should track the share of FTEs in that role. For this report to be accurate, the FTE field must be populated on the health care provider definition screen.
Outputs: PDF PNG |
21.10.40. Poster Reports
The Poster Reports are single-page, portrait-mode reports designed to be printed and posted in patient care areas or other staff areas around your facility. A poster can display compliance data for the overall corporation, a single facility, a patient care area, a unit group, or a program group, and can cover any time period you choose. Four poster styles are available (Style A, B, C, and D); the style is chosen on the Reports | Options screen via the Report Style drop-down.
21.10.40.1. Poster Report Style A - Original
The updated Style A poster includes compliance targets, colour coding, and improved formatting for indicators so that organisations can focus on specific moments.
21.10.40.2. Poster Report Style B - Single Image
Style B is an alternative layout that emphasises the overall compliance number and a concise set of indicators.
21.10.40.3. Poster Report Style C - Stop Light
Style C is a further visual variation on the poster, intended to fit organisations with different branding preferences.
21.10.40.4. Poster Report Style D - Week In Review
Style D is the most information-dense poster. It includes the number of observations, overall compliance, quarterly compliance, the target for each moment, an abbreviated legend, the bottom ten performing health care providers, and compliance by moment.
Note
The quarterly compliance column reflects the quarter in which the report period falls, not the current quarter.
Due to space constraints, only the ten lowest-performing HCP types are shown.
The indicators shown only include those selected in the report definition.
Outputs: PDF Excel |
21.10.41. Indicator Table and Graph
The Indicator Table and Graph report combines a per-indicator data table with a companion graph on the same page. It is used by audiences that want both the raw numbers and the visual comparison without having to cross-reference two separate reports.
Outputs: PDF CSV Excel PNG |
21.10.42. Just Clean Your Hands
The Just Clean Your Hands export implements the original Just Clean Your Hands file format from the Ontario Ministry of Health. It is intended for organisations that need to upload their audit data in the format the ministry originally specified.
Note
For details on the Just Clean Your Hands file format click here.
Outputs: CSV Excel |
21.10.43. Generic Hand Hygiene Export
The Generic Hand Hygiene Export supports CSV and Excel output. It contains more descriptive data fields than
the standard Just Clean Your Hands report. Date fields are split into separate month, day, and year columns;
time has its own column formatted as hh:mm AM/PM; and facility, patient care areas, and HCP types all
include both descriptive names and their associated ID values, which makes the export much easier to read and
to join with other data sets.
Field Names, Types and Descriptions
Col |
Field |
Type |
Description |
|---|---|---|---|
1 |
dbID |
Number |
Unique Database ID |
2 |
DataID |
Text |
Any ID or identifier used as a key to match records with other data sets |
3 |
Observer |
Text |
Name of the Observer |
4 |
Observer ID |
Number |
Unique Database ID |
5 |
HCP Number |
Number |
Not Used |
6 |
Facility |
Text |
Name of Facility |
7 |
FacilityID |
Number |
Unique Facility ID |
8 |
PCA |
Text |
Patient Care Area / Unit Name |
9 |
PCA ID |
Number |
Patient Care Area ID |
10 |
Unit Type |
Text |
Unit Type - Acute Care, Long Term Care, etc. |
11 |
Month |
Number |
Month of the year the observation was recorded |
12 |
Day |
Number |
Day of the month the observation was recorded |
13 |
Year |
Number |
Year the observation was recorded |
14 |
Time |
Date/Time |
Time of the observation formatted as hh:mm AM/PM |
15 |
Comments |
Text |
Audit comment field |
16 |
HCP Name |
Text |
Health Care Provider Name |
17 |
HCP ID |
Number |
Health Care Provider Index |
18 |
HCP # |
Text |
Typically A, B, C, etc., used to differentiate HCP types |
19 |
Timer |
Text |
Duration of the hand hygiene wash or rub in seconds |
20 |
BEFPAT |
Number |
Before Patient or Moment 1. 0=Not Observed 1=Observed |
21 |
BEFASP |
Number |
Before Aseptic Procedure or Moment 2. 0=Not Observed 1=Observed |
22 |
AFTBFL |
Number |
After Body Fluid or Moment 3. 0=Not Observed 1=Observed |
23 |
AFTPAT |
Number |
After Patient Contact or Moment 4. 0=Not Observed 1=Observed |
24 |
AFTTPS |
Number |
After Touching Patient Surroundings or Moment 5. 0=Not Observed 1=Observed |
25 |
Rub |
Number |
0=Not Observed 1=Observed |
26 |
Wash |
Number |
0=Not Observed 1=Observed |
27 |
Missed |
Number |
0=Not Observed 1=Observed |
28 |
Gloves |
Number |
HCP was wearing gloves. 0=Not Observed 1=Observed |
29 |
Nails |
Number |
HCP was observed wearing nails. 0=Not Observed 1=Observed |
30 |
Bracelets |
Number |
HCP was observed wearing bracelets. 0=Not Observed 1=Observed |
31 |
Rings |
Number |
HCP was observed wearing rings. 0=Not Observed 1=Observed |
Outputs: CSV Excel |
21.10.44. State of Maryland Export
The State of Maryland Export is a CSV / Excel export specifically designed for uploading compliance data into the State of Maryland Health database. It only includes Before Entering and After Exiting (moments 1 and 4), matching what the Maryland database expects.
Note
This report only supports BeforeEntering and AfterExiting (moments 1 and 4), and is specifically designed for uploading compliance data into the State of Maryland Health database.
Outputs: CSV Excel |
21.10.45. Distribution Summary
The Distribution Summary report provides a single consolidated view of every distribution list that has been defined in the system. It is used by administrators to audit who is currently receiving which reports and to confirm that distribution lists are still accurate.
Outputs: PDF CSV Excel PNG |
21.10.46. User Summary Report
The User Summary report lists every user in the system, including the user’s password complexity score and account state. It is primarily used by system administrators for periodic account reviews and for audits required by information security policies.
Tip
For more information on passwords, password scores, and password complexity click here.
Outputs: PDF CSV Excel PNG |
21.10.47. Patient Care Area Summary Report
The Patient Care Area Summary report lists every active, inactive, and locked unit along with the observation targets configured for each unit. It is typically used by administrators to validate unit setup and to confirm that audit schedule plans are configured correctly across all units.
Field Names, Types and Descriptions
Col |
Field |
Type |
Description |
|---|---|---|---|
1 |
ID |
Number |
Unique Database ID |
2 |
Active |
Text |
Unit is Active or Inactive. Inactive units cannot be audited and will not be reported. |
3 |
Locked |
Text |
Unit is Locked or Unlocked. A locked unit cannot be audited but will still be reported. |
4 |
Name |
Text |
Name used to identify the unit throughout clearPath |
5 |
Abbrev |
Text |
Abbreviation of the unit name (maximum 5 characters) |
6 |
Department |
Text |
Long name for the unit |
7 |
Department ID |
Text |
Unique Department ID, used as a key to match data records in other software |
8 |
Beds |
Number |
The number of beds in the unit |
9 |
Unit Type |
Text |
Acute Care, Long Term Care, etc. designation for the unit |
10 |
Show in Dashboard |
Text |
0 = Unit excluded from Dashboard, 1 = Unit included in Dashboard |
11 |
Reportable |
Text |
Designates whether the unit is a reportable or non-reportable unit. This field is used to |
12 |
Calc Method |
Text |
The method used to determine how observations are calculated. |
13 |
Calc Period |
Text |
If the Calc Method is set to Period, this field defines the period: Weekly, |
14 |
Observations / Period |
Number |
The number of observations required per period when Calc Method is Fixed, or |
Outputs: PDF CSV Excel PNG |
21.10.48. Facility and PCA over Time
The Facility and PCA Over Time report plots compliance for each facility and patient care area across the report period, giving senior leaders a side-by-side view of how every unit is trending. It is typically used for executive rounds and for enterprise-wide performance reviews where ranking units against each other is important.
Outputs: PDF CSV Excel PNG |
21.10.49. HCP over Time
The HCP Over Time report plots compliance by health care provider type across the report period. It is used to confirm that improvement initiatives aimed at a specific HCP group (for example, physicians) are actually translating into measurable change over time.
Outputs: PDF CSV Excel PNG |
21.10.50. User Categories over Time
The User Categories Over Time report plots compliance by user category across the report period. User categories are organisation-specific groupings (such as floats, agency staff, or trainees) and this report makes it easy to compare how each group is trending against the rest of the workforce.
Outputs: PDF CSV Excel PNG |
21.10.51. Attributes
The Attributes report summarises compliance broken down by the optional attributes captured during an audit session (for example, shift, PPE, or any custom attribute configured for your organisation). It is useful when you want to test a hypothesis such as “does compliance dip on night shift?” without building a custom report.
Outputs: PDF CSV Excel PNG |
21.10.52. Custom Audit Survey Results
The Custom Audit Survey Results report returns the raw responses collected for a custom audit survey. Each question and each response is listed so that the survey owner can review the underlying data before it is aggregated. It is commonly used to validate that a newly deployed survey is behaving as expected.
Outputs: PDF CSV Excel |
21.10.53. Custom Audit Survey Rating
The Custom Audit Survey Rating report aggregates custom survey responses into a weighted rating per question and per respondent grouping. It is used by program leads who want a single summary score that can be tracked over time alongside other compliance metrics.
Outputs: PDF CSV Excel |
21.10.54. Custom Audit Survey
The Custom Audit Survey report produces a printable version of a custom audit survey, including the question text and any structured response options. It is typically used when a paper version of the survey is needed for field data collection or for training new survey administrators.
Outputs: PDF Excel |
21.10.55. WHO HHSAF
The WHO Hand Hygiene Self-Assessment Framework (HHSAF) report produces a scored summary of the most recent HHSAF submission for the selected scope. It surfaces the five-component subtotals (System Change, Training & Education, Evaluation & Feedback, Reminders in the Workplace, Institutional Safety Climate), the total score out of 500, and the resulting Hand Hygiene Level (Inadequate, Basic, Intermediate, or Advanced) per WHO’s published banding. If no assessment has been submitted for the scope, the report falls back to instructions for completing the audit, so distributing it monthly works as a built-in nudge for the infection prevention team. The audit instrument is seeded into the custom-audit engine — open Settings → Custom Audits → WHO Hand Hygiene Self-Assessment Framework to complete or update the assessment.
Outputs: PDF Excel |
21.10.56. NHSN Hand Hygiene Summary
The NHSN (National Healthcare Safety Network) Hand Hygiene Summary report is a hand-keying worksheet that mirrors the layout of the CDC NHSN hand-hygiene web form. NHSN does not currently accept hand-hygiene CSV imports — only CLABSI, ICU denominator, SSI, and procedure data — so the report is designed to sit next to the IPC nurse while they type values into NHSN. It aggregates clearPath observations into one row per (facility, unit, month), showing opportunities, compliant actions, and the computed compliance percentage for the selected period.
Outputs: PDF Excel |
21.10.57. Leapfrog Hand Hygiene Standard
The Leapfrog Hand Hygiene Standard report produces a scored summary of the most recent Leapfrog 2026 Hand Hygiene Standard submission for the selected scope. It evaluates the five domains (Monitoring, Feedback, Training & Education, Infrastructure, Culture) on a per-domain pass/fail basis (every question in a domain must be answered “Yes” for the domain to be Met) and then determines whether the facility satisfies Path A (Monitoring + Feedback + at least two of Training, Infrastructure, Culture, with at least 200 hand hygiene opportunities per unit per month) or Path B (Monitoring + Feedback + all of Training, Infrastructure, and Culture, with at least 100 opportunities per unit per month). The Monitoring and Feedback domain elements are captured verbatim from Leapfrog’s 2026 Hand Hygiene Fact Sheet (carried forward unchanged from the 2024 fact sheet); the Training, Infrastructure, and Culture sub-questions are paraphrased from the publicly stated domain requirements and should be validated against Leapfrog’s gated scoring-criteria PDFs before formal Survey submission. They can be edited via Settings → Custom Audits → Leapfrog Hand Hygiene Standard (2026). Pathway thresholds for opportunities per unit per month are assumed to have been independently verified.
Outputs: PDF Excel |
21.10.58. Hawthorne Effect
The Hawthorne Effect report estimates true unobserved hand hygiene compliance from the observed compliance captured by auditors. Direct observation is known to inflate measured compliance because subjects modify behaviour when they know they are being watched. The report applies an account-level Hawthorne factor (default 0.55) and floor (default 30 %) to the observed rate for each facility and patient care area, displaying both the observed and Hawthorne-adjusted values side by side along with a companion bar chart. Infection prevention leaders use the report to present a more conservative view of compliance to senior leadership and to set realistic improvement targets.
About the Hawthorne adjustment. Direct human observation of hand-hygiene events is known to inflate measured compliance because subjects modify behavior when they know they are being watched (the “Hawthorne effect”). The factor and floor applied above are configured at the account level and are intended to estimate true unobserved compliance from observed rates.
Empirical basis:
Srigley JA, Furness CD, Baker GR, Gardam M. Quantification of the Hawthorne effect in hand hygiene compliance monitoring. BMJ Quality & Safety, 2014. Compliance dropped to roughly one third of observed levels when auditors were not present.
Eckmanns T, Bessert J, Behnke M, Gastmeier P, Ruden H. Compliance with antiseptic hand rub use in intensive care units: the Hawthorne effect. Infection Control & Hospital Epidemiology, 2006. Observed compliance ~55 %, unobserved ~29 %.
Kohli E, Ptak J, Smith R, et al. Variability in the Hawthorne effect with regard to hand hygiene performance in high- and low-performing inpatient care units. ICHE, 2009.
The default factor of 0.55 and floor of 30 % derive from these studies; account administrators can override both via Settings | Account | Hawthorne.
Outputs: PDF CSV Excel PNG |
21.10.59. CMS Care Compare-Styled Summary
The CMS (Centers for Medicare & Medicaid Services) Care Compare-Styled Summary is a single-page board / leadership view of overall hand hygiene compliance, rendered in the visual idiom of CMS Care Compare — a headline percentage, a five-star rating mapped from compliance, and plain-language framing of “How does this hospital compare?”. Hand hygiene is not itself a CMS-reported measure (only downstream HAI rates such as CLABSI, CAUTI, CDI, MRSA, and SSI are publicly reported via CMS, sourced from NHSN), so the report explicitly notes that the framing is for internal leadership use rather than a regulatory submission.
Outputs: PDF Excel |
21.10.60. P-Chart
The P-Chart is a Statistical Process Control (SPC) chart that plots the proportion of compliant hand hygiene observations for each subgroup (typically a month) against a calculated centre line and upper and lower control limits. Quality leads and infection prevention teams use it to tell ordinary month-to-month variation apart from a real shift in performance, so improvement work can be focused on genuine signals rather than statistical noise.
Each subgroup is plotted as a single point. The centre line shows the overall compliance rate across the reporting window, and the upper and lower control limits widen or narrow with the number of observations in each subgroup — small samples produce wider limits, large samples produce tighter ones. Points that fall inside the control limits are flagged as In Control, while points that fall outside are flagged as Out of Control and highlight subgroups that warrant a closer look.
Tip
The P-Chart works best with at least eight to twelve subgroups of data. Very small numbers of observations in any subgroup will produce control limits so wide that almost every point appears In Control — review the underlying observation volume before drawing conclusions.
Note
The P-Chart is a process-stability tool, not a target-versus-actual report. A point inside the control limits does not mean compliance is acceptable — it only means performance is statistically stable at the current level. Pair the P-Chart with a goal-based report such as Compliance over Time when assessing whether targets are being met.
Outputs: PDF CSV Excel PNG |
21.10.61. Pareto Hand Hygiene
The Pareto Hand Hygiene report applies the classic 80/20 lens to non-compliance. Bars show the count of non-compliant observations per category, sorted from largest to smallest, while a cumulative-percentage line rides across the tops of the bars. A dashed reference line at 80 % marks where the running total reaches the “vital few” threshold. Quality leads and infection prevention teams use the report to focus improvement work on the small number of categories that drive the bulk of failures, rather than spreading effort thinly across every category.
Three layout styles are available so the same chart can be pivoted around different x-axis dimensions without creating separate report types.
21.10.61.1. Style A - Moment
Style A breaks non-compliance down by the WHO Five Moments for Hand Hygiene (Before Patient, After Patient, Before Asepsis, After Body Fluid, After Touching Patient Surroundings). Use this style when you want to identify which moments of care drive the bulk of missed hand hygiene opportunities. With only five categories the chart reads at a glance and is the most common starting point.
21.10.61.2. Style B - HCP
Style B breaks non-compliance down by individual healthcare provider. Each bar represents one provider in scope, sorted from worst to best, with providers who had no observations in the period omitted. Use this style to highlight the small number of providers who account for most of the non-compliance — typically the target audience for one-on-one coaching or refresher education.
21.10.61.3. Style C - Units
Style C breaks non-compliance down by patient care area (unit). Bars are labelled with the facility and unit name (for example General Hospital — ICU), sorted from worst to best. Use this style for organisations operating across multiple units or facilities to identify which areas are pulling overall compliance down, and to direct in-service training, audits, or supply checks at the units that will produce the biggest improvement.
Tip
The 80 % threshold line is a reference, not a target. Where the cumulative line crosses the 80 % mark, every category to the left is part of the “vital few” that drives the bulk of non-compliance. Focusing improvement effort on those categories typically produces a larger gain than spreading effort across the whole list.
Note
The report includes only categories that had at least one observation in the period; for Style B and Style C, categories with zero non-compliant observations are also omitted so the chart is not padded with empty bars. Apply Facility, Unit, or HCP filters to scope the report further.
Outputs: PDF CSV Excel PNG |
22. Keyword Manager
The Keyword Manager controls which words are excluded from the Word Cloud report. Short articles, prepositions, and common filler words add noise to a word cloud without adding meaning, so clearPath keeps a per-account exclusion list you can tune.
To open the Keyword Manager, go to Advanced | Keyword Manager.
22.1. Fields
Minimum Word Length— the shortest word that will appear in the cloud. Anything shorter is dropped. The default is three characters.Excluded Words— a comma- or line-separated list of words clearPath should always leave out, even if they are longer than the minimum length. Type a word, then add more separated by commas or newlines.Words excludedcounter — shows how many words are currently on the exclusion list as you edit.Tag Preview — a live preview of the first handful of excluded words, rendered as pills so you can spot stray entries at a glance.
Changes are saved automatically and the Saved indicator
confirms the write. The next Word Cloud report generated for the
account uses the updated list.
23. Distribution Lists
Distribution Lists let you package one or more clearPath reports and have them delivered to a group of people by email on a schedule of your choice. You build the list once, pick who should receive it and how often, and clearPath takes care of the rest.
To open the list, go to Reports | Distribute.
23.1. At-a-Glance Cards
Summary cards across the top of the page show:
Total Lists — how many distribution lists exist on the account.
Total Members — the combined number of recipient email addresses across every list.
Scheduled — how many lists are set to run on a recurring frequency (
Monthly,Quarterly, orAnnually).Failed / Partial — how many lists did not deliver cleanly the last time they ran.
Never Run — how many lists have not yet been sent.
23.2. Page Header Buttons
Export— opens a menu with three choices, each applied to the rows currently visible after searching and filtering:Export to HTML— opens a printable version in a new tab.Export to CSV— downloads a comma-separated file.Export to Excel— downloads a spreadsheet file.
Exportbecomes available once at least one list is ticked.Manage— opens a menu with three choices:Manage Global List Settings— opens the Global Distribution Settings dialog where you can set the time of day distribution lists run and add BCC addresses. See the section below.Manage Recipients— opens the Manage Recipients page, a single place to see every email address that appears on any list and remove a recipient from many lists at once.Test Send Selected Distribution Lists— sends the ticked lists immediately so you can verify how they arrive without waiting for the next scheduled run.
New List— opens a short dialog where you enter the name, owner, account, and frequency for a new distribution list. Once you save, you are taken to the Distribution List Editor to finish setting up options, recipients, and reports.
23.3. Searching and Filtering
The toolbar above the table lets you narrow the list down quickly.
Search box — matches on the list name, the owner’s name, and the account.
All Accounts — only shown if you have rights to more than one account; filters the table to a single account.
All Frequencies — filters by the delivery schedule:
Monthly,Quarterly,Annually, orNever.All Email Statuses — filters by the outcome of the most recent send:
Delivered,Partial,Failed,Pending, orNot Run.All Owners — filters by the person who owns the list.
A refresh button on the right reloads the page from the server.
23.4. Table Columns
Every list on the page is shown in a table that groups rows by account.
Status— anActiveorInActivebadge. Click the badge to toggle the status without opening the editor.List Name— the name and optional description of the list.Send Options— four small icons that light up when the matching option is on for that list:Bundle Reports — merge every PDF into a single file.
Unsubscribe — include an unsubscribe link in the email.
Send Link — email a link instead of attaching files.
Compress Reports — pack the files into a single ZIP.
Owner— the clearPath user who owns the list.Last Executed— the date the list was last sent, colour-coded so recent runs look fresh and older runs stand out. Lists that have never run showNever run.Members— the number of recipient email addresses.Reports— the number of reports attached to the list.Frequency— how often the list is scheduled to run.Go/No-Go— a readiness badge.Gomeans the list has at least one recipient, at least one report, and no stale reports.No-Goshows a hint explaining what is missing, such asNo members assigned,No reports assigned, or a count of stale reports that need updating.
Tick the checkbox at the left of any row to select it; tick the
header checkbox to select every row on the page. Selecting one or
more rows reveals the bulk action bar at the top of the page, with a
Delete Selected button and a button to clear the selection.
23.5. Row Actions
Click the three-dot button at the end of a row to open the row menu:
Edit— opens the list in the Distribution List Editor.Execute Distribution— sends the list right now, outside its normal schedule. Useful for one-off deliveries or to replay a list that previously failed.Update Stale Reports— refreshes any reports on the list whose last-run date is older than their scheduled cadence.Delete List— removes the list after a confirmation prompt. The underlying reports are not deleted.
23.6. List Health
Every list is continually checked against a short set of requirements so it can deliver without surprises:
State |
What it means |
|---|---|
Active ( |
The list is enabled, has at least one recipient, at least one report, and no stale reports. It will run on its schedule. |
Inactive |
The list is disabled and will not be scheduled. Toggle the status pill on the row to re-enable it. |
Configuration Issue ( |
The list is missing a recipient, missing a report, or has stale reports. It will stay on hold until the issue is fixed. |
Note
If a list has a configuration issue, the owner receives an email summary of what is wrong once every twenty-four hours until the list is either fixed or disabled.
Tip
Most configuration issues clear up by refreshing the affected reports, adding at least one recipient, and adding at least one report to the list.
23.7. Distribution List Editor
The editor opens when you click New List, Edit on a row’s
menu, or use Manage Global List Settings. It is organised into
three tabs.
23.7.1. General Tab
The Active toggle at the top marks the list enabled or disabled.
Core fields:
Name— the list name shown in the table and in emails.Description— an optional note that appears under the name in the list.Account— the account the list belongs to. Locked to your own account unless you have rights to more than one.Owner— the clearPath user responsible for the list. The owner receives configuration-issue emails.Frequency— how often the list is sent:Monthly,Quarterly,Annually, orNever.Neveris useful for lists you plan to run by hand.
Options
Option |
What it does |
|---|---|
Merge PDF Report |
Combines every PDF report on the list into a single PDF. Reports in other formats are attached as normal. |
Compress Reports (ZIP) |
Packs every report, whatever its format, into a single ZIP file attached to the email. |
Send Report Link Only |
Leaves the reports on the server and sends recipients a single link they can use to view or download them. |
Allow Recipients to Unsubscribe |
Adds an unsubscribe link to the email so recipients can remove themselves from this list. See Unsubscribing from a List. |
23.7.2. Mail Tab
Fields:
Subject— the email subject line.Body— up to 255 characters of text that appears in the email above the reports.Include Signature— append the owner’s clearPath signature block to the message.
Below the message fields, the Mail tab lists every recipient on the
list. Type an email address into the box and click Add (or press
Enter) to add a recipient. Click the x next to a name to remove
them.
23.7.3. Reports Tab
Use the Reports tab to pick which reports go out with the list. A
filter bar at the top narrows the tree down by file name, report
type, or output format (PDF, HTML, XML, CSV,
Excel). Three helper buttons let you jump to Show Selected,
Select All, or Unselect All.
Each row in the tree has a checkbox; tick the reports you want to include. A status line at the bottom shows how many reports are currently selected.
23.8. Manage Recipients
The Manage Recipients page (reached from the Manage menu on
the list page) shows a flat view of every email address that appears
on any distribution list for the account, with a column listing the
lists each recipient is currently on.
Use this page to:
Find every list a specific person is on.
Remove an address from several lists at once without opening each list individually.
Export the full recipient directory to HTML, CSV, or Excel.
23.9. Unsubscribing from a List
When the Allow Recipients to Unsubscribe option is turned on for
a list, every email clearPath sends includes a click here to
unsubscribe link at the bottom.
Clicking the link opens a short page where the recipient confirms
their email address and presses Unsubscribe.
clearPath sends a confirmation email once the removal succeeds.
Note
This removes the recipient from a single list. Someone on several lists must repeat the process for each one.
Warning
The unsubscribe link is valid for ten days after the email is sent. After that, the recipient can wait for the next scheduled email and use the fresh link, ask their clearPath administrator for help, or contact support@clearpathhealthsolutions.com.
23.10. Distribution Scheduling
clearPath now refreshes reports starting at 3:00 AM GMT and sends the distribution lists out at 6:00 AM GMT. The three hour gap gives reports time to finish before the distribution schedule fires, and the prepared reports are emailed during the 30 minute window from 6:00 AM GMT to 6:30 AM GMT.
Having the reports and distributions run based on the GMT time, avoid potential issues with timezones, switching between daylight savings times and back and future changes to local implementations of daylight saving time switching.
Note
The clearPath server now has its time set GMT not local time as in previous versions. To make sure dates and times shown in the user interface are accurate for you, it is important to set your time zone in the Accounts | Options dialog. Without a correct time zone, run times, last-executed timestamps, and scheduled send times will appear offset from your local clock.
23.11. Global Distribution Settings
clearPath runs distribution lists at 6:00 AM GMT by default. Reports start refreshing at 3:00 AM GMT, giving them three hours to finish before the schedule fires. See Distribution Scheduling for more on the timing and time zone behaviour.
To change the send time or add BCC addresses, go to
Reports | Distribute, click Manage, and choose
Manage Global List Settings. In the dialog:
Account— pick the account whose settings you are editing (only shown if you have rights to more than one).Time to Send List— pick a time of day in fifteen-minute increments.BCC— type an address and pressAddto BCC every list on the account to that address. Remove an address by clicking thexnext to it.
Click Submit to save, or Cancel to close without saving.
24. Report Archive
clearPath keeps a rolling monthly archive of every report produced on the system. Each archive is a single ZIP file, built and kept up to date continuously so that at any moment during the month the file on disk contains every report that has been generated so far. On the first of the next month, clearPath rolls the archive over — the previous month is sealed and a fresh archive starts filling for the new one.
The archive is your long-term record. Whenever you need to prove what a report looked like at a given point in time — for a regulator, an audit, or an internal review — the archive is where you go.
To open the archive, go to Reports | Archive.
24.1. At-a-Glance Cards
Three summary cards across the top of the page show:
Total Files — how many archived ZIP files clearPath currently holds.
File Types — how many distinct file types are represented (typically just
ZIP, but the count lets you see if an older format ever got mixed in).Total Size — the combined on-disk size of every file in the archive, in MB or GB.
24.2. Page Header Buttons
Export— opens a menu with three choices. Each export produces a listing of the archive’s contents in the chosen format, scoped to whatever search / filter you have active:Export to HTML— opens a printable report in a new tab.Export to CSV— downloads a comma-separated file.Export to Excel— downloads a spreadsheet file.
24.3. Searching
The search box in the toolbar matches on the archive’s file name. Clear the box to go back to the full list. A refresh button beside the search box reloads the list from the server — useful when a report has just finished running and you want to see it appear in the archive.
24.4. Table Columns
Filename— the archive’s file name, generally the formMmm_YYYY.zip(for example,Apr_2026.zip). Click the heading to sort alphabetically.Last Modified— the most recent time the archive was updated. Today’s archive updates as new reports generate; previous months are effectively frozen.Size— the on-disk size of the ZIP file.
Tick the checkbox on a row to select it, or tick the header checkbox to select every row on the page. Selecting one or more rows reveals the bulk-action bar with Download and Delete Selected buttons so you can pull several months down at once.
24.5. Row Actions
Click the three-dot button at the end of a row to open the row menu:
Download— downloads the ZIP file to your device.Delete— removes the archive after a confirmation prompt.
Warning
Deleting an archive is permanent. clearPath cannot
rebuild an archive from source after it has been removed —
the archive is the only record of what the reports looked
like on the day they were generated. Use Delete only
when you have an off-site copy you are comfortable with, or
when you have confirmed a month is no longer needed.
24.6. Opening an Archive
Once you have downloaded a ZIP, open it with any standard archive tool (the built-in extractor on Windows, macOS, and most mobile platforms handles it natively). Inside, the reports are laid out in a predictable folder tree so you can navigate straight to the scope you need without scanning every file:
archive/
corp/
hospital name/
pca name/ ← patient care area
program name/
unit name/
<report files>.pdf
<report files>.csv
<report files>.xls
Only reports where clearPath found both an existing report definition and a generated file at the time of archive rollover are included. Reports whose definitions have since been deleted still appear in older archives — that is the point of keeping them.
Tip
Because archives are built month by month, point-in-time queries are simple: grab the ZIP for the relevant month and everything that was on the server at that time is inside. There is no need to recreate historical reports — they are already preserved.
25. Report Groups
A Report Group is a saved collection of reports. Once you set one up, you can pick it anywhere in clearPath that asks for a group — on a distribution list, in a bulk operation, or when you simply want to look at a related set of reports side by side. Groups can be built manually, or they can fill themselves in based on a rule so you do not have to re-assign reports each time a new one is added.
To open the list, go to Reports | Report Groups.
25.1. How a Group Decides Which Reports Belong
When you create a group you pick a Type. The type decides how reports become members.
Type |
How reports join the group |
|---|---|
Manual |
You add reports to the group by hand, one at a time, on the report itself. Nothing is pulled in automatically. |
Period |
clearPath watches the time period set on each report and
automatically includes every report whose period matches the
one you picked (for example |
User |
Every report owned by the user you picked is included automatically. |
Tag |
Every report that carries one of the tags you listed is included automatically. You can list as many tags as you like. |
Reportable |
Includes reports based on whether they are marked
|
Category |
Includes every report that belongs to a given user category. |
Format |
Includes every report in a given output format, such as
|
25.2. The Report Groups Page
25.2.1. At-a-Glance Cards
Four summary cards across the top of the page show:
Total Groups — how many groups exist on the account.
Period Groups — how many of those are period-based.
User Groups — how many are tied to a specific user.
Total Reports — the combined number of reports across every group.
25.2.2. Page Header Buttons
Export— opens a menu with three choices. The export respects whatever you have typed in the search box, so the file contains only the rows you can currently see:Export to HTML— opens a printable version in a new tab.Export to CSV— downloads a comma-separated file.Export to Excel— downloads a spreadsheet file.
Group— opens the editor with a blank form so you can create a new group.
25.2.3. Searching
The search box in the toolbar matches on the group name, the account name, and the names of the individual reports inside each group. A refresh button beside it reloads the page from the server.
25.2.4. Table Columns
Name— the group’s display name. Click the heading to sort.Type— one of the seven types above, shown as a coloured badge. Click the heading to sort.Reports— the number of reports currently in the group. Click the heading to sort.Reports Included— a strip of small coloured pills, one per report, so you can see the contents of the group at a glance.
Tick the checkbox at the left of a row to select it, or tick the header checkbox to select every row on the page.
25.2.5. Row Actions
Click the three-dot button at the end of a row to open the row menu:
Edit— opens the group in the editor.Delete— removes the group after a confirmation prompt. The reports inside the group are kept; they are simply no longer linked to the deleted group.
25.3. The Report Group Editor
The editor opens as a dialog. You can reach it by clicking Group
in the page header to create a new group, or by choosing Edit on
the three-dot menu of an existing row.
The toggle switch in the top right of the dialog marks the group as Active or Inactive. An inactive group stays on the list but is hidden from the pickers where you would normally choose a group.
25.3.1. Fields Shown for Every Type
Name— the label shown everywhere the group appears.Abbrev— a short code (up to ten characters) used in compact views and in some export formats.Account— the account the group belongs to. Only shown if you have rights to manage more than one account.Type— the group type. Switching this reveals the matching extra field described below.
25.3.2. The Extra Field for Each Type
Depending on the Type you pick, one additional field appears:
Type |
Extra field |
|---|---|
Manual |
None. You add reports to the group one at a time on the report itself. |
Period |
|
User |
|
Tag |
|
Reportable |
|
Category |
|
Format |
|
25.3.3. Saving and Cancelling
Submit— saves the group and returns you to the list.Cancelor thexat the top right — closes the editor without saving.
25.4. Report Sharing
Report sharing allows your organization to access finished hand hygiene reports right from your own network. The share is read-only and can only be modified by clearPath. No username or password is required to view finished reports. All published reports are accessible to anyone with network access.
The reports are organized into directories on the share to make it easier to find the report. Reports are organized by Corporation, Facility, Program Groups, Unit Groups, Patient Care Areas and Time Period.
To enable report sharing go to Reports | Options.
In the Report Share Section place a check box in Enable Report Sharing check box. The share is not password protected and is accessible to anyone on the network. The share is set to read only and can only be modified by the clearPath report engine.
For each report you wish to published, go to the Share tab in the report definition, and place a check in the Share Report checkbox. Press OK when done to save the settings. clearPath will configure the share automatically. It may take a minute or so before the share is browse able in your file explorer. By default reports are not publicly shared so the share may be empty when it is first viewed. Once the report definition is set to share, the report must be updated (executed) before it will appear in the network share directory.
To access the share from your MAC open Finder and go to Go | Connect to Server. Enter the server address smb://127.0.0.1.
Replace 127.0.0.1 with your clearPath appliance IP address or DNS name.
To access the share from your Windows desktop, open up File Explorer and enter the following into the address bar \127.0.0.1share. Replace 127.0.0.1 with your clearPath appliance IP or DNS name.