Skip to main content

Location Management

Locations are physical or virtual locations and spaces, ranging from the physical building, spaces such as rooms within or vehicles.

Location management also allows grouping of locations into regions, this only applies to some tenants.

Locations in Merlin?

Locations and Spaces exist today within Merlin as Sites (Locations) and Stock Centres (Spaces), however these have been renamed here for future development flexibility and expandability.

Location Child Data​

Within the Location Domain The following relationships exist in most circumstances:

erDiagram Location { uuid location-uuid } Location ||--|{ Space : Contains Space { uuid location-space-uuid }
  • A location will always contain at least 1 space.
  • A space is not shared across locations

Where a tenant uses Regions the following relationship exists in addition to above:

erDiagram Region { uuid region-uuid } Region |o--o{ Location : Contains Location { uuid location-uuid }
  • A Region may be empty and does not require any Locations. When empty they have no use.
  • A Location can only belong to 1 region.
  • A Region contains many Locations.

Relationships​

A Location and Space will be referenced across domains, such as clinical work locations, inventory movement and appointments.

The entities within the Location domain are used for grouping or organising data across other domains, e.g. all appointments for Site B.

  1. Creating a defining a Region for a location within the API will not affect the Merlin UI without additional configuration within Merlin.

Location Schema​

Please take note of the following points for this domain:

  1. Regions are only used by some tenants and should not be depended upon for all integrations. This is used to help identify individual operating groups within the same tenant.
  2. Spaces are currently limited to use as stock locations, but will expand in the future.
  3. Location data when changed or appended may impact tenants licensing requirements.

Scopes​

The following authorisation scopes are required to access different resources within this domain:

  • location:create
  • location:read
  • location:update
  • location:remove