| Both sides previous revision Previous revision | |
| tables_fields:main_tables:name [2023/04/06 14:31] – Gary Willetts | tables_fields:main_tables:name [2026/01/20 10:41] (current) – Raksha Khadka |
|---|
| </WRAP> | </WRAP> |
| |
| | ^ Field name ^ Description ^ mSupply Use ^ Reference link ^ Type ^ Indexed ^ |
| ^ Field name ^ Description ^ Type ^ Indexed ^ | | ID | The unique ID given to this name | Not used in UI | | Alpha | * | |
| | ID | The unique ID given to this name | Long | * | | |
| | | Related to asset.name_id, backorder.name_id_customer, backorder.name_id_supplier, contact.name_ID, Goods_received_line.manufacturer_ID, HIS_encoutner.PATIENT_ID, item_line.name_ID, item_line.manufacturer_ID, item_store_join.non_stock_name_ID, list_group.name_id, list_name_join.name_ID, name_budget.name_ID, name_note.name_ID, name_stock_history.name_ID, name_store_join.name_ID, patient_medication.name_ID, purchase_order.name_ID, purchase_order_line.non_stock_name_ID, quote.names_ID, quote_line.manufacturer_ID, quote_line.name_ID, regimen_record.name_ID, repeat_table.name_ID, store.name_ID, transact.name_ID, web_favourite.name_ID, tender.benchmarkSupplier_ID,[goods_received]donor_id,[item_line]donor_id, [purchase_order]donor_id, [trans_line]donor_id ||| | | | Related to asset.name_id, backorder.name_id_customer, backorder.name_id_supplier, contact.name_ID, Goods_received_line.manufacturer_ID, HIS_encoutner.PATIENT_ID, item_line.name_ID, item_line.manufacturer_ID, item_store_join.non_stock_name_ID, list_group.name_id, list_name_join.name_ID, name_budget.name_ID, name_note.name_ID, name_stock_history.name_ID, name_store_join.name_ID, patient_medication.name_ID, purchase_order.name_ID, purchase_order_line.non_stock_name_ID, quote.names_ID, quote_line.manufacturer_ID, quote_line.name_ID, regimen_record.name_ID, repeat_table.name_ID, store.name_ID, transact.name_ID, web_favourite.name_ID, tender.benchmarkSupplier_ID,[goods_received]donor_id,[item_line]donor_id, [purchase_order]donor_id, [trans_line]donor_id ||| |
| | name | Name's name | Alpha | * | | | name| Name's name | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Name| https://docs.msupply.org.nz/names:adding_and_editing#adding_a_new_customer | Text| * | |
| | barcode | Set to the code field with an '*' at either end. Doesn't seem to be used for anything... | Alpha | | | | fax | Name's phone number| New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Fax | | Alpha | | |
| | Benchmark | True if name is a benchmark supplier, against which others' prices are to be compared | Boolean | | | | phone | Name's phone number | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Phone | | Alpha| | |
| | bill_address1 | Billing address line 1 | Alpha | | | | customer | True if this name is a customer | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Customer | | Boolean | * | |
| | bill_address2 | Billing address line 2 | Alpha | | | | bill_address1 | Billing address line 1 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Main/Billing Address 1 | | Alpha | | |
| | bill_address3 | Billing address line 3 | Alpha | | | | bill_address2 | Billing address line 2 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Main/Billing Address 2 | | Alpha| | |
| | bill_address4 | Billing address line 4 | Alpha | | | | supplier |True if this name is a supplier | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Supplier | https://docs.msupply.org.nz/names:adding_and_editing#adding_a_new_supplier| Boolean | * | |
| | bill_address5 | Billing address line 5 | Alpha | | | | charge code | Code to charge a name's transactions to when exporting| New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Charge to | https://docs.msupply.org.nz/names:adding_and_editing#charge_to | Alpha| * | |
| | bill_postal_zip_code | Billing address postcode | Alpha | | | | margin | The margin applied to the cost price of this supplier's goods to calculate the sell price | New/Edit Name(supplier)>>General Tab>>Margin(Only shown if the name is supplier in Supplier details) | https://docs.msupply.org.nz/names:adding_and_editing#extra_information_for_suppliers_only | Real| | |
| | Blood_Group | Patients only: patient's blood group | Alpha | | | | comment | Comment stored against this name | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Comment | | Text | | |
| | category1_ID | ID of the category1 level3 category this name has been assigned to | Long | * | | | currency_ID | Supplier only: ID of the currency this supplier uses | | | Alpha | | |
| | category2_ID | ID of the category2 category the name is assigned to | Longint | * | | | country | Billing address country | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>Country(Main/Billing) | | Alpha | | |
| | category3_ID | ID of the category3 category the name is assigned to | Longint | * | | | freightfac | Multiplier to apply to quote lines to account for freight charges | New/Edit Name(supplier)>>General Tab>>Freight factor(Only shown if the name is supplier in Supplier details) | https://docs.msupply.org.nz/names:adding_and_editing#extra_information_for_suppliers_only | Real| | |
| | category4_ID | ID of the category4 category the name is assigned to | Longint | * | | | email | Name's email address. You can put multiple email addresses here separated by commas. | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>email(contact) | | Alpha | | |
| | category5_ID | ID of the category5 category the name is assigned to | Longint | * | | |custom1 | Custom field 1 contents - defined by user | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>Custom 1| | Alpha | | |
| | category6_ID | ID of the category6 category the name is assigned to | Longint | * | | | code | This name's code | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Code |https://docs.msupply.org.nz/names:adding_and_editing#name_code | Alpha | * | |
| | charge code | Code to charge a name's transactions to when exporting | Alpha | * | | | last | Patients only: patient's last name | New/Edit Name(Patient)>>General tab>>Last | | Alpha | * | |
| | code | This name's code | Alpha | * | | | first | Patients only: patient's first name | New/Edit Name(Patient)>>General tab>>First | | Text | * | |
| | comment | Comment stored against this name | Text | | | | title | Patients only: patient's title (Mr, Ms etc.) | | | Text | | |
| | connection_type | The type of connection to the internet the name has: 1=low bandwidth, 2=high bandwidth | Integer | | | | female | Patients only: True if female, False if male | New/Edit Name(Patient)>>General tab>>Female | | Boolean | | |
| | country | Billing address country | Alpha | | | | date_of_birth | Patients only: patient's date of birth| New/Edit Name(Patient)>>General tab>>Date of Birth| | Date | | |
| | currency_ID | Supplier only: ID of the currency this supplier uses | Alpha | | | | overpayment | Deprecated as of v4.11 and not used - calculated as needed Amount overpaid to a customer from a supplier | | | Real | | |
| | custom1 | Custom field 1 contents - defined by user | Alpha | | | | group_ID | ID of the department this name has been assigned to | | | Alpha | * | |
| | custom2 | Custom field 2 contents - defined by user | Alpha | | | | hold | If true, you can't issue or receive items to/from this name | New/Edit Name(supplier/customer/manufacture/doner/patient)>>General Tab>>Hold (Status) | https://docs.msupply.org.nz/names:adding_and_editing#status_-_hold_checkbox | Boolean | | |
| | custom3 | Custom field 3 contents - defined by user | Alpha | | | | ship_address1 | Shipping address line 1 | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>Shipping Address 1 | | Alpha| | |
| | custom_data | Custom data stored as values and fields. Also facility code for DHIS2 data is placed here | Object | | | | ship_address2 | Shipping address line 2 | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>Shipping Address 2 | | Alpha | | |
| | customer | True if this name is a customer | Boolean | * | | | url | Web page of this name. Includes "http:%%/%%/" | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>web site | | Alpha | | |
| | date_of_birth | Patients only: patient's date of birth | Date | | | | barcode |Set to the code field with an '*' at either end. Doesn't seem to be used for anything… | | | Text | | |
| | default_order_days | The default number of days that this customer orders for in a customer stock history | Integer | | | | postal_address1 | Postal address line 1 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | | |
| | donor | True if the name is a donor | Boolean | * | | | postal_address2 | Postal address line 2 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | | |
| | email | Name's email address. You can put multiple email addresses here separated by commas. | Alpha | | | | category1_ID | ID of the category1 level3 category this name has been assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 1 | https://docs.msupply.org.nz/names:name_categories | Alpha | * | |
| | ethnicity_ID | Patients only: ID of the patient's ethnicity | Longint | * | | | religion_ID | Patients only: ID of the patient's religion | | | Alpha | | |
| | fax | Name's phone number | Alpha | | | | type |“store” - a name associated with an mSupply virtual store\\ “invad” - a reserved name used for inventory adjustment transactions\\ “build” - a reserved name used for build transactions\\ “repack” - a reserved name used for repack transactions\\ “patient” - patients\\ “facility” - a supplier or customer who is external to your mSupply virtual store system (see booleans name.customer and name.supplier for differentiation) | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Type | https://docs.msupply.org.nz/names:adding_and_editing#type | Text | * | |
| | female | Patients only: True if female, False if male | Boolean | | | | price_category | The price category (A-F) this name is assigned to | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Price category | https://docs.msupply.org.nz/names:adding_and_editing#price_category | Alpha | | |
| | first | Patients only: patient's first name | Alpha | * | | | flag | Comma separated list of flags assigned to this name | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Flag | | Alpha | | |
| | flag | Comma separated list of flags assigned to this name | Alpha | | | | manufacturer | True if this name is a manufacturer | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Manufacturer | | Boolean | | |
| | freightfac | Multiplier to apply to quote lines to account for freight charges. | Real | | | | print_invoice_alphabetical | If true, invoice lines are printed in alphabetical order for this name | | | Boolean | | |
| | group_ID | ID of the department this name has been assigned to | Long | * | | | custom2 | Custom field 2 contents - defined by user | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Custom 2 | | Alpha | | |
| | hold | If true, you can't issue or receive items to/from this name | Boolean | | | | custom3 | Custom field 3 contents - defined by user | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Custom 3 | | Alpha | | |
| | is_deleted | Only used for patients in mobile. Soft delete flag i.e. patients with this set to true are not displayed or included in search results | Boolean | | | | default_order_days | The default number of days that this customer orders for in a customer stock history | | | Integer | | |
| | isDeceased | Only used for patients in mobile. Set to true if the patient has died | Boolean | | | | connection_type | The type of connection to the internet the name has: 1=low bandwidth, 2=high bandwidth | | | Integer | | |
| | last | Patients only: patient's last name | Alpha | * | | | PATIENT_PHOTO | Patients only: patient's photo |New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Photo | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Picture | | |
| | latitude | The degrees latitude of the name's location | Real | | | | NEXT_OF_KIN_ID | Patients only: ID of the patient's next of kin (another patient) | | | Alpha | * | |
| | longitude | The degrees longitude of the name's location | Real | | | | POBOX | Patients only: the patient's PO Box, part of their address | | | Alpha | | |
| | manufacturer | True if this name is a manufacturer | Boolean | * | | | ZIP | Postal address postcode | | | Long Integer | | |
| | margin | The margin applied to the cost price of this supplier's goods to calculate the sell price | Real | | | | middle | Patients only: patient's middle name | | | Text | | |
| | marital_status | Patients only: patient's marital status | Alpha | | | | preferred | If true this supplier is a preferred supplier when comparing bids in a tender | | | Boolean | | |
| | Master_RTM_Supplier_Code | The code this supplier has in the RTM | Longint | * | | | Blood_Group | Patients only: patient's blood group | | | Alpha | | |
| | Master_RTM_Supplier_name | The name of this supplier in the RTM | Alpha | | | | marital_status | Patients only: patient's marital status | | | Alpha | | |
| | middle | Patients only: patient's middle name | Alpha | | | | Benchmark | True if name is a benchmark supplier, against which others' prices are to be compared | | | Boolean | | |
| | mother_id | Patients only: ID of the patient's mother (another patient) | Longint | * | | | next_of_kin_relative | Relation that is patient's next of kin e.g. 'Parent' | | | Alpha | | |
| | national_health_number | Patients only: patient's national health number | Alpha | | | | mother_id | Patients only: ID of the patient's mother (another patient) | | | Alpha | * | |
| | NEXT_OF_KIN_ID | Patients only: ID of the patient's next of kin (another patient) | Longint | * | | | postal_address3 | Postal address line 3 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Postal Address 3 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | | |
| | next_of_kin_relative | Relation that is patient's next of kin e.g. 'Parent' | Alpha | | | | postal_address4 | Postal address line 4 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Postal Address 4 | https://docs.msupply.org.nz/names:adding_and_editing#postal_address | Alpha | | |
| | occupation_ID | Patients only: ID of the patient's occupation | Longint | * | | | bill_address3 | Billing address line 3 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Address 3(Main/Billing) | | Alpha | | |
| | om_created_datetime | The time a name was created. Used by Open mSupply in a sync system. | Time | | | | bill_address4 | Billing address line 4 | New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Address 4(Main/Billing) | | Alpha | | |
| | om_gender | Gender, used by Open mSupply in a sync system. mSupply only has male and female as choices, Open mSupply has a much wider selection of options | Text | | | | ship_address3 | Shipping address line 3 | New/Edit Name(customer)>>General Tab>>Address 3(Shipping address) | | Alpha | | |
| | ordering_method | The type of customer stock history this customer uses: im=imprest, sh=stock history | Alpha | | | | ship_address4 | Shipping address line 4 | New/Edit Name(customer)>>General Tab>>Address 4(Shipping address) | | Alpha | | |
| | overpayment | **Deprecated as of v4.11 and not used - calculated as needed** Amount overpaid to a customer from a supplier | Real | | | | ethnicity_ID | Patients only: ID of the patient's ethnicity | | | Alpha | * | |
| | PATIENT_PHOTO | Patients only: patient's photo | Picture | | | | occupation_ID | Patients only: ID of the patient's occupation | | | Alpha | * | |
| | phone | Name's phone number | Alpha | | | | religion_ID | Patients only: ID of the patient's religion | | | Alpha | * | |
| | POBOX | Patients only: the patient's PO Box, part of their address | Alpha | | | | national_health_number | Patients only: patient's national health number | | | Alpha | | |
| | postal_address1 | Postal address line 1 | Alpha | | | | Master_RTM_Supplier_Code | The code this supplier has in the RTM | | | Long Integer | * | |
| | postal_address2 | Postal address line 2 | Alpha | | | | ordering_method | The type of customer stock history this customer uses: im=imprest, sh=stock history | | | Alpha | | |
| | postal_address3 | Postal address line 3 | Alpha | | | | donor | True if the name is a donor | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>Doner (Category) |https://docs.msupply.org.nz/names:adding_and_editing#donor_checkbox | Boolean | * | |
| | postal_address4 | Postal address line 4 | Alpha | | | | latitude | The degrees latitude of the name's location | | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Real | | |
| | postal_address5 | Postal address line 5 | Alpha | | | | longitude | The degrees longitude of the name's location | | https://docs.msupply.org.nz/names:adding_and_editing#photo_tab | Real | | |
| | postal_zip_code | Postal address postcode | Alpha | | | | Master_RTM_Supplier_name | The name of this supplier in the RTM | | | Alpha | | |
| | preferred | If true this supplier is a preferred supplier when comparing bids in a tender | Boolean | | | | category2_ID | ID of the category2 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 2 | https://docs.msupply.org.nz/names:name_categories | Alpha | * | |
| | price_category | The price category (A-F) this name is assigned to | Alpha | | | | category3_ID | ID of the category3 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 3 |https://docs.msupply.org.nz/names:name_categories |Alpha | * | |
| | print_invoice_alphabetical | If true, invoice lines are printed in alphabetical order for this name | Boolean | | | | category4_ID | ID of the category4 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 4 | https://docs.msupply.org.nz/names:name_categories | Alpha | * | |
| | religion_ID | Patients only: ID of the patient's religion | Longint | * | | | category5_ID | ID of the category5 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 5 | https://docs.msupply.org.nz/names:name_categories | Alpha | * | |
| | sacho | The name's web login password | BLOB | | | | category6_ID | ID of the category6 category the name is assigned to | Is set by user in Preference Names tab New/Edit Name(supplier/customer/manufacture/doner)>>General Tab>>Category 6 | https://docs.msupply.org.nz/names:name_categories |Alpha | * | |
| | ship_address1 | Shipping address line 1 | Alpha | | | | bill_address5 | Billing address line 5 | New/Edit Name(supplier/manufacture)>>Main/Billing Address 5 | | Alpha | | |
| | ship_address2 | Shipping address line 2 | Alpha | | | | bill_postal_zip_code | Billing address postcode | | | Alpha | | |
| | ship_address3 | Shipping address line 3 | Alpha | | | | postal_address5 | Postal address line 5 | New/Edit Name(supplier/manufacture)>>General tab>>Postal Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#tags_tab | Alpha | | |
| | ship_address4 | Shipping address line 4 | Alpha | | | | postal_zip_code | Postal address postcode | | | Alpha | | |
| | ship_address5 | Shipping address line 5 | Alpha | | | | ship_address5 |Shipping address line 5 | New/Edit Name(supplier/manufacture)>>General tab>>Shipping Address 5 | https://docs.msupply.org.nz/names:adding_and_editing#tags_tab | Alpha | | |
| | ship_postal_zip_code | Shipping address postcode | Alpha | | | | ship_postal_zip_code |Shipping address postcode | New/Edit Name(supplier/manufacture)>>General tab>>Shipping Address 5 | |Alpha | | |
| | supplier | True if this name is a supplier | Boolean | * | | | supplying_store_id | Store that supplies customer | New/Edit Name(Customer)>>General tab>>Supplying Store(Customer details) | https://docs.msupply.org.nz/names:adding_and_editing#supplying_store | Alpha | | |
| | title | Patients only: patient's title (Mr, Ms etc.) | Alpha | | | | license_number | | | | Alpha | | |
| | **type** (v3.5 on) |“store” - a name associated with an mSupply virtual store\\ “invad” - a reserved name used for inventory adjustment transactions\\ “build” - a reserved name used for build transactions\\ “repack” - a reserved name used for repack transactions\\ “patient” - patients \\ “facility” - a supplier or customer who is external to your mSupply virtual store system (see booleans name.customer and name.supplier for differentiation) | Alpha | * | | | license_expiry | | | | Date | | |
| | url | Web page of this name. Includes "http:%%/%%/" | Alpha | | | | has_current_license | | | | Boolean | | |
| | web_id | The user name used to log on to the web interface | Alpha | * | | | custom_data | | | | Object | | |
| | ZIP | Postal address postcode | Longint | | | | maximum_credit | This is the maximum debt that a patient's account can have when the payments module is activated | New patient>>General tab>>Credit limit | https://docs.msupply.org.nz/dispensing:patients#general_tab | Real | | |
| | | nationality_ID | | | |Alpha | | |
| | | created_date | | | |Date | | |
| | | integration_reference_ID | | | | Alpha | | |
| | | isDeceased | | | | Boolean | | |
| | | is_deleted | Is true if the name is soft delete | Not shown in UI | | Boolean | | |
| | | om_created_datetime | | | | Alpha | | |
| | | om_gender | | | | Alpha | | |
| | | HSH_name | HSH name used for Health Supply Hub to link suppliers or manufacturers with their record on the [[Health Supply Hub]] server and maintained by The mSupply Foundation | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>HSH name | https://docs.msupply.org.nz/names:adding_and_editing#hsh_code_hsh_name | Alpha | | |
| | | HSH_code | HSH code used for Health Supply Hub to link suppliers or manufacturers with their record on the Health Supply Hub server and maintained by The mSupply Foundation | New/Edit Name(supplier/customer/manufacture/doner)>>General tab>>HSH code | https://docs.msupply.org.nz/names:adding_and_editing#hsh_code_hsh_name | Alpha | | |
| | | HSH_ID | ID of the HSH code | Not use in UI | | Alpha | | |
| | | om_date_of_death | | | | Date | | |
| | | spare_alpha_1 | | | | Alpha | | |
| | | spare_alpha_2 | | | | Alpha | | |
| ---- struct data ---- | ---- struct data ---- |
| pagestatus.status : | pagestatus.status : |
| ---- | ---- |
| |