Custom Vocabularies
Overview
A custom vocabulary is a user-defined set of standardized terms or concepts that can be used as mapping targets when an existing standard vocabulary, such as those provided by OMOP, does not meet your needs.
For example, if your organization uses its own classification system for procedures, you can create a custom vocabulary containing those terms and then use Semantic Mapping to map values from your source datasets to the appropriate custom terms.
Your custom vocabulary can contain up to 1 million entries.
Accessing Custom Vocabularies
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 tab. 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.
Status
Status of the Custom Vocabulary
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 New Custom Vocabulary
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:
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:
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.
Editing a Custom Vocabulary
Prerequisites
You must have the "Manage Data Mappings" permission.
A custom vocabulary must have already been created.
Steps
To edit an existing custom vocabulary, you will need to remove it, then create it again with the updated terms.
Removing a Custom Vocabulary
Prerequisites
You must have the "Manage Data Mappings" permission.
A custom vocabulary must have already been created.
You cannot remove a custom vocabulary while semantic mapping recommendations are being generated.
Steps
In the Data Mappings > Custom Vocabularies page locate the custom vocabulary you want to remove.
Click the three-dot (meatball) menu at the end of the entry and select Remove Custom Vocabulary.
When prompted about removing the vocabulary, select Yes.
The vocabulary is removed.
Last updated
Was this helpful?