> For the complete documentation index, see [llms.txt](https://docs.rhinofcp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rhinofcp.com/data-harmonization/creating-editing-and-removing-a-custom-vocabulary.md).

# Creating, Editing, and Removing a Custom Vocabulary

## Creating a Custom Vocabulary

This topic explains how to create a custom vocabulary. Custom vocabularies can be created when you do not want to use a standard vocabulary (for example, the target vocabulary is not covered by OMOP). After you’ve created the custom vocabulary, you can use the instructions in *Creating a Semantic Mapping* to map field values in a dataset to terms in the custom vocabulary you have created.

Your custom vocabulary can contain up to 1 million entries.

### Prerequisites

* You must have the Manage Data Mappings permission.

### Opening the Custom Vocabularies Page

To open the **Custom Vocabularies** page, complete the following steps.

1. Select **Data Mappings** from the Main Menu. The **Data Mappings** page appears.
2. Select the **Custom Vocabularies** link. The **Custom Vocabularies** page appears. To search for a custom mapping, use the Search Custom Map text box located at the top right corner of the page.

![](/files/45f690e6ab6f3da6bb920e4d250f0c08c6dbc8a2)

The table below defines each field in this page.

|                        |                                                                                                                                               |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| **Field**              | **Description**                                                                                                                               |
| Custom Vocabulary Name | Name of the custom vocabulary name, such as “Encounters” or “Billing Codes”.                                                                  |
| Version                | Version of the custom vocabulary. This increments each time you make a change to the custom vocabulary.                                       |
| Date Created           | Date the mapping was created.                                                                                                                 |
| # of Terms             | Number of terms for this custom vocabulary.                                                                                                   |
| Creator                | Name of the person who created the mapping.                                                                                                   |
| Three-Dot Menu         | The three-dot menu (also known as the “context menu”) provides access to additional options: Copy UID, Show Configuration, Remove Vocabulary. |

## Creating a Custom Vocabulary Steps

{% stepper %}
{% step %}
In the **Data Mapping > Custom Vocabularies** page, click **Create Custom Vocabulary**.
{% endstep %}

{% step %}
The **Create Custom Vocabulary** page appears.

![](/files/6a3084e6e15e86d26bb2312b7166724f62a58db1)
{% endstep %}

{% step %}
Enter a name for your vocabulary and optionally add a description.
{% endstep %}

{% step %}
You can either manually enter terms for your vocabulary or upload a file that contains the terms. Note that there are two supported formats for the terms that you enter (or upload).

* **Codes and Terms:** if you have terms that have specific codes (e.g. "C01" for "Approved" and "C02" for "Denied"), enter the codes and the terms in CSV format or manually, with a comma separating between the code and the term. Each term should be entered on a different line. For example:

  ```auto
  C01,Approved
  C02,Denied
  ```
* **Terms-only (without codes)**: If you have terms that don't have special codes, then you can enter each term on a separate line. For example:

  ```auto
  Approved
  Denied
  ```

{% hint style="info" %}
In both cases, any commas in your term display text should be escaped using a slash (\\).\
Do not include a header row.
{% endhint %}

**Uploading a file**

* Select Upload File button on the Create Custom Vocabulary page.
* Upload a comma delimited (CSV) file from your device by clicking the Upload File button. Do not include a header row. Each term should be entered on a different line. If you have terms with specific codes, separate them with commas.
  {% endstep %}

{% step %}
When complete, click **Create Custom Vocabulary**. The page closes and the custom vocabulary page is displayed, with an entry for the vocabulary that you just created.
{% endstep %}
{% endstepper %}

### Next Steps

Once you have created a custom vocabulary, see the [*Creating a Semantic Mapping*](/data-harmonization/creating-reviewing-editing-and-removing-a-semantic-mapping.md) page to create a mapping of dataset field values to the entries in your vocabulary.

### Related Topics

* [About the RhinoDHE](/data-harmonization/about-the-rhino-data-harmonization-engine-rhinodhe.md)
* [Creating a Semantic Mapping](/data-harmonization/creating-reviewing-editing-and-removing-a-semantic-mapping.md)
* [Removing a Custom Vocabulary](/data-harmonization/creating-editing-and-removing-a-custom-vocabulary.md)

## Editing a Custom Vocabulary

To edit a custom vocabulary, you will need to remove it, then create it again with the updated terms.

### Prerequisites

* A custom vocabulary must have already been created.
* You must have Manage Data Mappings permission.

### Opening the Custom Vocabulary Page

To open the **Custom Vocabularies** page, complete the following steps.

1. Select **Data Mappings** from the Main Menu. The **Data Mappings** page appears.
2. Select the **Custom Vocabularies** link. The **Custom Vocabularies** page appears. To search for a custom mapping, use the Search Custom Map text box located at the top right corner of the page.

![](/files/bb0a637e57824e33c30f16faee4fd625d36f66d0)

The table below defines each field in this page.

| Field                  | Description                                                                                                                                   |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Custom Vocabulary Name | Name of the custom vocabulary name, such as “Encounters” or “Billing Codes”.                                                                  |
| Version                | Version of the custom vocabulary. This increments each time you make a change to the custom vocabulary.                                       |
| Date Created           | Date the mapping was created.                                                                                                                 |
| # of Terms             | Number of terms for this custom vocabulary.                                                                                                   |
| Creator                | Name of the person who created the mapping.                                                                                                   |
| Three-Dot Menu         | The three-dot menu (also known as the “context menu”) provides access to additional options: Copy UID, Show Configuration, Remove Vocabulary. |

### Editing a Custom Vocabulary

To edit a custom vocabulary, you will need to remove it, then create it again. Here is how you'll do this.

### Removing a Custom Vocabulary

To remove a custom vocabulary, complete the following steps.

1. In the **Data Mappings > Custom Vocabularies** page locate the custom vocabulary you want to remove.
2. Click the three-dot (meatball) menu at the end of the entry and select **Remove Custom Vocabulary**.
3. When prompted about removing the vocabulary, select **Yes**.
4. The vocabulary is removed.

After removing a custom vocabulary, and Semantic Mappings associated with this vocabulary will be removed.

### Related Topics

* [About the Rhino Data Harmonization Engine (RhinoDHE)](/data-harmonization/about-the-rhino-data-harmonization-engine-rhinodhe.md)
* [Creating a Custom Vocabulary](/data-harmonization/creating-editing-and-removing-a-custom-vocabulary.md)
* [Removing a Custom Vocabulary](/data-harmonization/creating-editing-and-removing-a-custom-vocabulary.md)

## Removing a Custom Vocabulary

This article explains how to remove a custom vocabulary.

### Prerequisites

* A custom vocabulary must have already been created.
* You must have Manage Data Mappings permission.

{% hint style="warning" %}
You cannot remove a custom vocabulary while semantic mapping recommendations are being generated.
{% endhint %}

### Opening the Custom Vocabulary Page

To open the **Custom Vocabularies** page, complete the following steps.

1. Select **Data Mappings** from the Main Menu. The **Data Mappings** page appears.
2. Select the **Custom Vocabularies** link. The **Custom Vocabularies** page appears. To search for a custom mapping, use the Search Custom Map text box located at the top right corner of the page.

![](/files/190182c0e6737a726d8a72079bd65536f7b4497a)

The table below defines each field in this page.

| Field                  | Description                                                                                                                                   |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Custom Vocabulary Name | Name of the custom vocabulary name, such as “Encounters” or “Billing Codes”.                                                                  |
| Version                | Version of the custom vocabulary. This increments each time you make a change to the custom vocabulary.                                       |
| Date Created           | Date the mapping was created.                                                                                                                 |
| # of Terms             | Number of terms for this custom vocabulary.                                                                                                   |
| Creator                | Name of the person who created the mapping.                                                                                                   |
| Three-Dot Menu         | The three-dot menu (also known as the “context menu”) provides access to additional options: Copy UID, Show Configuration, Remove Vocabulary. |

### Removing a Custom Vocabulary (Step)

To remove a custom vocabulary, complete the following steps.

1. In the **Data Mappings > Custom Vocabularies** page locate the custom vocabulary you want to remove.
2. Click the three-dot (meatball) menu at the end of the entry and select **Remove Custom Vocabulary**.
3. When prompted about removing the vocabulary, select **Yes**.
4. The vocabulary is removed.

## Related Topics

* [About the Rhino Data Harmonization Engine (RhinoDHE)](/data-harmonization/about-the-rhino-data-harmonization-engine-rhinodhe.md)
* [Creating a Custom Vocabulary](/data-harmonization/creating-editing-and-removing-a-custom-vocabulary.md)