.. include:: ../variables.rst

.. _regions:

Regions
=======

Regions let you group corporations and facilities geographically so they can be
filtered, colored, and reported on as a single unit. Typical uses are grouping
facilities by continent, by Local Health Integration Network (LHIN), or by any
custom region you define.

To access the Regions list click on :blue:`Account` | :blue:`Advanced` |
:blue:`Regions`.

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

|br|

Region List
-----------

The list toolbar provides the following controls:

* **Search** --- filter the table by region name.
* **Status** --- show ``Active``, ``Inactive``, or all regions.
* **Region Type** --- filter by ``Generic``, ``Continent``, or ``LHIN``.
* **Refresh** --- reload the table.

Click any region row to open the detail editor. Use ``Add Region`` in the top
right to create a new region.

.. _region.detail:

Region Detail
-------------

.. figure:: /images/lightmode/region-detail.png
   :align: center

|br|

Region Name
^^^^^^^^^^^

A human-readable name for the region (for example, ``Ontario LHIN`` or
``North America``). This is the label that appears in reports and on
dashboards when facilities are grouped by region.

Enabled
^^^^^^^

Toggle whether this region is active. Disabled regions are hidden from
filters and reporting but are not deleted.

Region ID
^^^^^^^^^

An optional short code for the region (for example, ``ON-01``). Use this
when you want a shorter label to appear in reports, or to match an
identifier your organization already uses elsewhere.

Region Type
^^^^^^^^^^^

Choose the kind of region:

* ``Generic`` --- any custom grouping.
* ``Continent`` --- a continental region.
* ``LHIN`` --- a Local Health Integration Network.

The type is used by reports and dashboards that group results by geography.

Color
^^^^^

The display color assigned to the region. This color is used on the dashboard
map and in any chart that colors results by region.

Corporation
^^^^^^^^^^^

Pick the corporation this region belongs to. Only facilities under the
chosen corporation can be added to the region.

Polygon Data (GeoJSON)
^^^^^^^^^^^^^^^^^^^^^^

Optional `GeoJSON <https://geojson.org/>`_ polygon coordinates that describe
the geographic boundary of the region. When provided, the polygon is drawn on
the dashboard map (:ref:`dashboard <dashboard>`) so the region is
visible as a shaded area rather than a single point.

Paste the GeoJSON coordinates directly into the field, or leave empty if the
region should be tracked without a visible boundary.