# Code WHODrug Products

Vault supports the IDMP-compliant WHODrug dictionary in the C3 format for standardized coding of medicinal products.  When a reported term on an _External Product_ matches a WHODrug dictionary term, Vault [auto-codes][5] the WHODrug product. Additionally, you can access the WHODrug dictionary to add _External Products_ or _Drug History_ to a _Case_. When you open the _WHODrug Search_ window, Vault filters the codes based on the reported product name and country.

When coding _External Products_ on domestic _Cases_ for Japan, Korea, or China and foreign _Localized Cases_ reportable to the PMDA, MFDS, or NMPA, Vault may [cross-reference][1] selected codes with the Iyakuhinmei Data File (IDF), Korea Drug Dictionary, or WHODrug Global Chinese data and populate the corresponding code in the applicable localized field. 

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: The Iyakuhinmei Data File (IDF) may also be referred to as Japan Drug Dictionary (JDD) or JDrug.</p>
    </div>
  </div>
</div>



For more information about coding _Products_ that are not included in the WHODrug dictionary, see <a href="/en/lr/01162/">Auto-Code and Browse Products</a>.

### Prerequisites
To auto-code WHODrug products, your Admin must <a href="/en/lr/1007670/">enable WHODrug External Product Auto-Coding</a>.

To cross reference WHODrug codes to IDF or Korea Drug Dictionary codes, or to search for WHODrug codes in Chinese, your Admin must enable the applicable tool:

* <a href="/en/lr/782230/">WHODrug Cross Reference Tool (CRT) Japan</a>
* <a href="/en/lr/866963/">WHODrug Link Korea</a>
* <a href="/en/lr/1005234/">WHODrug Global Chinese Browser</a>

## Code a WHODrug Product

You can code products with the WHODrug dictionary in the following ways:

* When creating an _External Product_, if the _Product (Reported)_ value matches a WHODrug dictionary term, Vault [auto-codes][5] the WHODrug product.
* When creating a _Case Product_, <a href="/en/lr/01162/#product-browsing">access the _Product Browser_</a>. In the browser, select **Launch WHODrug** to launch the _WHODrug Search_ browser.
  * When coding an _External Product_, if the _Product (Reported)_ or _Country Obtained_ field is populated, results are filtered to those values. For global _Cases_, the _Product (Reported)_ term appears below the _Search_ bar. For _Domestic Cases_, the _Product (Reported)_ English term appears below the _Search_ bar.
  * You can select **Back to Product Coding Browser** in the window to open the _Product Browser_ to code a _Company Product_.
* In the <a href="/en/lr/01287/#drug-history">_Drug History_ section</a> of a _Case_, select **Create**. On the _Create Case Drug History_ page, beside the _WHODrug_ field, select **Search WHODrug**.
  * When coding _Drug History_, if the _Drug Name (Reported)_ is populated, results are filtered to that value.
* When creating <a href="/en/lr/917562/#products-section">_External Products_</a> for a domestic _Case_ for Japan, Korea, or China and foreign _Localized Cases_ reportable to the PMDA, MFDS, or NMPA, populate the _WHODrug_ or applicable _JDrug_, _Korea Drug_, or _WHODrug Chinese_ field. If your Admin has configured [WHODrug cross-referencing][1] with the corresponding dictionary and Vault finds a match, Vault populates the applicable field with the matching code.

## Auto-Code WHODrug Products {#auto-code}
Vault attempts to auto-code <a href="/en/lr/917562/#products-section">_External Products_</a> using the WHODrug dictionary when: 
* Vault creates a new _External Product_ as a result of running:
    * The <a href="/en/lr/01141/#case-promotion">_Promote to Case_ action on an _Inbox Item_</a>
    * The <a href="/en/lr/826980/#complete">_Merge to Current_ or _Create Follow-Up_ action</a> on the _Inbox Item to Case Compare_ page
* You select **Auto-code** under the _WHODrug_ field on an _External Product_

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: Any auto-coding results are suggestions only and should be reviewed.</p>
    </div>
  </div>
</div>



Vault uses the _Product (Reported)_ value and _Country Obtained_ value<sup><a href="#whodrug-country">1</a></sup> on the _External Product_ to search the WHODrug dictionary for a product match. If a match is found, Vault:
* Maps the product data to the _WHODrug_ field
* Populates product data in the following fields on the _External Product_:
    * _Product (Coded)_
    * _Registration Country_
    * _Registration Holder/Applicant_
    * _UMC MPID_
    * _IDMP MPID_

<a id="whodrug-country"></a>
<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: 1. If an <em>External Product</em> does not have a <em>Country Obtained</em> value, Vault determines the country to use for searching WHODrug using the following priority order:</p>
<ol>
  <li>The <em>Event Country</em> on the <em>Case Adverse Event</em></li>
  <li>The <em>Country</em> on the <em>Reporter</em>-type <em>Case Contact</em></li>
</ol>
    </div>
  </div>
</div>



Depending on your Admin's configuration, when coding an _External Product_ on a domestic _Case_ for Japan, Korea, or China, Vault may attempt to [cross-reference the WHODrug code][1] to populate the applicable field.

Upon saving the _External Product_, Vault maps the substance details to the _Case Product_. When the selected product has [multiple substances][4], Vault creates _Substances_ for each value in the _Preferred Name_ [column][3], to a limit of 1,500 characters based on the cumulative number of characters across all _Substance_ names.

If the autocode results require correction, you can use the [_WHODrug Search_ browser][2] to search and code a different product. 

## Using the WHODrug Search Browser {#whodrug-browser}

You can use the _WHODrug Search_ browser to search and code products in the following ways:

* In the search bar, enter or change the search terms, and then select the search (<img class="inline" src="https://platform.veevavault.help/assets/images/saf-execute-search.png" alt="search button" style="" />) icon. Search runs once you enter two or more characters, and returns results based on exact spelling.
* To filter the search results, in the search bar you can enter the following:
    * To filter by country, enter `country:{code}`, where `{code}` is the ISO three-letter country code. For example, `Cholecap country:USA`.
    * To filter by generic drugs only, enter `generic:y`. For example, `Cholecap generic:y`.
* To broaden the search results, select one or more of the following **Search Columns**:
    * **Preferred Name**: Generic names for the product substance
    * **Drug Name**: Drug trade names
    * **Name Specifier**: Product name differentiators, such as "For Children" or "Sustained Release"
    * **UMC MPID**: UMC Medicinal Product Identifiers (MPIDs)
    * **Drug Code**: Alphanumeric drug codes
* To select a WHODrug code, select the corresponding **Code** button.
* To toggle to the <a href="/en/lr/1005238/">_WHODrug Chinese Search_ browser</a>, select the **All Actions** menu, then select **Chinese**.

When you save the _Case Product_, Vault adds the selected WHODrug product and substance details to the _Case_. When a _Case Product_ has [multiple substances][4], Vault creates _Substances_ for each value in the _Preferred Name_ [column][3]. Vault generates _Substances_ to a limit of 1,500 characters based on the cumulative number of characters across all _Substance_ names. 

To remove the details, select **Clear Selection**. When you clear an _External Product_, Vault deletes all _Substances_ from the _External Product_ after saving.

 <div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: To clear all selections from the <em>WHODrug</em> field on a <em>Case Drug History</em> or <em>Localized Case Drug History</em>, you must have the <a href="/en/lr/827542/#grant-object-permissions">correct <em>Read</em> and <em>Edit</em> permissions</a>.</p>
    </div>
  </div>
</div>



### WHODrug Search Columns {#search-columns}

When searching for products in the _WHODrug Search_ browser, Vault displays the following columns: 

* **Code Options**: Select the **Code** button to apply a product from the WHODrug dictionary.
* <a id="preferred-name"></a>**Preferred Name**: The generic names for the active product substance or substance combination. Some products may display multiple values separated by semicolons (;) in the _Preferred Name_ column. The first value is the product's preferred name, and all subsequent values are the product's substances.
* **Drug Name**: The brand name under which the product is sold.
* **Name Specifier**: The product name differentiators, such as "For Children" or "Sustained Release".
* **Pharmaceutical Strength**: The strength of the active substance.
* **Pharmaceutical Form**: The pharmaceutical form in which the product is sold.
* **Country**: The country where the product is marketed.
* **Country Code**: The ISO three-letter country code.
* **MAH**: The Marketing Authorization Holder (MAH) in the country of sale.
* **ATC1**: The Anatomical Therapeutic Chemical Classification System level one code and a description of the anatomical group.
* **ATC2**: The Anatomical Therapeutic Chemical Classification System level two code and a description of the therapeutic subgroup.
* **ATC3**: The Anatomical Therapeutic Chemical Classification System level three code and a description of the therapeutic or pharmacological subgroup.
* **ATC4**: The Anatomical Therapeutic Chemical Classification System level four code and a description of the chemical, therapeutic, or pharmacological subgroup.
* **UMC MPID**: The UMC Medicinal Product Identifier (MPID) for the product.
* **IDMP MPID**: The Identification of Medical Products (IDMP) MPID for the product.
* **Drug Code**: The unique identification code for the drug name and active substances.
* **Generic**: Whether the product is a generic product.
* **Preferred**: Whether the product is a preferred brand-name drug.

### WHODrug Cross-Referencing {#cross-reference}

When coding <a href="/en/lr/917562/#products-section">_External Products_</a> on domestic _Cases_ for Japan, Korea, or China and foreign _Localized Cases_ reportable to the PMDA, MFDS, or NMPA, Vault supports cross-referencing WHODrug codes as applicable. When configured by your Admin, Vault does the following:

* **JDrug**: You can populate this field using the <a href="/en/lr/01163/">Iyakuhinmei Data File (IDF)</a>. If Vault finds a match to the code you select for this field, it attempts to find a matching WHODrug UMC MPID code using WHODrug CRT Japan mapping.
* **Korea Drug**: You can populate this field using the <a href="/en/lr/827540/">Korea Drug Dictionary</a>. If Vault finds a match to the code you select for this field, it attempts to find a matching WHODrug UMC MPID code using WHODrug Link Korea mapping.
* **WHODrug**: You can populate this field using the [_WHODrug Search_ browser][2]. If Vault finds a match to the code you select for this field, it attempts to find a matching WHODrug UMC MPID code using the applicable WHODrug CRT Japan or WHODrug Link Korea mapping.
* **WHODrug Chinese**: You can populate this field with Chinese WHODrug data using the <a href="/en/lr/1005238/">_WHODrug Chinese Search_ browser</a>. If Vault finds a match to the code you select for this field, it uses the WHODrug UMC MPID code to populate the matching English WHODrug data.

When Vault attempts to populate a cross-referenced field, it displays a message below the field describing the result of the cross-reference. If you select **Clear Selection**, Vault removes the codes from both fields. If Vault finds no match or multiple matches, it leaves the corresponding field blank. When processing global _Cases_ with PMDA, MFDS, or NMPA reporting requirements, Vault applies updates to _Localized Case Products_ after _Transmission_ generation.

## Fields that Support WHODrug Coding

You can use a WHODrug code to populate information on a _Case_ for _External Products_ and _Drug Histories_.

### External Product

In the _Details_ section of an _External Product_, code the WHODrug product details. When you add a WHODrug code, Vault populates the following _Registration_ fields with data from the _WHODrug Search_ browser, when available:

* **Strength**: Based on the _Pharmaceutical Strength_ column value
* **Product (Coded)**: Based on the _Drug Name_ and _Preferred Name_ column values, populated in the format _Drug Name (Preferred Name)_
* **Registration Country**: Based on the _Country_ column value
* **Registration Holder/Applicant**: Based on the _MAH_ column value
* **MPID**: Based on the _UMC MPID_ column value
* **IDMP MPID**: Based on the _IDMP MPID_ column value
* **MPID Version**: Based on your Vault's <a href="/en/lr/01190/#whodrug-versions">active WHODrug dictionary version</a>

When a coded product includes [at least one _Preferred Name_ value][4], Vault generates a _Substance_ for each value and populates the following fields with data from the _WHODrug Search_ browser, when available:

* **Strength**: Based on the _Pharmaceutical Strength_ column value
* **Substance Name**: Based on the _Drug Name_ column value
* **Case Product**: Based on the _Preferred Name_ column value and linked to the _External Product_
* **TermID**: Based on the Chemical Abstract Service (CAS) number that corresponds to the _Substance Name_
* **TermID Version**: Based on your Vault's <a href="/en/lr/01190/#whodrug-versions">active WHODrug dictionary version</a>

### Drug History

In the _Details_ section of a _Case Drug History_, code the WHODrug product details. When you add a WHODrug code, Vault populates the following _Registration_ fields, when available:

* Pharmaceutical Strength, Drug Name (Preferred Name)
* MPID
* IDMP MPID
* MPID Version

[1]: #cross-reference
[2]: #whodrug-browser
[3]: #search-columns
[4]: #preferred-name
[5]: #auto-code