cold_chain_equipment:configure

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
cold_chain_equipment:configure [2022/12/08 06:05] – [Set up vaccine vial monitor (VVM) statuses] Mark Glovercold_chain_equipment:configure [2023/08/08 23:21] (current) – [20.01. Vaccine Vial Monitoring (VVM)] Mark Glover
Line 1: Line 1:
-====== 20.01. Setting up to use Vaccine Module ====== +====== 20.01. Vaccine Vial Monitoring (VVM) ====== 
-There are a few configuration steps needed in mSupply desktop for setting up the Vaccine module to be used in mSupply mobile. This page is all about those steps.+  * There used to be a comprehensive description of VVM on the WHO website, but, alas, no longer :-(.  We can resort to the  [[https://en.wikipedia.org/wiki/Vaccine_vial_monitor|Wikipedia article on VVM]] 
 +  * As of August 2023, WHO has published a [[https://www.who.int/multi-media/details/vaccine-vial-monitor-(vvm)-infographic|VVM infographic]]. In case that is also removed from the WHO web site, we have stored it here:  {{ :cold_chain_equipment:vvm_graphic_final_color.pdf |VVM infographic}}
  
-To set up the vaccine module correctly, you need to:  +===== Configuration ===== 
-  * Enable the vaccine module for the mobile store, +There are a few configuration steps needed to use VVM (Vaccine Vial Monitoring) in your mSupply system.
-  * Set up vaccine vial monitor (VVM) statuses, +
-  * Set up sensors, and +
-  * Set up temperature breach configurations+
  
-===== Enable the vaccine module for the mobile store ===== +==== Set up vaccine vial monitor (VVM) statuses ====
-First of all, in mSupply desktop login to the store you want to turn on the vaccine module for. Then, from the menus, choose //Special > Show Stores//, double-click on the store you are logged into and then click on the //Preferences// tab. This is the window you will see:  +
- +
-{{ :cold_chain_equipment:20200724-000337.png?600 |}} +
- +
-Check the **mobile: Uses Vaccine module** checkbox in the //Store preference// list and click on the **OK** button to save the new setting. +
- +
- +
-===== Set up vaccine vial monitor (VVM) statuses =====+
 To configure VVM status options, you need to have permission in the system to edit vaccine vial monitoring statuses.  See the [[admin:managing_users|23.15. Managing users]] page for details on how to set user permissions. You need to turn on the //View and edit vaccine vial monitor status// permission on the //Permissions (3)// tab. To configure VVM status options, you need to have permission in the system to edit vaccine vial monitoring statuses.  See the [[admin:managing_users|23.15. Managing users]] page for details on how to set user permissions. You need to turn on the //View and edit vaccine vial monitor status// permission on the //Permissions (3)// tab.
  
Line 25: Line 15:
 The window will show you a list of all the current vaccine vial monitor statuses that have been setup. To edit one, simply double-click on it in the list. This will open the same window as when adding a new status (see below) but populated with the status's current settings, ready for you to edit them. The window will show you a list of all the current vaccine vial monitor statuses that have been setup. To edit one, simply double-click on it in the list. This will open the same window as when adding a new status (see below) but populated with the status's current settings, ready for you to edit them.
  
-==== Adding a VVM status ====+=== Adding a VVM status ===
 Click the **New** button. This window opens: Click the **New** button. This window opens:
  
Line 37: Line 27:
 Click on the **OK** button to save your changes or the **Cancel** button to cancel them.  Click on the **OK** button to save your changes or the **Cancel** button to cancel them. 
  
-==== Deleting a VVM status ====+=== Deleting a VVM status ===
 You can only delete a status that you have just created. Once this list of VVM statuses has been closed, you cannot delete the status any more. If there is one that you wish to delete but can't then edit it and uncheck its **Is active** checkbox (as described above). That will effectively delete it because it will no longer be selectable in any mSupply mobile functionality (but it will mean the status is still available for historical records).  You can only delete a status that you have just created. Once this list of VVM statuses has been closed, you cannot delete the status any more. If there is one that you wish to delete but can't then edit it and uncheck its **Is active** checkbox (as described above). That will effectively delete it because it will no longer be selectable in any mSupply mobile functionality (but it will mean the status is still available for historical records). 
  
Line 47: Line 37:
 {{ :cold_chain_equipment:vvm_status_delete.png?350 |}} {{ :cold_chain_equipment:vvm_status_delete.png?350 |}}
  
-===== Viewing sensor details ===== +==== Tell mSupply which items are vaccines ==== 
-Temperature sensors are used by mSupply mobile to monitor the temperature over time at a given location. This section describes the options available within mSupply to view/interact with temperature sensors.+Tell mSupply which items are vaccines by checking the **Is a vaccine** checkbox and entering the number of doses per vial in the **Doses** field on the //General// tab of the item's details window. See the [[items:item_basics:tab_general#items_-_general_tab|4.01.01. Items - General tab]] page for details.
  
-First of all, you need to have permission in the system to view sensor details. +==== Turn on preferences ==== 
-See the [[admin:managing_users|23.15. Managing users]] page for details on how to set user permissions. You need to turn on the //View sensor details// permission on the //Permissions (3)// tab.+Finally, you need to turn on some preferences so that VVM status is exposed in the mSupply interface: 
 +  * The //Able to specify VVM status when receiving items// store preference to be able to enter the VVM status for a vaccine when it is received. See the [[other_stuff:virtual_stores#preferences_tab|26.07. Virtual stores]] page for details. 
 +  * The //Sort available batches by VVM status rather than Expiry// store preference if you want the VVM status of the stock to be included when deciding what order to offer stock for selection. See the [[other_stuff:virtual_stores#preferences_tab|26.07. Virtual stores]] page for details.
  
-To see the current sensors go to //Item > Vaccines > Sensors...// 
  
-This window will appear: +===== Using VVM status ===== 
-{{ :cold_chain_equipment:pasted:20210512-053306.png?350 | }}+==== Enter the VVM status of vaccines when they are received ==== 
 +When the //Able to specify VVM status when receiving items// store preference is turned on (see above) you can enter the VVM status of vaccines when they are received into a store on a supplier invoice. See the [[receiving_goods:supplier_invoices#vaccines|7.01. Supplier invoices]] page for details.
  
-The window will show you a list of all the current sensors that have been set up. If there are many in the list, you can type something in the search bar and only those containing what you types will show in the list. To view the details of one, simply double-click on it in the list. This will open a window populated with the sensor's current settings. 
  
-You cannot add a sensor or edit any of the sensor details. This can only be done in mSupply mobile (see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine|Cold Chain (for Vaccines and other Cold chain items) - mobile]] page for details).+==== Update the VVM status of vaccines when you check them ==== 
 +When you check the status of the VVM labels for a batch, you can enter the details of the current VVM status into the stock line details window.
  
-===== Viewing temperature breach configurations ===== +You can get to this window two ways: 
-Temperature breaches occur when the temperature detected by a temperature sensor exceeds a certain value for a certain amount of time. This section describes how temperature breaches are defined in mSupply.+  - On the //Item// tab of the Navigator, click on the //Stock// icon then double-click on the line of stock you are interested in. 
 +  - Search for items, double click on an item to open its details window, click on the //Stock// tab to show the item's current stock and then double-clikc on the stock line you are interested in.
  
-First of all, you need to have permission in the system to configure temperature breaches.+Whichever way you choose, this window will open:
  
-See the [[admin:managing_users|23.15. Managing users]] page for details on how to set user permissions. You need to turn on the //View temperature breach configuration// permission on the //Permissions (3)// tab.+{{ :cold_chain_equipment:pasted:20230512-102358.png?550 |}}
  
-To see the current temperature breaches go to //Item > Vaccines > Show temperature breach configuration...//+Click on the Status tab:
  
-This window will appear:+{{ :cold_chain_equipment:pasted:20230512-102604.png?550 |}}
  
-{{ :cold_chain_equipment:screenshot_2021-04-22_at_16.19.54.png?350 |}}+The table shows you the history of VVM status measurements for this stock line.
  
-The window will show you a list of all the current temperature breach configurations that have been set up. If there are many in the list, you can type something in the search bar and only those containing what you types will show in the list. To view the details of one, simply double-click on it in the list. This will open a window (see below) populated with the breach's current settings.+To add a new entry, click on the **New** button and this window will open:
  
-You cannot add, edit or delete a temperature breach configuration, this can only be done in mSupply mobile (see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine|Cold Chain (for Vaccines and other Cold chain items) - mobile]] page for details).+{{ :cold_chain_equipment:pasted:20230512-103003.png?400 |}}
  
-==== To view the details of a temperature breach configuration ==== +  * **Date:** The date of the entry. This is set to the current date and is read only - you can only enter logs on the current day. 
-When you double-click a temperature breach configuration, this window will open, pre-populated with the configuration's details:+  * **Time:** The time of the log entry. Edit as required in 24 hour format. 
 +  * **VVM status:** Select one of the active VVM statuses you have setup. 
 +  * **Entered by:** The name of the user making the entry. Read only, set to the currently logged in user. 
 +  * **Comment:** Enter anything that you want to remember about this reading (who took it, how it was done, anything unusual etc.).
  
-{{ :cold_chain_equipment:pasted:20210512-051120.png?400 |}}+Click on the **OK** button to save the entry and it will be displayed in the table. If the VVM status of the stock line has changed then its current VVM status will be automatically updated to match what has been entered.
  
-  * **Description:** The name given to the configuration. It will be referred to by this throughout mSupply. +If you enter a VVM status that means the stock is unusable, we recommend that you also check the **Hold** checkbox 
-  * **Minimum temperature:** If the temperature drops below this, it will contribute towards a breach +on the //General// tab (shown above) so that the stock is not issued.
-  * **Maximum temperature:** If the temperature rises above this, it will contribute towards a breach +
-  * **Duration hours and minutes:** The length of time the temperature must be below the minimum or above the maximum temperatures for a cumulative breach to occur. +
-  * **Type:** The breach configuration type, see [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine|Cold Chain (for Vaccines and other Cold chain items) - mobile]] for details on the breach types available. +
-  * **Location type:** The location type this breach belongs to. See the [[items:item_locations#location_types|4.06. Stock locations and location types]] page for details on location types. +
-  * **Is active?:** If checked then this breach configuration will be used in cold chain monitoring. If unchecked, it won't. +
  
-Click on the **OK** button to close the window. 
  
 +==== Check the VVM status of stock when issuing ====
 +When the //Able to specify VVM status when receiving items// store preference is turned on (see the [[https://docs.msupply.org.nz/cold_chain_equipment:configure#turn_on_preferences|Turn on preferences]] section above) you will be able to see the current VVM status of vaccine stock and issue in packs or doses when issuing a vaccine item. See the [[issuing_goods:issuing_goods_customer_invoice#vaccines|8.01. Issuing goods to a customer (customer invoices)]] page for details.
 \\ \\
 \\ \\
  • Last modified: 2023/08/08 23:21
  • by Mark Glover