.. include:: ../variables.rst

.. _groups:

Groups and Programs
===================

Groups (sometimes called Programs) let you bundle patient care units
together under a shared label --- for example an *ICU Care Team*
rolling up several step-down units, or a *Surgical Program* covering
every OR and recovery room. Groups show up as filter options on the
:ref:`dashboard<dashboard>` and on many reports, so you can track
compliance for a program of care rather than a single unit.

To open the Groups list, go to :blue:`Account` | :blue:`Groups &
Programs`.

.. _groups.list:

Group List
----------

.. figure:: /images/lightmode/groups-list.png
   :align: center

|br|

Stat Chips
^^^^^^^^^^

Cards across the top give you an instant rollup:

* ``Groups`` --- the total number of groups on the account.
* ``Unit Assignments`` --- the total number of unit-to-group links
  across all groups. A single unit that belongs to three groups
  counts as three assignments.
* ``Unique Units`` --- how many distinct units appear in at least
  one group.
* ``Avg per Group`` --- the average number of units per group.

Page Header Actions
^^^^^^^^^^^^^^^^^^^

* ``New Group`` --- opens the quick-create modal (see
  :ref:`groups.new.modal`).
* ``Export`` --- saves the current (filtered) list to HTML, CSV, or
  Excel.

Filtering
^^^^^^^^^

* ``Search groups…`` --- matches text in the group name.
* ``All Accounts`` --- scope to a single account.
* ``All Short Codes`` --- filter by the group's short code
  abbreviation.
* ``All Types`` --- filter by the internal type label (``Group``,
  ``Program``, …).
* ``All Units`` --- show only groups that contain a particular unit.
* Expand-all / Collapse-all --- expand or collapse every ``Units``
  column so you can see all assigned units at once, or collapse long
  lists back to a summary count.
* Refresh --- reload the list.

Row Columns
^^^^^^^^^^^

Rows group by facility. Each row shows:

* ``Active`` --- a green ``Active`` badge when the group is in use,
  grey when disabled. Display-only --- to change the active state,
  open the :ref:`groups.editor` and toggle ``Active``.
* ``Name`` --- the group name.
* ``Short Code`` --- a short abbreviation used in reports and
  dashboards (e.g. ``ICU``, ``T6``).
* ``Count`` --- the number of units assigned to the group.
* ``Units`` --- unit chips for each member; long lists collapse to
  ``+N more``. Click ``+N more`` to expand the full list, or
  ``less`` to collapse it again.
* ``Color`` --- the color swatch used to tint the group on dashboard
  charts.
* ``Type`` --- the internal type classification.

Row Action Menu
^^^^^^^^^^^^^^^

Click the three-dot icon at the end of any row:

* ``Edit`` --- opens the full :ref:`groups.editor` (General +
  Members tabs) for that group.
* ``Delete`` --- permanently removes the group after a confirmation
  prompt.

Bulk Selection
^^^^^^^^^^^^^^

Tick one or more checkboxes to reveal the bulk-selection bar, then
``Delete Selected`` to remove several groups at once. Click the
``x`` to clear the selection.

.. _groups.new.modal:

New Group Quick-Create
----------------------

The ``New Group`` button on the page header opens a compact modal for
creating a group in one step.

.. figure:: /images/lightmode/group-new-modal.png
   :align: center

|br|

* ``Group Name`` --- a human-readable label, e.g. ``ICU Care Team``.
* ``Short Code`` --- a short identifier (up to 12 characters)
  automatically upper-cased as you type. Used on reports and on
  dashboards that need a compact label.
* ``Color`` --- pick a color with the swatch or paste a hex value.
  Used to tint the group's charts.
* ``Units`` --- type a unit name and press ``Enter`` (or a comma) to
  add it as a chip. Click a chip to remove it.

Click ``Save Group`` to create the group, or ``Cancel`` to discard.

.. _groups.editor:

Group Editor
------------

Choosing ``Edit`` from a row's action menu opens the full editor,
which includes everything in the quick-create modal plus an
``Active`` toggle and a dedicated Members tab.

General Tab
^^^^^^^^^^^

.. figure:: /images/lightmode/group-detail-general.png
   :align: center

|br|

* ``Active`` --- toggle the group on or off without deleting it.
  Inactive groups are ignored by dashboards, reports, and filter
  pickers.
* ``Group Name`` --- the display label.
* ``Short Code`` --- a short identifier (up to 3 characters in the
  full editor).
* ``Color`` --- pick a color with the swatch or paste a hex value.

Members Tab
^^^^^^^^^^^

.. figure:: /images/lightmode/group-detail-members.png
   :align: center

|br|

Manage which units belong to this group.

* ``Add Unit`` --- pick a unit from the dropdown and click ``Add``.
  The dropdown lists every unit not already in the group.
* ``Assigned Units`` --- the chips show every unit currently in the
  group. Click a chip to remove the unit from the group.
* ``Total Members`` --- a live count of the units currently
  assigned.

Click ``Submit`` to save the changes or ``Cancel`` to go back
without saving.