Skip Navigation Bar

Creating Value Sets


How to Create, Save, and Edit Value Sets

The following tutorial supports any Authors who need to create value sets as well as the measure developers and value set developers for the annual updates of the electronic Clinical Quality Measure (eCQM) value sets. This tutorial is useful for other purposes as well, beyond the eCQM value set annual updates.

Before you can create value sets, you need VSAC Authoring Permissions.
Author Registration link at upper right corner of VSAC Home Page

It is helpful to understand the the roles of value set authors and stewards. It is also helpful to review the VSAC Authoring Best Practices.

Menu Options to Create an Extensional Value Set

  1. Once you obtain authoring permissions, sign into VSAC with your UMLS account.
  2. Select the Authoring tab.
  3. Once you select the Authoring tab, you will see a secondary tab named Value Sets .
  4. To create an extensional value set, select the Create a Value Set button.
  5. Notice the quick tool tip provided when you mouseover the question mark by the Create a Value Set button.

A tab entitled, New Value Set, appears. Under that tab, there are three sub tabs: Metadata, Definition, and Expansion/Publication. You will need to complete the information in each sub tab sequentially:
a. the Metadata sub tab
b. the Definition sub tab
c. the Expansion/Publication sub tab
Three tabs under new value set

Menu Options to Create a Grouping Value Set

1. Once you obtain authoring permissions, sign into VSAC with your UMLS account.
2. Select the Authoring tab.
3. Once you select the Authoring tab, you will see a secondary tab named Value Sets .
4. To create a grouping value set , select the Group Existing Value Sets button.
5. Notice the quick tool tip provided when you mouseover the question mark by the Group Existing Value Sets button.

A tab entitled, New Value Set appears. Under that tab, there are three sub tabs: Metadata, Definition, and Expansion/Publication. You will need to complete the information in each sub tab sequentially:
a. the Metadata sub tab
b. the Definition sub tab
c. the Expansion/Publication sub tab
Three tabs in definition sub tab under new value set

For instructional purposes, the process is illustrated with an extensional value set; however, the process is the same for adding metadata to a grouping value set.
Use the automated option to generate an OID

1. Object Identifier (OID) Assignment:
a. Default: We recommend the default setting (indicated by a checkmark) in which VSAC automatically generates an OID for your value set once you have entered the information under #2 and #3, and then select the save button.
Entering OID manually

b. Manual: If you did not select to have the system automatically generate an OID after you press the Save button, and you want to enter your own OID, please follow these instructions. The only case in which you should manually enter your own OID is when you have an established pre-existing OID that you have published in another context external to VSAC and the OID is already used by the community, and the value set you create will have the same content and purpose of the pre-existing OID. To manually enter your pre-existing OID, uncheck the Auto Generate box under the OID field, and follow the instructions in the tool tip to correctly enter your OID before selecting the Save button.
If you need to enter an OID manually, the following rules apply:
  • OID Format
  • OID Consists of all digits [1-9] or 0 if a single digit number, but no leading zeros if multiple digit number
  • Numbers may be separated by dots
  • NLM OID name space: Any OID entered MUST NOT start with 2.16.840.1.113 762.1.4* except OIDs designated in White List.
Completing the metadata fields

2. Under the Metadata sub tab, complete the mandatory fields of Name, Author, and Steward fields.
3. Complete the Note and Purpose fields to provide users adequate information about the value set. Follow VSAC Authoring Best Practices to write your purpose statements.
4. Select the Save button to save your metadata.
Saving metadata and OID appears

5. Once you select Save, the assigned OID for your value set will display.

Information under definition tab

1. After you have signed into VSAC, under the Authoring tab, select the Definition sub tab to define your value set.
2. The definition version status is “Draft” until your steward (or you, if you are your own steward) has approved your value set.
3. Select the code system you would like to use in your value set. Notice that VSAC defaults to the most current code system version; however, you may select previous code system versions if needed. Code system version is for authoring display purposes only. This will not be the code system version applied at expansion/publication time. The code system version used for expansion/publication is either the most recent code system version in VSAC, or you may predefine your code system version either in the Expansion/Publication tab or in your Program Release submission if applicable.
Adding Value Sets in the Define Tab

4. Next, you will need to search the code system for the codes that you will want to include in your value set. Enter a code or term into the query box and select ‘Search’.
5. Once you review your search results, select the codes that you would like to insert into your value set by clicking in the box next to the value set code, and a checkmark will appear.
6. Once you have selected all the codes, select Add to Value Set above the code column.
7. The codes that you selected to add to your value set now appear on the left side of the screen under Value Set Code List.
8. Save the value set defintion.
Saving Value Set Defintion

9. If you need to make changes to your value set, you may edit the value set as long as it is in draft status, and it was not previously published.
Edit Value Set Defintion


Submit Value Set

10. If you do not need to edit your value set or you have finished editing your value set, you are ready to submit the value set to the steward to approve or reject.
Value Set Definition is Ready to Publish status

11. Once the steward approves your proposed value set, and your value set is in ready to publish status you are ready to proceed to the next phase, Expand/Publish your value set.
Defintion tab of a Grouping Value Set

1. After you have completed the metadata for your value set, proceed to the Definition sub tab to define your value set.
2. The definition version status is “Draft” until your steward (or you, if you are your own steward) has Approved your value set.
3. On the right side, you will notice a tab entitled, “Value Sets”, search for the value sets that you would like to be in your grouping value set.
Add value sets to Grouping Value Set Defintion

4. Once you review your search results, select the value sets that you would like to insert into your grouping value set by clicking in the box next to the value set name, and a checkmark will appear.
5. Once you have elected all the codes, select Add to Value Set above the code column.
Save Value Set Grouping Value Set Defintion

6. Save the value set.
Edit the Value Set Grouping Value Set Defintion

If you need to make changes to your value set, you may edit the value set as long as it is in draft status, and was not previously published.
Submit Grouping Value Set Defintion

If you do not need to edit your value set or you have finished editing your value set, you are ready to submit the value set to the steward to approve or reject.
Value Set Defintion is Ready to Publish Status

Once the steward approves your proposed value set, and your value set is in ready to publish status you are ready to proceed to the next phase, Expand/Publish your value set.
For instructional purposes, the process is illustrated with an extensional value set; however, the process to expand/publish the value set is the same for a grouping value set.
Expansion/Publication Tab
Proceed to the Expansion/Publication sub tab after your value set has been approved by the Steward, and is at Ready to Publish status. The next step is to publish the value set in the public repository. Select the Expansion/Publication button if you want VSAC to use the default (the latest published definition) expansion/publication date and expansion calculation settings. Your value set will be published in the public repository (the Search Value Sets tab) after 12:01 A.M the following day.
Expansion/Publication Options
If you want a different publication date, or a different expansion profile for a specific code system versions, change those settings before you select the Expansion/Publication button. Then, select the Expansion/Publication button.