| Both sides previous revision Previous revision Next revision | Previous revision |
| tables_fields:main_tables:item [2021/11/29 21:47] – Mark Glover | tables_fields:main_tables:item [2026/01/12 09:41] (current) – Raksha Khadka |
|---|
| ====== Item ====== | ====== Item ====== |
| | [[..:|Back to list of main tables]] |
| [[tables:main_tables:|Back to list of main tables]] | |
| |
| <WRAP center round important 60%> | <WRAP center round important 60%> |
| </WRAP> | </WRAP> |
| |
| | ^ Field name ^ Description ^ mSupply Use ^ Reference link ^ Type ^ Indexed ^ |
| ^ Field name ^ Description ^ Type ^ Indexed ^ | | ID | UUID of the Item Not use is UI | | | Alpha | * | |
| | ABC_category | | Alpha 20 | | | | 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 | * | |
| | account_income_ID | The ID of the account used when selling this item (not used unless linking to accounting software) | UUID | | | | start_of_year_date| | | | Alpha | | |
| | account_purchases_ID |The ID of the account used when buying this item (not used unless linking to accounting software) | UUID | | | | 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| | |
| | account_stock_ID | The ID of the account used when holding stock (and asset) for this item (not used unless linking to accounting software) | UUID | | | | 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 | | |
| | atc_category | A WHO Anatomical/Thereapeutic classification | Alpha 30 | | | | 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 | | |
| | builds_only | Only issue this item on builds | Boolean | | | | 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 | | |
| | buy_price | The notional buy price of the item in your home currency | Real | | | | 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 | | |
| | catalogue_code | A secondary code for the item- you can optionally include this code when searching for items | Alpha 20 | * | | | 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 | | |
| | category_ID | The ID of the category assigned to this item | UUID | * | | | 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 | * | |
| | category2_ID | | UUID | | | | 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| * | |
| | category3_ID | | UUID | | | | 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 | Alpha 18 | * | | | 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 | * | |
| | critical stock | | Boolean | | | | other_names | Used to record alternative names of the same item- can include brand names | Item details window>>Misc tab>>Other names | | Text | * | |
| | cross_ref_item_ID | | UUID | | | | 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 | |
| | ddd factor | | Real | | | | 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 | | |
| | ddd_value | The defined daily dose for the item| Alpha 8 | | | | margin | The default margin for this item| | | Real | | |
| | default_pack_size | The size used for comparing quotes | Real | | | | barcode_spare | | | |Text| | |
| | (default_price)| Not an item field: Is set per-store, so is a field in item_store_join table | Real | | | | spare_ignore_for_orders | | | | Boolean| | |
| | department_ID | The key of the department this item belongs to (internal) | UUID | * | | | 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 | * | |
| | description | Long description of the item | Text | | | | 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 | | |
| | dose_picture | Stores the image for patient medication | Blob | | | | volume_per_pack | volume in m3 for one reference pack | | | Real | | |
| | essential_drug_list | True if the item is on your essential drug list | Boolean | | | | 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 | * | |
| | expiry_date_mandatory | If true, you will have to enter an expiry date when receiving this item on a goods receipt or supplier invoice | Boolean | | | | 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 | | |
| | flags | Used for quickly marking items for reporting purposes | Alpha 16((Increased from 8 in v3.13)) | * | | | 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 | | |
| | hold_for_issue | If true, this item can not be added to customer invoices | 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 | * | |
| | hold_for_receive | If true, this item can not be received on supplier invoices | Boolean | | | | indic_price | | | | Real | | |
| | ID | Internal reference | UUID | * | | | 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 | | |
| | ignore_for_orders | If true, this item will never be added to an order automatically | Boolean | | | | spare_hold_for_issue | | | | Boolean | | |
| | indic_price | | Real | | | | 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 | | |
| | instructions | | Text | | | | 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 | | |
| | interaction_group_ID | | UUID | * | | | 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 | | |
| | internal_analysis | | Real | | | | 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 | | |
| | is_sync | | Boolean | | | | spare_hold_for_receive | | | | Boolean | | |
| | item_name | The name of the item | Alpha 80 | * | | | Message | Text that will be displayed in a window when this item is issued or received | | | Text | |
| | item_type | "gn" = general, "sv" = service, "cr" = cross reference | Alpha 3 | | | | 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 | * | |
| | manufacture_method | | Text | | | | spare_pack_to_one_on_receive | | | | Boolean | | |
| | margin | The default margin for this item | Real | | | | cross_ref_item_ID | | | | Alpha | | |
| | medication_purpose | | Text | | | | 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 | | |
| | message | Text that will be displayed in a window when this item is issued or received | Text | | | | user_field_4 | for customised use by user | | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields |Boolean | | |
| | non_stock | True means that the item is immediately supplied to a particular customer on receipt. | Boolean | | | | user_field_6 | for customised use by user | | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields |Alpha | | |
| | non_stock_name_ID | The ID of the customer (name) the item is to be supplied to | UUID | | | | spare_internal_analysis | | | | Real | | |
| | normal_stock | | Boolean | | | | user_field_2 | for customised use by user | | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields |Alpha | | |
| | other_names | Used to record alternative names of the same item- can include brand names | Text | * | | | user_field_3 | for customised use by user | | https://docs.msupply.org.nz/items:item_basics:tab_general#custom_fields |Alpha | | |
| | outer_pack_size | | Long | | | | 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 | | |
| | pack_to_one_on_recieve | | Boolean | | | | 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 | | |
| | price_editable | Can the price be edited at issue time? | Boolean | | | | account_purchases_ID | The ID of the account used when buying this item (not used unless linking to accounting software) | | | Alpha | | |
| | print_units_in_dis_labels | | Boolean | | | | 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 | | |
| | reference_bom_quantity | The quantity that the entered bill of materials will produce | Long | | | | 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 | * | |
| | sms_code | The code that the SMS sender uses to identify the item | Alpha 20 | | | | 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 | | |
| | sms_pack_size | When an SMS user orders, this is the pack size they are referring to | Real | * | | | 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 | * | |
| | start_of_year_date | | Date | | | | 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 | | |
| | strength | Used if reports need the strength separate to the item name [from version 4.04] | Real | | | | 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 | |
| | strenghtUnits | If strength is specified, this is the units (e.g. "mg") [from version 4.04] | Text | | | | user_field_5 | for customised use by user | | | Real | | |
| | unit_ID | The internal key of the units for this item | UUID | * | | | print_units_in_dis_labels | | | | Boolean | | |
| | user_field_1 | for customised use by user. Labels for user fields can be set in the preferences | Alpha 30 | | | | volume_per_outer_pack | | | | Real | | |
| | user_field_2 | for customised use by user | Alpha 30 | | | | normal_stock | | Item details window>>General tab>>Normal stock | https://docs.msupply.org.nz/items:item_basics:tab_general#stock_category | Boolean | | |
| | user_field_3 |for customised use by user | Alpha 30 | | | | critical_stock | | Item details window>>General tab>>Critical stock| https://docs.msupply.org.nz/items:item_basics:tab_general#stock_category | Boolean| | |
| | user_field_4 |for customised use by user | Boolean | | | | spare_non_stock | | | | Boolean | | |
| | user_field_5 | for customised use by user| Real | | | | non_stock_name_ID | The ID of the customer (name) the item is to be supplied to | | |Alpha | | |
| | user_field_6 | for customised use by user| Alpha 80 | | | | is_sync | | | | Boolean | | |
| | user_field_7 | for customised use by user| 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 | | |
| | VEN_category | for customised use by user| Text | | | | category2_ID | | | https://docs.msupply.org.nz/items:item_categories#category_2_and_3_categories | Alpha | | |
| | volume_per_outer_pack | | Real | | | | category3_ID | | | https://docs.msupply.org.nz/items:item_categories#category_2_and_3_categories | Alpha | | |
| | volume_per_pack | volume in m3 for one reference pack | Real | | | | buy_price | The notional buy price of the item in your home currency | Item details window>>General tab>>Cost price | | Real | | |
| | warning_quantity | attempts to issue greater than this quantity will give the user an alert to stop accidental issuing of large quantities | Long | | | | 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 | | |
| | weight | the weight in kg of one reference pack | Real | | | | 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 | |
| ---- struct data ---- | ---- struct data ---- |
| pagestatus.status : | pagestatus.status : |
| ---- | ---- |
| |