Skip to content

Commit

Permalink
from be468830e6dc5624817f478200227d63988b0c64
Browse files Browse the repository at this point in the history
  • Loading branch information
roxy-dao committed Aug 22, 2024
1 parent 7cc8002 commit 0b3c906
Show file tree
Hide file tree
Showing 21 changed files with 489 additions and 503 deletions.
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ build_search_index = true
theme = "adidoks"

[languages.en]
title = "mSupply documentation"
title = "mSupply documentation + user guides"
build_search_index = true
description = "Documentation and user guides for the mSupply foundation suite of software products. Here you'll find the user guide for notify, mSupply dashboard, health supply hub and mSupply mobile. There is also the user documentation for Open mSupply, Conforma, mSupply and mSupply cold chain."

Expand Down
4 changes: 2 additions & 2 deletions content/coldchain/desktop_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ top = false

Minimum version requirements

#### BlueMaestro sensors
#### mSupply Foundation temperature sensors

* mSupply Cold Chain app version: 0.5.4 recommended
* mSupply Cold Chain app version: 0.5.6 recommended
* mSupply Desktop version: V5-04-00 or higher recommended

### mSupply Desktop Setup Steps
Expand Down
6 changes: 1 addition & 5 deletions content/coldchain/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,7 @@ Once mSupply Cold Chain is open on the device, it will prevent the device from g

### Sensors

Manufacturer: Blue Maestro Model: DSCTHD001

(There is a bug in the firmware of model DSCTEMP001 - The above model is the same electronics, but without the firmware bug)

Alternative sensor: Laird BT510
Manufacturer: mSupply Foundation

### Permissions and peripherals

Expand Down
2 changes: 1 addition & 1 deletion content/docs/TSS/target_software_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The mSupply Foundation's goal is 100% compliance with the <a href="https://isghe
These charts indicate Open mSupply's current progress towards that goal. (Purple indicates compliance when used in a hybrid open/closed source system in conjunction with the mSupply application)

<div {% if class %}class="{{class}}"{% endif %}>
<iframe width="819" height="802" frameborder="0" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRmM6xnuRn6DlZLmaYoZj0RnMFRu2lx5qUM-qN2u_5S6tL7BQfC2zh6PDL43t1fU6ZLwWh3Hwi9AjLj/pubhtml?gid=1488682632&amp;single=true&amp;widget=false&chrome=false&amp;headers=false"></iframe>
<iframe width="821" height="805" frameborder="0" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRmM6xnuRn6DlZLmaYoZj0RnMFRu2lx5qUM-qN2u_5S6tL7BQfC2zh6PDL43t1fU6ZLwWh3Hwi9AjLj/pubhtml?gid=1488682632&amp;single=true&amp;widget=false&chrome=false&amp;headers=false"></iframe>
</div>

The breakdown of Open mSupply's compliance with TSS version 2.0 can be seen in the following table:
Expand Down
24 changes: 12 additions & 12 deletions content/docs/coldchain/equipment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ toc = true
top = false
+++

Cold Chain Equipment is a digital register for the creation and management of cold chain assets. It allows health departments to manage, record functional status logs, and update locations of cold chain assets.
Cold Chain Equipment is a digital registry and inventory for the management of cold chain assets such as fridges, freezers and remote temperature monitoring devices. It allows health departments to track their cold chain assets including their location and functional status.

From the **Equipment** menu, all assets available in a store can be viewed.
From the `Equipment` menu, all assets available in the current store can be viewed.

<!--
TODO: Add link to central server docs when they are created
-->

Cold chain assets from all stores are visible when accessing the **Equipment** menu via Open mSupply central server.
Cold chain assets from **all** stores are visible when accessing the `Equipment` menu via Open mSupply central server.

![goto equipment](/docs/coldchain/images/equipment.png)

Expand Down Expand Up @@ -171,9 +171,9 @@ From the `Summary` tab, you can:
- edit the serial number
- assign an installation date
- assign a replacement date
- assign locations to the the asset
- Link stock storage `Locations` to the the asset

<div class="tip">Multiple locations can be assigned to one asset</div>
<div class="tip">Multiple stock storage Locations can be assigned to one asset</div>

You can also view the functional status and edit notes on the status.

Expand All @@ -183,9 +183,9 @@ The `Details` tab shows the asset properties.

![](/docs/coldchain/images/equipment_detail.png)

#### Status Logs
#### Status History

The `Status Logs` tab shows all of the status logs of the asset.
The `Status History` tab shows the history of the functional status of the asset.

![Asset logs tab](/docs/coldchain/images/status_logs_tab.png)

Expand Down Expand Up @@ -213,11 +213,11 @@ This records all user actions which have been taken for this asset using the Ope

#### Update Status

Clicking on the `Update Status` button allows the creation of a new status log.
Clicking on the `Update Status` button allows the creation of a new functional status entry.

![](/docs/coldchain/images/update_status_button.png)

This will open a new status log modal.
This will open the functional status modal.

![](/docs/coldchain/images/status_log_modal.png)

Expand All @@ -227,13 +227,13 @@ Here you can enter:
- A reason for the new functional status
- Any observations or notes

Additional documents including photos can also be uploaded for this status log
Additional documents including photos can also be uploaded for this functional status entry

![](/docs/coldchain/images/status_log_document_upload.png)

These documents can be viewed in the `Status Logs` tab
These documents can be viewed in the `Status History` tab

![Status log document](/docs/coldchain/images/status_log_document.png)
![Status History document](/docs/coldchain/images/status_log_document.png)

#### Printing a QR code

Expand Down
65 changes: 40 additions & 25 deletions content/docs/coldchain/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,45 +13,60 @@ toc = true
top = false
+++

The cold chain features within Open mSupply allow you to:
## Overview

- View and manage temperature sensors
- Import data from Berlinger [Fridge-tag](https://www.berlinger.com/cold-chain-management/refrigerator-temperature-logger-solution-1) and [Q-tag](https://www.berlinger.com/shipment-monitoring-solutions) temperature loggers (Berlinger and the mSupply Foundation have been working together to make sure Berlinger temperature monitors are well supported in Open mSupply; you can read more [here](https://www.berlinger.com/partnership-msupply)).
- View logs and breach data from sensors
- Receive notifications of temperature breach and temperature excursion events
Open mSupply offers the following cold chain functionality:

Sensors can be assigned to a storage location, which then allows you to associate temperature logs and breaches with specific stock lines. You can also view historical data to check if your cold chain equipment is operating correctly and to check if your stock might have been affected by temperature variations.
- **Remote temperature monitoring**
- **Cold Chain Equipment (CCE) inventory management**
- **Compromised stock identification**

If a temperature breach happens, then a notification is displayed on every page of Open mSupply as a warning to check potentially affected stock. Once the breach is acknowledged then the notification is no longer shown.
#### Remote temperature monitoring

Open mSupply integrates with the android based Cold Chain application; simply configure your Cold Chain application to sync with the Open mSupply server address and configure a username and password. Temperature sensors, breaches and logs will then appear within Open mSupply.
Open mSupply allows health facilities to:
- View temperature logs from fridges and freezers
- View and respond to temperature breach events
- Manage temperature sensors
- Receive real-time notifications of temperature breach and temperature excursion events

<div class="note">The Cold Chain referred to here is the integration of the Cold Chain features within Open mSupply. There is separate documentation for the <a href="/coldchain/introduction/">Android Cold Chain application</a>.</div>
Central health authorities can:
- View temperature data from all health facilities in centralised web portal

## Configuration
Temperature data can be imported into Open mSupply from multiple sources.
The methods currently supported are:
- Connect [mSupply temperature sensors](https://msupply.foundation/open-msupply/cold-chain/#mSupplySensor) to Open mSupply via Bluetooth
- Import data from Berlinger [Fridge-tags](https://www.berlinger.com/cold-chain-management/refrigerator-temperature-logger-solution-1) and [Q-tags](https://www.berlinger.com/shipment-monitoring-solutions) via USB (you can read more [here](https://www.berlinger.com/partnership-msupply)).

To begin, enable the store preference for `mobile: Uses Vaccine Module` (see the [store preferences](https://docs.msupply.org.nz/other_stuff:virtual_stores#preferences_tab) documentation for how to do this).
#### Cold Chain Equipment inventory management

Any users who are to view and manage the Cold Chain features should have the following permissions enabled:
Open mSupply allows health facilities to:
- Capture details of CCE assets such as fridges, freezers and remote temperature monitoring devices
- View operation and maintenance manuals for CCE
- Update CCE functional status
- Record CCE maintenance logs

- Vaccines
- View sensor details
- Edit sensor location
Central health authorities can:
- View the location of CCE assets for all health facilities
- Distribute CCE between health facilities
- View aggregated CCE data, such as functional status, in a centralised web portal

See the [user permissions](https://docs.msupply.org.nz/admin:managing_users#permissions_tabs) documentation for more details.
#### Compromised stock identification

## Cold chain app integration
Open mSupply allows health facilities to:
- Link temperature data to stock data
- View stock lines that have been potentially compromised in a centralised web portal

The [Cold Chain](/coldchain/introduction/) application is able to sync data to a server. The server can be an instance of Open mSupply or mSupply.
Sensors can be linked to a stock storage [Location](/docs/inventory/locations/).
This link allows Open mSupply to associate temperature logs and breach events with specific stock lines.
Historical data is available to check that cold chain equipment is operating correctly and to see whether stock might have been affected by any temperature variations.

To configure the integration, you will only need to configure a user and then you can update the Cold Chain application.
## Getting started

The user is a standard mSupply user, with the following configuration:
To begin using cold chain features enable the [store preference](https://docs.msupply.org.nz/other_stuff:virtual_stores#preferences_tab) called `mobile: Uses Vaccine Module`.

- The default store assigned to the user is the store which the temperature data will be associated with
- The store will need to be part of the site that Open mSupply is synchronising with. Have a look at the [Settings](/docs/settings/synchronisation/#viewing-the-synchronisation-settings) section to see which site omSupply is syncing with, and then the [Synchronisation](https://docs.msupply.org.nz/synchronisation:sync_sites#viewing_sync_sites) screen to check that your site includes the correct store.
- The user must have the omSupply permission of `Cold chain API access` (see below)
Any users that require access to cold chain features should have the following [user permissions](https://docs.msupply.org.nz/admin:managing_users#permissions_tabs) enabled:

![Cold chain API permission](/docs/coldchain/images/coldchain_permission.png)
- Vaccines
- `View sensor details`
- `Edit sensor location`

From here, simply follow the steps in the Cold Chain application documentation for [Integrating with mSupply Desktop](/coldchain/desktop-integration/#msupply-desktop-setup-steps)
Loading

0 comments on commit 0b3c906

Please sign in to comment.