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.
What You'll Learn
In this topic you learn about:
Opening the Custom Vocabularies Page
To open the Custom Vocabularies page, complete the following steps.
- Select Data Mappings from the Main Menu. The Data Mappings page appears.
- 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.
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
To create a custom vocabulary, complete the following steps.
- In the Data Mapping > Custom Vocabularies page, click Create Custom Vocabulary.
- The Create Custom Vocabulary page appears.
- Enter a name for your vocabulary and optionally add a description.
-
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:
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:
Approved Denied
NOTE: In both cases, any commas in your term display text should be escaped using a slash (\).
Do not include a header row.
-
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.
- 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.
Next Steps
Once you have created a custom vocabulary, see the Creating a Semantic Mapping page to create a mapping of dataset field values to the entries in your vocabulary.