Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:mobile:user_guide:vaccine [2021/12/24 04:42] – [Step 3: Sensor connection] Mark Gloveren:mobile:user_guide:vaccine [2024/02/19 23:47] (current) – [Temperature Breaches] Adam Dewey
Line 39: Line 39:
 Approved sensors can be purchased directly from the manufacturer or reseller online.  Please contact [[coldchain@msupply.foundation]] for further information.   Approved sensors can be purchased directly from the manufacturer or reseller online.  Please contact [[coldchain@msupply.foundation]] for further information.  
  
-===== Using the Vaccine module ===== +==== Adding Sensors ==== 
-Enabling the Vaccine module will change the look of your menu page, adding an extra Vaccines button.  +
-{{ :en:mobile:user_guide:pasted:20210316-044639.png?600 |}} +
- +
-=== Supplier Invoices === +
- +
-With vaccine module enabled you automatically get a few extra columns on a supplier invoice for vaccines - the Location and Vaccine Vial Monitor (VVM) status columns. +
-{{ :user_guide:pasted:20200724-022032.png |}} +
-You can select a location by tapping on the arrow icon in the Location cell. This will allow you to choose a location from a list.  +
-{{ :user_guide:pasted:20200724-022052.png?600 |}} +
- +
-You can also change the Vaccine vial monitor status for items that have been defined as vaccines on the cloud server - this defaults to the lowest level, but can be edited by clicking on the arrow icon in the VVM Status column. +
-{{ :user_guide:pasted:20200724-022349.png |}} +
- +
-=== Customer Invoices === +
-Vaccine module automatically adds two extra columns on a customer invoice - the Doses and Breach columns.  +
-{{ :en:mobile:user_guide:pasted:20200724-024539.png?600 |}} +
- +
-  * The **Doses** column is for the number of doses actually used (so we can account for open-vial wastage). It will automatically get populated by the //item quantity * number of doses in a vial//, for convenience, but you can also edit it! There is a maximum limit of //the number of doses in a vial for that vaccine * the quantity//, though. +
-  * The **Breach** column shows when a vaccine item has been in a temperature breach. Note that without entering a quantity into the customer invoice for the item, we don’t know exactly what batches are being issued, so the breach icon may not show up yet. +
-  * If the breach icon (an orange triangle with an exclamation) does show for a row, this signals that the stock line has had a temperature breach. Tapping the icon will bring up a graph of the temperature breach. In the example below, the fridge seems to be broken, probably not a good idea to use this batch! +
-{{ :en:mobile:user_guide:pasted:20200724-053530.png?600 |}} +
- +
- +
-=== Supplier Requisitions === +
- +
-Tapping on a row in your supplier requisition will show you the date of the last requisition for your vaccine, as well as other details such as the open and closed vial wastage since the last requisition.  +
-{{ :en:mobile:user_guide:pasted:20200724-053656.png?600 |}} +
- +
-=== Stocktakes === +
- +
-Tapping on a stocktake row for a vaccine item will also show the additional columns for **Doses** and **Breach**.  +
-{{ :en:mobile:user_guide:pasted:20200724-053925.png?600 |}} +
- +
-Here, you can adjust the quantities of your vaccine if needed, change the location, or if the vaccine vial monitor status has changed, you can update that here. You can also view the breaches the batch has been in to help you make decisions! +
- +
-=== Vaccine home page ===  +
-Tapping on the Vaccines button in the menu page will bring you to a list of all the temperature sensors connected to your device and an overview of current status and actions for each sensor. +
-{{ :en:mobile:user_guide:pasted:20210316-032749.png?600 |}} +
- +
-The sensor header displays the following information: +
-  ***Circle**: a green circle indicates that the sensor is currently within the specified temperature range and the sensor battery is equal or above 25%. A red circle indicates that the sensor is currently outsides the specified temperature range or the sensor battery is below 25%. +
-  ***Sensor Name**:  as configured during sensor connection. +
-  ***WiFi Icon and last log time**: the time of the last temperature download occurred.  The time will flash when download is currently in process. +
-  ***Battery Icon**: a percentage figure and icon showing remaining battery charge for the sensor. +
-  ***Down Arrow Icon**: Tap to export sensor data (temperature logs and breaches) to csv format and send via email data. +
-  ***Light Bulb Icon**: Tap to make the sensor LED light flash/blink. +
-  ***Cog Button**: Tap if you wish to edit the sensor configuration. +
- +
-The row under the sensor header displays the following information: +
-  ***Sensor’s MAC address** +
-  ***Thermometer icon and last recorded temperature** +
-  ***Clock Icon and the time of the last temperature breach** (if applicable) +
- +
-Tap anywhere on a sensor box to view further details. +
- +
-=== Sensor Detail === +
-{{ :en:mobile:user_guide:pasted:20210316-032951.png?600 |}} +
- +
-Tap on the date range on the top left of the screen to change the time (and data) displayed. +
- +
-The header information is as above.   +
- +
-== Temperature Graph == +
-The red line represents the hot consecutive threshold.  The blue line represents the cold consecutive threshold. (You can set these here).  Any temperature logs outside of the lines (breaches) will be indicated with the exclamation icon.   +
-The last temperature logged will display to the right of the graph.  The **sensor status rectangle** (surrounding the last temperature log) will be: +
-  *red for a hot breach. +
-  *blue for a cold breach. +
- +
-== Temperature Cards == +
-Underneath the graph are five temperature cards: +
-  - **Cold Cumulative Breach**: the length of the breach  +
-  - **Cold Consecutive Breach**: the number of breaches +
-  - **Average temperature**: calculated over the date range selected in degrees Centigrade +
-  - **Hot Cumulative Breach**: the length of the breach +
-  - **Hot Consecutive Breach**: the number of breaches +
- +
-=== Exporting Sensor Data === +
-It is possible to download the temperature (breach) logs and sensor settings by clicking the ‘Download’ button in the header (on either the Vaccine home page or the Sensor Details page). +
-{{:en:mobile:user_guide:pasted:20210316-033612.png}} +
- +
-The **Download** screen requires: +
-  *Email address +
-  *Comment +
-Tapping ''Download'' will open a new email in your device’s email application.  The receiver address and comment will be prepopulated, and the sensor data (in CSV format) attached, ready to send. +
- +
-{{ :en:mobile:user_guide:pasted:20210316-033915.png?600 |}} +
- +
-<WRAP center round tip 60%> +
-TIP: If you change your mind about emailing the data, tap anywhere in the grayed-out area. +
-</WRAP> +
- +
-=== Adding Sensors === +
 The first time you use the Vaccine module, there will be no sensors connected to your device. The first time you use the Vaccine module, there will be no sensors connected to your device.
 {{ :en:mobile:user_guide:pasted:20210316-035326.png?600 |}} {{ :en:mobile:user_guide:pasted:20210316-035326.png?600 |}}
Line 143: Line 51:
 We recommend you keep the sensor close when you are adding or editing it within mSupply Mobile.  Also, allow for up to a minute for any changes to be communicated via Bluetooth.  We recommend you keep the sensor close when you are adding or editing it within mSupply Mobile.  Also, allow for up to a minute for any changes to be communicated via Bluetooth. 
 If you are using a brand new sensor, press the top of the sensor until it flashes to turn it on. If you are using a brand new sensor, press the top of the sensor until it flashes to turn it on.
 +
 == Step 1: Select the correct sensor == == Step 1: Select the correct sensor ==
 When you tap **Add Sensor**, your device will scan and list any sensors that can be connected by Bluetooth. When you tap **Add Sensor**, your device will scan and list any sensors that can be connected by Bluetooth.
Line 155: Line 64:
   * __Consecutive__ means a single event where the temperature stays over (or under) the threshold for the whole time. So if you have a threshold of 8 degrees, and a consecutive breach time of 10 minutes, then a breach that lasts for 6 minutes, then drops under the threshold for 2 minutes, then breaches again for 6 minutes is __not__ a consecutive breach, but the 2 x 6 minute breaches are added to the cumulative breach records.   * __Consecutive__ means a single event where the temperature stays over (or under) the threshold for the whole time. So if you have a threshold of 8 degrees, and a consecutive breach time of 10 minutes, then a breach that lasts for 6 minutes, then drops under the threshold for 2 minutes, then breaches again for 6 minutes is __not__ a consecutive breach, but the 2 x 6 minute breaches are added to the cumulative breach records.
   * __Cumulative__ means adding together the total time over a certain temperature for a series of breaches.   * __Cumulative__ means adding together the total time over a certain temperature for a series of breaches.
- 
  
 Now we can set the temperature breach conditions for the sensor.  There are four thresholds that you can define: Now we can set the temperature breach conditions for the sensor.  There are four thresholds that you can define:
Line 210: Line 118:
 </WRAP> </WRAP>
    
- +==== Edit Sensor ====
- +
-=== Edit Sensor ===+
 To edit sensor details, you can tap on the ‘’cog’’ icon on the mSupply Vaccine home page (above screenshot) or on the Sensor Detail screen. To edit sensor details, you can tap on the ‘’cog’’ icon on the mSupply Vaccine home page (above screenshot) or on the Sensor Detail screen.
 Screenshot Screenshot
Line 225: Line 131:
 </WRAP> </WRAP>
  
-== Pausing Sensor Downloads ==+=== Pausing Sensor Downloads ===
 The edit screen also allows you to ''Pause'' temperature logging by the sensor.  When a sensor has been paused, it will appear in the title line both on the mSupply mobile vaccine home screen as well as the Sensor Detail screen. The edit screen also allows you to ''Pause'' temperature logging by the sensor.  When a sensor has been paused, it will appear in the title line both on the mSupply mobile vaccine home screen as well as the Sensor Detail screen.
  
 {{ :en:mobile:user_guide:pasted:20210316-041408.png?600 |}} {{ :en:mobile:user_guide:pasted:20210316-041408.png?600 |}}
  
-== Replacing a Sensor ==+=== Replacing a Sensor ===
 Tapping ''Replace'' will open up the scanner and allow you to choose from list of alternative sensors.  The list will only show sensors that are not currently connected to your device. Tapping ''Replace'' will open up the scanner and allow you to choose from list of alternative sensors.  The list will only show sensors that are not currently connected to your device.
 {{ :en:mobile:user_guide:pasted:20210316-041444.png?600 |}} {{ :en:mobile:user_guide:pasted:20210316-041444.png?600 |}}
 From the list, select the replacement sensor.  You can press ''Blink'' to check that you have the correct sensor (the LED light will flash for this sensor).   From the list, select the replacement sensor.  You can press ''Blink'' to check that you have the correct sensor (the LED light will flash for this sensor).  
  
-== Deleting a Sensor ==+=== Deleting a Sensor ===
 Tap ''Remove'' to remove any sensor no longer being used. You will receive a prompt to confirm the deletion.   Tap ''Remove'' to remove any sensor no longer being used. You will receive a prompt to confirm the deletion.  
 {{ :en:mobile:user_guide:pasted:20210316-041622.png?600 |}} {{ :en:mobile:user_guide:pasted:20210316-041622.png?600 |}}
 +
 +===== Using the Vaccine module =====
 +Enabling the Vaccine module will change the look of your menu page, adding an extra Vaccines button. 
 +{{ :en:mobile:user_guide:pasted:20210316-044639.png?600 |}}
 +
 +=== Supplier Invoices ===
 +
 +With vaccine module enabled you automatically get a few extra columns on a supplier invoice for vaccines - the Location and Vaccine Vial Monitor (VVM) status columns.
 +{{ :user_guide:pasted:20200724-022032.png |}}
 +You can select a location by tapping on the arrow icon in the Location cell. This will allow you to choose a location from a list. 
 +{{ :user_guide:pasted:20200724-022052.png?600 |}}
 +
 +You can also change the Vaccine vial monitor status for items that have been defined as vaccines on the cloud server - this defaults to the lowest level, but can be edited by clicking on the arrow icon in the VVM Status column.
 +{{ :user_guide:pasted:20200724-022349.png |}}
 +
 +=== Customer Invoices ===
 +Vaccine module automatically adds two extra columns on a customer invoice - the Doses and Breach columns. 
 +{{ :en:mobile:user_guide:pasted:20200724-024539.png?600 |}}
 +
 +  * The **Doses** column is for the number of doses actually used (so we can account for open-vial wastage). It will automatically get populated by the //item quantity * number of doses in a vial//, for convenience, but you can also edit it! There is a maximum limit of //the number of doses in a vial for that vaccine * the quantity//, though.
 +  * The **Breach** column shows when a vaccine item has been in a temperature breach. Note that without entering a quantity into the customer invoice for the item, we don’t know exactly what batches are being issued, so the breach icon may not show up yet.
 +  * If the breach icon (an orange triangle with an exclamation) does show for a row, this signals that the stock line has had a temperature breach. Tapping the icon will bring up a graph of the temperature breach. In the example below, the fridge seems to be broken, probably not a good idea to use this batch!
 +{{ :en:mobile:user_guide:pasted:20200724-053530.png?600 |}}
 +
 +=== Supplier Requisitions ===
 +
 +Tapping on a row in your supplier requisition will show you the date of the last requisition for your vaccine, as well as other details such as the open and closed vial wastage since the last requisition. 
 +{{ :en:mobile:user_guide:pasted:20200724-053656.png?600 |}}
 +
 +=== Stocktakes ===
 +
 +Tapping on a stocktake row for a vaccine item will also show the additional columns for **Doses** and **Breach**. 
 +{{ :en:mobile:user_guide:pasted:20200724-053925.png?600 |}}
 +
 +Here, you can adjust the quantities of your vaccine if needed, change the location, or if the vaccine vial monitor status has changed, you can update that here. You can also view the breaches the batch has been in to help you make decisions!
 +
 +=== Vaccine home page === 
 +Tapping on the Vaccines button in the menu page will bring you to a list of all the temperature sensors connected to your device and an overview of current status and actions for each sensor.
 +{{ :en:mobile:user_guide:pasted:20210316-032749.png?600 |}}
 +
 +The sensor header displays the following information:
 +  ***Circle**: a green circle indicates that the sensor is currently within the specified temperature range and the sensor battery is equal or above 25%. A red circle indicates that the sensor is currently outsides the specified temperature range or the sensor battery is below 25%.
 +  ***Sensor Name**:  as configured during sensor connection.
 +  ***WiFi Icon and last log time**: the time of the last temperature download occurred.  The time will flash when download is currently in process.
 +  ***Battery Icon**: a percentage figure and icon showing remaining battery charge for the sensor.
 +  ***Down Arrow Icon**: Tap to export sensor data (temperature logs and breaches) to csv format and send via email data.
 +  ***Light Bulb Icon**: Tap to make the sensor LED light flash/blink.
 +  ***Cog Button**: Tap if you wish to edit the sensor configuration.
 +
 +The row under the sensor header displays the following information:
 +  ***Sensor’s MAC address**
 +  ***Thermometer icon and last recorded temperature**
 +  ***Clock Icon and the time of the last temperature breach** (if applicable)
 +
 +Tap anywhere on a sensor box to view further details.
 +
 +=== Sensor Detail ===
 +{{ :en:mobile:user_guide:pasted:20210316-032951.png?600 |}}
 +
 +Tap on the date range on the top left of the screen to change the time (and data) displayed.
 +
 +The header information is as above.  
 +
 +== Temperature Graph ==
 +The red line represents the hot consecutive threshold.  The blue line represents the cold consecutive threshold. (You can set these here).  Any temperature logs outside of the lines (breaches) will be indicated with the exclamation icon.  
 +The last temperature logged will display to the right of the graph.  The **sensor status rectangle** (surrounding the last temperature log) will be:
 +  *red for a hot breach.
 +  *blue for a cold breach.
 +
 +== Temperature Cards ==
 +Underneath the graph are five temperature cards:
 +  - **Cold Cumulative Breach**: the length of the breach 
 +  - **Cold Consecutive Breach**: the number of breaches
 +  - **Average temperature**: calculated over the date range selected in degrees Centigrade
 +  - **Hot Cumulative Breach**: the length of the breach
 +  - **Hot Consecutive Breach**: the number of breaches
 +
 +=== Exporting Sensor Data ===
 +It is possible to download the temperature (breach) logs and sensor settings by clicking the ‘Download’ button in the header (on either the Vaccine home page or the Sensor Details page).
 +{{:en:mobile:user_guide:pasted:20210316-033612.png}}
 +
 +The **Download** screen requires:
 +  *Email address
 +  *Comment
 +Tapping ''Download'' will open a new email in your device’s email application.  The receiver address and comment will be prepopulated, and the sensor data (in CSV format) attached, ready to send.
 +
 +{{ :en:mobile:user_guide:pasted:20210316-033915.png?600 |}}
 +
 +<WRAP center round tip 60%>
 +TIP: If you change your mind about emailing the data, tap anywhere in the grayed-out area.
 +</WRAP>
 +
 +=== Temperature Breaches ===
 +
 +Temperature breaches are displayed on the graph as warning icons. 
 +
 +As of February 2024 it is not possible to acknowledge the breaches in mSupply Mobile. 
 +
 +However, note that this functionality is now available in Open mSupply: See https://docs.msupply.foundation/docs/coldchain/monitoring/#acknowledging-breaches
 +
  
 |  //Previous:  **[[en:mobile:user_guide:cash_register|]]** | | Next:  **[[en:mobile:user_guide:mobile_settings|]]**//  | |  //Previous:  **[[en:mobile:user_guide:cash_register|]]** | | Next:  **[[en:mobile:user_guide:mobile_settings|]]**//  |
  
  
  • en/mobile/user_guide/vaccine.1640320973.txt.gz
  • Last modified: 2021/12/24 04:42
  • by Mark Glover