Item
- The item table stores one record for each item you supply.
- Stock on hand of an item is not stored here - look in the “item_line” table
| Field name | Description | mSupply Use | Reference link | Type | Indexed |
|---|---|---|---|---|---|
| ID | UUID of the Item Not use is UI | Alpha | * | ||
| item_name | The name of the item | Item details window»General tab»Item name and also use in new Add item window»Item name | https://docs.msupply.org.nz/items:item_basics:tab_general#item_name | Alpha | * |
| start_of_year_date | Alpha | ||||
| manufacture_method | This is used to record the steps in the manufacturing process | Item details window»Bill of materials tab» Manufacture method | https://docs.msupply.org.nz/items:item_basics:tab_bill_of_materials | Alpha | |
| default_pack_size | The size used for comparing quotes | Item details window»Storage tab»Preferred pack size | https://docs.msupply.org.nz/items:item_basics:tab_storage#preferred_pack_size | Alpha | |
| dose_picture | Stores the image for patient medication | Item details window»Dispensing»Picture | https://docs.msupply.org.nz/items:item_basics:tab_dispensing#picture_instructions_and_purpose | Text | |
| atc_category | A WHO Anatomical/Thereapeutic classification | Item details window»Reporting»ATC Category | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Alpha | |
| medication_purpose | Enter the purpose of the medication here | Item details window»Dispensing»Medication Purpose | https://docs.msupply.org.nz/items:item_basics:tab_dispensing#picture_instructions_and_purpose | Long Integer | |
| instructions | Enter the medication instructions here | Item details window»Dispensing»Patient instruction | https://docs.msupply.org.nz/items:item_basics:tab_dispensing#picture_instructions_and_purpose | Date | |
| user_field_7 | for customised use by user | Only shown if the pref custom» | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Date | * |
| flags | Used for quickly marking items for reporting purposes | Item List window»Set values | https://docs.msupply.org.nz/items:item_basics#set_values | Date | * |
| ddd_value | The defined daily dose for the item | Item details window»Reporting»DDD value | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Time | |
| code | The item code | Item details window»Item code also you can set it while creating new item window»Item code | https://docs.msupply.org.nz/items:item_basics:tab_general#item_code | Alpha | * |
| other_names | Used to record alternative names of the same item- can include brand names | Item details window»Misc tab»Other names | Text | * | |
| type_of | Select the type of item you want to add here. The field always defaults to normal. | Add item window»Type | https://docs.msupply.org.nz/items:adding_a_new_item#adding_a_new_item | Text | |
| price_editable | Can the price be edited at issue time? | Item details window»General tab»Price editable when issuing | https://docs.msupply.org.nz/items:item_basics:tab_general#price_editable_when_issuing | Boolean | |
| margin | The default margin for this item | Real | |||
| barcode_spare | Text | ||||
| spare_ignore_for_orders | Boolean | ||||
| sms_pack_size | When an SMS user orders, this is the pack size they are referring to | Item details window»Misc tab»SMS pack size | https://docs.msupply.org.nz/items:item_basics:tab_misc | Real | * |
| expiry_date_mandatory | If true, you will have to enter an expiry date when receiving this item on a goods receipt or supplier invoice | Item details window»Order options tab»Expiry date required on receive | https://docs.msupply.org.nz/items:item_basics:tab_order_options | Boolean | |
| volume_per_pack | volume in m3 for one reference pack | Real | |||
| department_ID | The key of the department this item belongs to (internal) | Basically ID are not used in UI but used to to display Item details window»General»Department | https://docs.msupply.org.nz/items:item_basics:tab_general#department | Alpha | * |
| weight | the weight in kg of one reference pack | Item details window»Storage tab»Weight per pack | https://docs.msupply.org.nz/items:item_basics:tab_storage#weight_per_pack | Real | |
| essential_drug_list | True if the item is on your essential drug list | Item details window»General tab»On essential drug list | https://docs.msupply.org.nz/items:item_basics:tab_general#stock_category | Boolean | |
| catalogue_code | A secondary code for the item- you can optionally include this code when searching for items | Item details window»Reporting»Catalogue code | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Alpha | * |
| indic_price | Real | ||||
| user_field_1 | for customised use by user. Labels for user fields can be set in the preferences | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Alpha | ||
| spare_hold_for_issue | Boolean | ||||
| builds_only | Only issue this item on builds | Item details window»General tab»Issue in build only | https://docs.msupply.org.nz/items:item_basics:tab_general#issue_in_builds_only | Boolean | |
| reference_bom_quantity | The quantity that the entered bill of materials will produce | Item details window»Bill of materials»Quantity of finished product this bill of materials is for | https://docs.msupply.org.nz/items:item_basics:tab_bill_of_materials#items_-_bill_of_materials_tab | Real | |
| use_bill_of_materials | If this check box is not checked, the bill of materials will not be used when manufacturing builds | Item details window»Bill of materials»Use a bill of materials to manufacture this item | https://docs.msupply.org.nz/items:item_basics:tab_bill_of_materials#items_-_bill_of_materials_tab | Boolean | |
| description | Long description of the item | Item details window»General tab»Full description | https://docs.msupply.org.nz/items:item_basics:tab_general#full_description | Text | |
| spare_hold_for_receive | Boolean | ||||
| Message | Text that will be displayed in a window when this item is issued or received | Text | |||
| interaction_group_ID | Basically ID are not used in UI but used to display | Item details window»General tab»Interaction group | https://docs.msupply.org.nz/items:item_basics:tab_general#interaction_group | Alpha | * |
| spare_pack_to_one_on_receive | Boolean | ||||
| cross_ref_item_ID | Alpha | ||||
| strength | Used if reports need the strength separate to the item name [from version 4.04] | Item details window»Reporting»Item Strength | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Alpha | |
| user_field_4 | for customised use by user | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Boolean | ||
| user_field_6 | for customised use by user | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Alpha | ||
| spare_internal_analysis | Real | ||||
| user_field_2 | for customised use by user | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Alpha | ||
| user_field_3 | for customised use by user | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields | Alpha | ||
| ddd factor | Defined Daily Dose factor- this is the number of units of the item that make up the DDD value | Item details window»Reporting»DDD factor | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Real | |
| account_stock_ID | The ID of the account used when holding stock (and asset) for this item (not used unless linking to accounting software) | Alpha | |||
| account_purchases_ID | The ID of the account used when buying this item (not used unless linking to accounting software) | Alpha | |||
| account_income_ID | The ID of the account used when selling this item (not used unless linking to accounting software) | Basically ID are not used in UI but used to display Item details window»Misc tab»Income account when selling | Alpha | ||
| unit_ID | The internal key of the units for this item | Basically ID are not used in UI but used to display Item details window»General»Units | https://docs.msupply.org.nz/items:item_basics:tab_general#units | Alpha | * |
| outer_pack_size | The Outer pack volume is the default volume of an Outer pack size pack of this item | Item details window»Storage»Outer pack size | https://docs.msupply.org.nz/items:item_basics:tab_storage#outer_pack_size | Long Integer | |
| category_ID | The ID of the category assigned to this item | Basically ID are not used in UI but used to display Item details window»General»Category | https://docs.msupply.org.nz/items:item_basics:tab_general#category | Alpha | * |
| ABC_category | This option allows you to mark items that are commonly used and then report on only those items | Item details window»Reporting»ABC category | https://docs.msupply.org.nz/items:item_basics:tab_reporting#items_-_reporting_tab | Alpha | |
| warning_quantity | attempts to issue greater than this quantity will give the user an alert to stop accidental issuing of large quantities | Item details window»Dispensing»Warn if user tries to issue more than | https://docs.msupply.org.nz/items:item_basics:tab_dispensing | Long Integer | |
| user_field_5 | for customised use by user | Real | |||
| print_units_in_dis_labels | Boolean | ||||
| volume_per_outer_pack | Real | ||||
| normal_stock | Item details window»General tab»Normal stock | https://docs.msupply.org.nz/items:item_basics:tab_general#stock_category | Boolean | ||
| critical_stock | Item details window»General tab»Critical stock | https://docs.msupply.org.nz/items:item_basics:tab_general#stock_category | Boolean | ||
| spare_non_stock | Boolean | ||||
| non_stock_name_ID | The ID of the customer (name) the item is to be supplied to | Alpha | |||
| is_sync | Boolean | ||||
| sms_code | The code that the SMS sender uses to identify the item | Item details window»Misc tab»SMS code | https://docs.msupply.org.nz/items:item_basics:tab_misc | Alpha | |
| category2_ID | https://docs.msupply.org.nz/items:item_categories#category_2_and_3_categories | Alpha | |||
| category3_ID | https://docs.msupply.org.nz/items:item_categories#category_2_and_3_categories | Alpha | |||
| buy_price | The notional buy price of the item in your home currency | Item details window»General tab»Cost price | Real | ||
| VEN_category | for customised use by user | Item details window»General tab»VEN category | https://docs.msupply.org.nz/items:item_basics:tab_general#ven_category | Text | |
| universalcodes_code | Universal or global identification code for the item | Item details window»General tab»Universal code | https://docs.msupply.org.nz/items:item_basics:tab_general#universal_code | Alpha | |
| universalcodes_name | Name associated with the universal code | Alpha | |||
| kit_data | Object | ||||
| custom_data | Custom data stored against the item | Object | |||
| doses | Enter the number of doses a single unit of this item provides | Item details window»General tab»Doses | https://docs.msupply.org.nz/items:item_basics:tab_general#doses | Long Integer | |
| is_vaccine | Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality | Item details window»General tab»Is a vaccine? | https://docs.msupply.org.nz/items:item_basics:tab_general#is_a_vaccine | Boolean | |
| restricted_location_type_ID | Alpha | ||||
| 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. | Item details window»General tab»Product specifications | https://docs.msupply.org.nz/items:item_basics:tab_general#product_specifications | Text |