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.
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.
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.
- Paste in or manually enter the terms for your vocabulary - each term on a different line.
There are two supported formats:-
Identifiers and Terms: if you have terms that have specific codes or identifiers (e.g. "C01" for "Approved" and "C02" for "Denied") then you can enter the identifiers and the terms in CSV format, with a comma separating between the identifier and the term. For example:
C01,Approved C02,Denied
- Terms-only (without identifiers): If you have terms that don't have special codes or identifiers, 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 (\).
-
Identifiers and Terms: if you have terms that have specific codes or identifiers (e.g. "C01" for "Approved" and "C02" for "Denied") then you can enter the identifiers and the terms in CSV format, with a comma separating between the identifier and the term. For example:
- 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.