items:item_basics:tab_general

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
items:item_basics:tab_general [2021/05/04 11:47] – [General] Gary Willettsitems:item_basics:tab_general [2023/04/05 14:25] (current) – Gary Willetts
Line 3: Line 3:
  
 <WRAP center round tip 60%> <WRAP center round tip 60%>
-**What are those lock icons?**  To minimise the chance of accidental amendment, some critical fields have a lock icon to the left of it.  To change any of these fields, you must click on the lock icon first, and then enter the new value in the field.  </WRAP>+**What are those lock icons?**  To minimise the chance of accidental amendment, some critical fields have a lock icon to the left of it.  To change any of these fields, you must click on the lock icon first, and then enter the new value in the field.</WRAP>
  
 {{ :items:itemdetailswindow.png?750 |}} {{ :items:itemdetailswindow.png?750 |}}
  
-**Item name: ** This is the name by which mSupply will refer to the item.+== Item name == 
 + 
 +This is the name by which mSupply will refer to the item.
  
 <WRAP center round important 60%> <WRAP center round important 60%>
   * You should avoid changing the name of an item to that of another item.  If you have accidentally created two copies of the same item, these should be merged - refer [[items:merge_items|Merging two items]].   * You should avoid changing the name of an item to that of another item.  If you have accidentally created two copies of the same item, these should be merged - refer [[items:merge_items|Merging two items]].
   * Historical records will still record the original name, but future invoices and invoices in process will pick up the new name when you add or edit an invoice line.   * Historical records will still record the original name, but future invoices and invoices in process will pick up the new name when you add or edit an invoice line.
 +  * Any non-printable characters entered before or after the name will be removed. Any entered in the name will be replaced with an underscore (''_'').
 </WRAP> </WRAP>
  
-**Item code:** This is the code assigned to the item.  This should be a unique code, and ideally, should not be a part of another code.  For example, ''1034'' is unique, but is a part of ''1034a'', and so these two codes should ideally not coexist in an mSupply system.+== Item code == 
 + 
 +This is the code assigned to the item.  This should be a unique code, and ideally, should not be a part of another code.  For example, ''1034'' is unique, but is a part of ''1034a'', and so these two codes should ideally not coexist in an mSupply system. Any non-printable characters entered before or after the code will be removed. Any entered in the code (including spaces) will be replaced with an underscore (''_''). 
 + 
 +== Store ==
  
-**Store: **The store which you are using is displayed here.  For mSupply systems that are only using a single store, this field is not relevant. For users managing more than one store, the desired store may be selected from the drop down menu. For users having access to all stores, and wishing to work with the cumulative data from them all, one of the options displayed will be "''Supervisor - All stores''" - refer [[other_stuff:misc_topics#supervisor_-_all_stores|Miscellaneous topics, Supervisor Mode]].+The store which you are using is displayed here.  For mSupply systems that are only using a single store, this field is not relevant. For users managing more than one store, the desired store may be selected from the drop down menu. For users having access to all stores, and wishing to work with the cumulative data from them all, one of the options displayed will be "''Supervisor - All stores''" - refer [[other_stuff:misc_topics#supervisor_-_all_stores|Miscellaneous topics, Supervisor Mode]].
 ---- ----
 === General === === General ===
  
-{{:items:item_basics:screenshot_2021-04-28_at_12.34.52.png?250|}}+{{ :items:item_basics:screenshot_2021-04-28_at_12.34.52.png?250 |}}
  
-**Units:** Choose the unit you use for this item. It is useful to distinguish items you issue by pack (eg eye drops) from items you issue by volume (eg oral liquids)+== Units ==
  
-**Department:** You can assign each item to a department by choosing from the list of departments here. To set up departments, refer [[items:department_management|Managing Item Access...]].+Choose the unit you use for this item. It is useful to distinguish items you issue by pack (eg eye drops) from items you issue by volume (eg oral liquids)
  
-**Category: **Provided that you have defined item categories, the appropriate category should be selected using the drop down list which displays your defined categories - refer [[items:item_categories|Item categories]].+== Department ==
  
-**Interaction group: **Here you can choose the interaction group for the item - refer [[items:drug_interaction_groups|Manage drug interaction groups]].+You can assign each item to a department by choosing from the list of departments here. To set up departments, refer [[items:department_management|Managing Item Access...]].
  
-**Item Flag: **The item flag field is designed for bulk editing, where you use the list view to update many items at once. You can enter or edit an individual item's flag(s) here, though it can be easier to do so using [[items:item_basics#the_items_list_view|The list view]].+== Category ==
  
-**Universal Code: **mSupply has the ability to look up and store a Universal Code for each item.  Click on the select button  to look up a universal code. This window will open:+Provided that you have defined item categories, the appropriate category should be selected using the drop down list which displays your defined categories - refer [[items:item_categories|Item categories]].
  
-{{ :items:item_basics:screenshot_2021-05-04_at_12.38.47.png?400 |}}+== Interaction group ==
  
-The search is automatically made on the first 3 characters of the item's name and the results shown in the list. If you see the matching item, double-click on it to select that universal code. If you don't see the correct item in the list, change the search term in the //Quick search// field and click on the {{:items:selectucbutton.jpg?20}} button to search again. +Here you can choose the interaction group for the item - refer [[items:drug_interaction_groups|Manage drug interaction groups]].
  
-When you select a universal code the ATC category, item strength, DDD value and other item properties will also be populated from the universal code server. You can see them on the Reporting tab - see the [[items:item_basics:tab_reporting|]] page for details.+== Item Flag ==
  
-Make sure you carefully select the correct item from the list when using this feature.+The item flag field is designed for bulk editing, where you use the list view to update many items at once. You can enter or edit an individual item's flag(s) here, though it can be easier to do so using [[items:item_basics#the_items_list_view|The list view]].
  
-If you want new universal codes added to the system send an email to support@msupply.org.nz+== Universal Code ==
  
-You can also search for universal codes manually from a web browser at https://universalcodes.msupply.org.nz/ (old version) or https://codes.msupply.foundation (new version)+mSupply has the ability to look up and store a Universal Code for each item.  Click on the select button {{:items:selectucbutton.jpg?20}} to look up a universal code. This window will open:
  
-**Doses:** Enter the number of doses a single unit of this item provides. Used for vaccines and is only enterable if the **Is a vaccine** checkbox is checked.+{{ :items:item_basics:screenshot_2021-05-04_at_12.38.47.png?300 |}}
  
-**Is a vaccine:** Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine_dispensing|mobile vaccine dispensing]] page for details). When checked, a default value of 1 is entered in the **Doses** field.+The search is automatically made on the first 3 characters of the item's name and the results shown in the list. If you see the matching item, double-click on it to select that universal code. If you don't see the correct item in the list, change the search term in the //Quick search// field and click on the {{:items:selectucbutton.jpg?20}} button to search again. 
  
-**Hold: do not issue: ** If this box is checked, the item will not be available to be issued on invoices. It will still appear in lists, but you will get a warning if you choose it when issuing stock, and will be required to choose a different item.+When you select a universal code the ATC category, item strength, DDD value, interactions with other medicines and other item properties will also be populated from the universal code server. You can see them on the //Reporting// tab - see the [[items:item_basics:tab_reporting|]] page for details. The interactions can be seen on the //Interactions// tab - see the [[items:item_basics:tab_interactions|]] page for details.
  
-<WRAP center round important 60%> +Make sure you carefully select the correct item from the list when using this feature.
-Putting the Item on hold applies to //all// stock lines of the item in the **store you are currently logged into**.  If you wish to hold selected stock lines only, you should do that by editing the individual stock lines using [[items:showing_batches|Show items with stock]] or by using the stock tab of the item's details window (see the [[items:item_basics:tab_stock]] page for details). +
-</WRAP>+
  
-**Issue in builds only: ** Checking this box will mean that the item cannot be issued on customer invoices.  This is useful in situations like where an item which by law can not be sold in an unprocessed state, but is used to 'build' (refer [[items:manufactured_items|Building (Manufacturing) Items]]) another item which is legal for distribution. +If you want new universal codes added to the system send an email to support@msupply.org.nz
  
-**Allow pack to one conversion:**  Checking this box allows stock of the item to be repacked to "''1''".+You can also search for universal codes manually from a web browser at https://universalcodes.msupply.org.nz/ (old version) or https://codes.msupply.foundation (new version)
  
-**Convert pack to one when receiving:** If this box is checked, when you receive items the pack size will automatically be converted to "''1''".  This is primarily for use in dispensary mode, but may be useful in other +== Doses ==
-situations too.+
  
-<WRAP center round box 60%> +Enter the number of doses a single unit of this item provides. Used for vaccines and is only enterable if the **Is a vaccine** checkbox is checked.
-For example: say you receive 50 x 100 boxes of paracetamol tablets, but you issue variable amounts of paracetmol tablets on invoices. If this option is checked, as you receive the stock on a supplier invoice, it will be converted to 5000 (quantity) x 1 (pack size). You will now be able to issue any quantity you like. The cost and sell price are automatically adjusted for the new pack size. +
-</WRAP>+
  
-**Include in DHIS2 data push:** If checked then data from this item will be included in information pushed to DHIS2 via the DHIS2 interface. +== Is a vaccine ==
----- +
-=== Shelf locations === +
-{{:items:item_basics:pasted:20200113-093139.png}}+
  
-**Shelf Location: ** The //default// shelf location for this item //in this store//.  When you receive items into stock, they will be given the shelf location you enter here unless a different location is chosen.  Type as much of the location (ie the first few characters) or code as you know, then press the // Tab// key. If only one location code matches your entry it will be filled in automatically, otherwise you will be shown a standard choice list like this:+Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (including in mSupply mobile; see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine_dispensing|mobile vaccine dispensing]] page for details). When checked, a default value of 1 is entered in the **Doses** field.
  
-{{  :items:loc_list.png?350  }}+== Hold: do not issue ==
  
-Select the location you want by double-clicking a line or by clicking once on the line and then clicking **OK**+If this box is checked, the item will not be available to be issued on invoices. It will still appear in lists, but you will get a warning if you choose it when issuing stock, and will be required to choose a different item.
  
-<WRAP center round tip 60%> +<WRAP center round important 60%> 
-Each stock line can have its own shelf location, or can share a location with another stock line.+Putting the Item on hold applies to //all// stock lines of the item in the **store you are currently logged into**.  If you wish to hold selected stock lines only, you should do that by editing the individual stock lines using [[items:showing_batches|Show items with stock]] or by using the stock tab of the item's details window (see the [[items:item_basics:tab_stock]] page for details).
 </WRAP> </WRAP>
  
-**Bulk Shelf Location:** Similar to shelf location but it is used to store bulk quantities of goods/items. You can enter a code here in the same manner as for the Shelf Location.+== Issue in builds only ==
  
-**Preferred pack size: ** This is the //default// pack size that will be chosen when receiving new goods or adding an item to a purchase order. It will also be used for comparison of quotations from suppliers (i.e. the //adjusted price// used when comparing quotations is the price if all quotes for the pack size defined here.+Checking this box will mean that the item cannot be issued on customer invoices.  This is useful in situations like where an item which by law can not be sold in an unprocessed state, but is used to 'build' (refer [[items:manufactured_items|Building (Manufacturing) Items]]) another item which is legal for distribution. 
  
-**Restricted to** Here you can choose from a list of Location types. For example, all cool store locations could have been given a type of "cool" and then if the item you are editing should be kept in a cool store, choose that type here, and you will only be able to receive that item into a cool store location.+== Allow pack to one conversion ==
  
-**Volume per pack: **If you are using available volume tracking in your warehouse, then fill in the default volume for one pack of the preferred packsize of the item here.+Checking this box allows stock of the item to be repacked to "''1''".
  
-<WRAP center round tip 60%> +== Convert pack to one when receiving ==
-mSupply(r) always stores volumes as m3 (cubic metres), but you can +
-enter a volume as millilitres (mL), litres (L) also.</WRAP>+
  
-<HTML><div align="center"></HTML>+If this box is checked, when you receive items the pack size will automatically be converted to "''1''".  This is primarily for use in dispensary mode, but may be useful in other 
 +situations too.
  
-^ You enter  ^ Value displayed  ^ mSupply(r) stores  ^  +<WRAP center round box 60%> 
-| 30ml       | 30ml             | 0.00003 m3      |  +For example: say you receive 50 x 100 boxes of paracetamol tablets, but you issue variable amounts of paracetmol tablets on invoices. If this option is checked, as you receive the stock on a supplier invoice, it will be converted to 5000 (quantity) x 1 (pack size). You will now be able to issue any quantity you like. The cost and sell price are automatically adjusted for the new pack size. 
-| 1500L      | 1.5 m3           | 1.5 m3          |  +</WRAP>
-| 600 L      | 600 L            | 0.6 m3          |  +
-| 1500 ml    | 1.5 L            | 0.0015 m3       |  +
-<HTML></div></HTML>+
  
-**Outer pack size:**  The number of //default// packs per //default// outer pack+== Include in DHIS2 data push ==
  
-**Outer pack volume: **  The volume for the //default// outer pack. This may be different to an exact multiple of the volume per //default// pack you entered above, as outer packs may have their own packing. (For example, vaccine packs may come in an insulated container.) +If checked then data from this item will be included in information pushed to DHIS2 via the DHIS2 interface.
- +
-**Weight per pack: **The weight of a //default// pack in kg.+
 ---- ----
 +
 === Pricing === === Pricing ===
 {{:items:item_basics:pasted:20200113-093256.png}}\\ {{:items:item_basics:pasted:20200113-093256.png}}\\
-**Default margin:**  This is the margin that will be applied to this item on supplier invoices to calculate the selling price. Note that if a supplier margin is also set, there is a setting in the **Preferences > Invoices 1** that determines which margin will be used. Note also that if a default selling price is set, this price will take priority and be used rather than the margin.+== Default margin == 
 + 
 +This is the margin that will be applied to this item on supplier invoices to calculate the selling price. It can be set to a different value in different stores if required (which also means that you must set it to a value in every store you want it to have a value in - setting it in one will not set it in any others). Note that if a supplier margin is also set, there is a setting in the **Preferences > Invoices 1** that determines which margin will be used. Note also that if a default selling price is set, this price will take priority and be used rather than the margin. 
 + 
 +== Default sell price of preferred pack size == 
 + 
 +Only enter a price here if you want a fixed selling price for this item. Enter the price for one preferred pack. A price entered here will override any margins you have specified for either the supplier or the item.
  
-**Default sell price of preferred pack size:** Only enter a price here if you want a fixed selling price for this item. Enter the price for one unit (eg 1 capsule or 1 gm). A price entered here will override any margins you have specified for either the supplier or the item.+== Price editable when issuing ==
  
-**Price editable when issuing:** If the **Allow editing selling price on customer invoice lines** store preference is turned on (see [[other_stuff:virtual_stores#preferences_tab|Virtual store preferences]]) and this checkbox is checked, when adding a line of this item to a customer invoice, an additional **Sell price** field will be available for the user to enter the sell price for that line of the customer invoice (see [[issuing_goods:issuing_goods_customer_invoice#issuing_from_a_single_line|Issuing goods (customer invoices)]] for details). +If the **Allow editing selling price on customer invoice lines** store preference is turned on (see [[other_stuff:virtual_stores#preferences_tab|Virtual store preferences]]) and this checkbox is checked, when adding a line of this item to a customer invoice, an additional **Sell price** field will be available for the user to enter the sell price for that line of the customer invoice (see [[issuing_goods:issuing_goods_customer_invoice#issuing_from_a_single_line|Issuing goods (customer invoices)]] for details). 
 ---- ----
 === Full description === === Full description ===
Line 121: Line 121:
  
 This field may be used for entering a fuller description of the item should the item name alone be insufficient. This field may be used for entering a fuller description of the item should the item name alone be insufficient.
 +
 +=== Product specifications ===
 +Enter any specifications for the item that would be important in a tender. Anything entered in here will be included in a tender and automatically uploaded to the Health Supply Hub.
 ---- ----
 +
 === VEN category === === VEN category ===
 {{:items:item_basics:pasted:20200113-093437.png}}\\ {{:items:item_basics:pasted:20200113-093437.png}}\\
-Like all categorisations, this one is used for reporting. VEN category options available are: +Like all categorisations, this one can be very helpful for reporting and ordering. VEN category options available are: 
-  * //Not assigned//  +  * **Not assigned**  
-  * //Vital// +  * **Vital** 
-  * //Essential// +  * **Essential** 
-  * //Not essential//+  * **Not essential** (or **Necessary** - see below)
  
-You can select one of the options only and //Not assigned// will be selected for all items by default.+Each item can be assigned only one of these VEN categories.  Items will be **Not assigned** by default.
  
-<WRAP center round tip 60%> +<WRAP center round important 60%> 
-Authorities, including the WHO, are inconsistent on whether **N** should stand for **Necessary** or **Not essential**.  It makes no difference to mSupply, but if you want this changed in your installation of mSupply, talk to Sustainable Solutions+  * Authorities, including the WHO, have been inconsistent on whether **N** should stand for **Necessary** or **Not essential**. 
 +  * In the past, there was a greater tendency towards **N** = **Necessary**.  Therefore, mSupply 'hard wired' **N** = **Necessary**. 
 +  * There is an increasing trend towards **N** = **Not essential**. 
 +  * As of mSupply v5.04, you can choose which is used in your data in the preferences - see [[preferences:general#title_for_n_classification_for_ven_items|General preferences - Title for "N" classification]]. 
 +    * For all pre-existing installations, **N** = **Necessary** unless you change it.  
 +    * For all new implementations after v5.04, **N** = **Not essential**.  
 </WRAP> </WRAP>
 \\  \\ 
  • Last modified: 2021/05/04 11:47
  • by Gary Willetts