.. include:: ../variables.rst Facilities and Units ==================== In |APPNAME|, a **facility** is a physical site (a hospital, clinic, long-term care home, or any other building where auditing happens). A **unit** is a subdivision of a facility, such as a patient care area, department, or ward. You set facilities and units up once, and the rest of |APPNAME| — dashboards, reports, distribution lists, challenges, and auditing — uses them to scope data and colour-code results. To open the list, go to :blue:`Account` | :blue:`Facilities / Floors / Units`. .. _facility.list: The Facilities Page ------------------- .. figure:: /images/web/web.facility.list.png :align: center :width: 100 % |br| Every facility on the account is listed one row per line. You can expand a row to see the units inside it, and everything on the page can be searched, filtered, or exported. At-a-Glance Cards ^^^^^^^^^^^^^^^^^ Six summary cards across the top of the page show: * **Facilities** — how many facilities exist on the account. * **Active Facilities** — how many are currently enabled. * **Inactive Facilities** — how many are disabled. * **Total Units** — the combined number of units across every facility. * **Active Units** — how many of those units are currently enabled. * **Inactive Units** — the remaining count. Page Header Buttons ^^^^^^^^^^^^^^^^^^^ * ``Export`` — opens a menu with ``Export to HTML``, ``Export to CSV``, and ``Export to Excel``. The export respects any search or filter you have applied, so it only contains the rows you can currently see. ``Export`` is enabled once at least one row is ticked. * ``View Map`` — opens the facility map, which plots every facility with an address on a world map. * ``Add Facility`` — opens the :ref:`facility editor` with a blank form. Searching and Filtering ^^^^^^^^^^^^^^^^^^^^^^^ The toolbar above the table holds the search box and several filters: * **Search box** — matches on the facility name. * **All Facilities** — narrows the table to a single facility. * **All Status** — show only ``Active`` or only ``Inactive`` facilities. * **All Lock States** — show only ``Locked`` or only ``Unlocked`` units. * **Last Audited** — show facilities whose most recent audit is older than 7, 14, 30, 60, 90, 180, or 365 days, or ``Never`` audited. * **Time period** — the span used to calculate each facility's compliance percentage (defaults to ``This Month``). A refresh button on the right reloads the page from the server. Table Columns ^^^^^^^^^^^^^ Every row in the table is a facility. Click the row to expand it and reveal the units inside. * ``Status`` — an ``Active`` or ``Inactive`` badge. * **Lock icon** — shows whether the facility is locked. * ``Facility`` — the facility name and icon. Click the heading to sort. * ``Abbrev`` — the four-character abbreviation. * ``Floors`` — the number of floors defined for the facility. * ``Units`` — how many units the facility contains. * ``Include`` — whether the facility is included in the dashboard and in corporate reports. * ``Color`` — the colour swatch used to tag the facility in charts. * ``Compliance`` — a percentage bar showing the facility's performance for the selected time period. * ``Last Audited`` — how long ago the most recent audit took place. Tick the checkbox at the left of a row to select it, or tick the header checkbox to select every row on the page. Selecting rows reveals the bulk action bar with a ``Delete Selected`` button and a clear-selection button. Row Actions ^^^^^^^^^^^ .. figure:: /images/web/web.facility.list.with.menu.png :align: center :width: 100 % |br| Click the three-dot button at the end of a row to open the row menu: * ``View Units`` — expands the facility so its units are visible in the table. * ``View Floors`` — opens the floor plan page for the facility. * ``Edit`` — opens the facility in the editor. * ``Delete`` — removes the facility after a confirmation prompt. If the facility has units, every unit inside it is removed as well, so |APPNAME| warns you before the delete goes through. Each unit row has its own three-dot menu with ``Edit`` and ``Delete`` options for that unit. .. _facility.general: The Facility Editor ------------------- The editor opens as a modal dialog with four tabs. You reach it by clicking ``Add Facility`` in the page header or by choosing ``Edit`` on the three-dot menu. The ``Active`` toggle at the top of the General tab marks the facility enabled or disabled. When a facility is disabled, its data is held back from reports and it does not appear in the picker where auditors choose a facility to audit. General Tab ^^^^^^^^^^^ .. figure:: /images/web/web.facility.general.png :align: center :width: 100 % |br| * ``Account`` — the account the facility belongs to. * ``Name`` — the facility name used everywhere in |APPNAME|. * ``Abbreviation`` — a short code (maximum four characters) used in compact views and exports. * ``Color`` — the colour shown for this facility in charts and dashboards. Pick a swatch or type a hex value. * ``Index`` — an optional four-digit identifier. Historically this mirrored a ministry-of-health spreadsheet; leave it blank if you have no need for it. * ``Region`` — the region the facility is grouped under. * **Include In Dashboard** — when on, the facility's numbers roll up into dashboard widgets. * **Include in Corporate Reports** — when on, the facility is included in account-level (corporate) reports. Address Tab ^^^^^^^^^^^ .. figure:: /images/web/web.facility.address.png :align: center :width: 100 % |br| Fill in the facility's physical address and |APPNAME| will plot it on the map shown on the right of the tab: * ``Address``, ``City``, ``Province / State``, ``Postal Code``, ``Country`` — standard address fields. * ``Phone`` and ``Fax`` — contact numbers. * ``Latitude`` and ``Longitude`` — entered in degrees, minutes, and seconds with N/S and E/W indicators. The map recentres automatically when the coordinates change. If coordinates are not supplied, |APPNAME| geocodes the address to place a pin on the map. Notify Tab ^^^^^^^^^^ .. figure:: /images/web/web.facility.notify.png :align: center :width: 100 % |br| Use this tab to have |APPNAME| send email alerts when the facility slips outside normal operating ranges: * **Enable Email Notifications** — master switch. If this is off, the rest of the tab is ignored. * ``Notification Email`` — the address that receives the alerts. * **Notify on Compliance Below Threshold** — fires when the facility's compliance drops below the threshold set on the Thresholds tab. * **Notify on Missed Audit Schedule** — fires when an expected audit does not run. * **Notify on Target Behind** — fires when the facility falls behind its monthly target. * ``Notification Note`` — free-form text that is included at the bottom of every alert email. Thresholds Tab ^^^^^^^^^^^^^^ .. figure:: /images/web/web.facility.thresholds.png :align: center :width: 100 % |br| * ``Target (%)`` — the compliance target the facility is aiming at. * ``Assigned Target`` — the named target profile currently in use. * **Gloves Required on ASP/BFL Events** — when on, a glove change is required for audits in the ``ASP/BFL`` group. * ``Minimum Hand Wash Duration (seconds)`` — shown only when gloves are required; sets the minimum handwash time. Saving and Cancelling ^^^^^^^^^^^^^^^^^^^^^ Click ``Save`` (or the blue confirmation button at the bottom of each tab) to write your changes. Close the dialog without saving by pressing the ``x`` at the top right or using the browser's back button. Units ----- Units live inside facilities. On the facilities list you can expand any row to see the units inside it; each unit has its own three-dot menu with ``Edit`` and ``Delete`` options. Unit Detail ^^^^^^^^^^^ .. figure:: /images/web/web.unit.details.png :align: center :width: 100 % |br| The unit editor has up to five tabs: **General**, **Options**, **Schedule**, **Locked**, and (for Leapfrog-licensed accounts) **Leapfrog**. The General tab collects the core fields: * ``Parent Facility`` — which facility the unit belongs to. * ``Area Name`` — the patient-care area or department name. * ``Abbreviation`` — a short code (maximum four characters). * ``Department Name`` / ``Department ID`` — optional department labels. * ``Unit Type`` — ``Reportable`` units roll up into corporate reports; ``Non-Reportable`` units are tracked but excluded. * ``Color`` — the unit's chart colour. The Options tab gathers the per-unit toggles, including whether the unit is active and whether it is locked. The Locked tab shows the audit-lockout history for the unit — periods during which data for the unit has been frozen. .. _unit.leapfrog: Leapfrog Tab ^^^^^^^^^^^^ .. figure:: /images/lightmode/unit-detail-leapfrog.png :align: center |br| The Leapfrog tab is shown only when the account is licensed for the Leapfrog module. Use it to override the account-level Leapfrog settings (see :ref:`accounts.leapfrog`) for this unit. Leave a field blank to inherit the value from the account. * ``Monthly target`` --- minimum observations expected per month. * ``Quarterly target`` --- minimum observations expected per quarter. * ``Semi-annual target`` --- minimum observations expected per six-month period. * ``Annual target`` --- minimum observations expected per year. * ``Custom range (per month)`` --- the per-month rate used when a dashboard or report applies a custom date range that does not match one of the standard cadences. * ``Complete % ≥`` --- the compliance percentage at which this unit is classified as ``Complete``. * ``Gap % ≥`` --- the compliance percentage at which this unit is classified as ``Gap``. Anything below this threshold is treated as ``Missing``. Click ``Reset all to account default`` to clear every field on this tab so the unit inherits the account-level Leapfrog values. Schedule and Reminders ^^^^^^^^^^^^^^^^^^^^^^ .. figure:: /images/web/web.unit.reminders.png :align: center :width: 100 % |br| The Schedule tab controls how often the unit should be audited and whether |APPNAME| sends reminder emails when an audit is overdue: * ``Target`` — the number of audits expected in the scheduled period. * ``Pass`` / ``Total`` — current progress toward that target. * ``Plus / Minus`` — how many audits the unit is ahead or behind. * ``Last Audited`` — the date of the most recent audit. * ``Reminders Enabled`` — when on, |APPNAME| emails the unit's contacts when the unit is falling behind.