1784 lines
69 KiB
HTML
1784 lines
69 KiB
HTML
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
|
||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@100;300;400;500;700&display=swap" rel="stylesheet">
|
||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.10/css/all.css" integrity="sha384-+d0P83n9kaQMCwj8F4RJB66tzIwOKmrdb46+porD/OvrJ+37WqIM7UoBtwHO6Nlg" crossorigin="anonymous">
|
||
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" title="The Dublin Core metadata Element Set" />
|
||
|
||
<script src="https://assets.nlm.nih.gov/uswds/js/uswds-init.min.js"></script>
|
||
<link rel="stylesheet" href="/home_assets/uswds/css/styles.css">
|
||
|
||
<title>Create Value Sets</title>
|
||
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" title="The Dublin Core metadata Element Set" />
|
||
<meta name="DC.Title" content="Create Value Sets" />
|
||
|
||
<meta name="DC.Subject.Keyword" content="vsac, value sets, create value set, authoring" />
|
||
<meta name="DC.Publisher" content="U.S. National Library of Medicine" />
|
||
<meta name="DC.Date.Issued" content="2017-09-29" />
|
||
<meta name="DC.Date.Modified" content="2024-02-09" />
|
||
<meta name="NLMDC.Date.LastReviewed" content="2024-02-09" />
|
||
<meta name="NLM.Contact.Email" content="nlmumlscustserv@mail.nlm.nih.gov" />
|
||
<meta name="DC.Type" content="Technical Documentation" />
|
||
<meta name="DC.Rights" content="Public Domain" />
|
||
<meta name="DC.Language" content="eng" />
|
||
|
||
<!-- Google Tag Manager --><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push(
|
||
{'gtm.start': new Date().getTime(),event:'gtm.js'}
|
||
);var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-MT6MLL');</script>
|
||
<!-- End Google Tag Manager -->
|
||
</head>
|
||
<body>
|
||
<!-- Google Tag Manager -->
|
||
<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-MT6MLL" height="0" width="0" style="display:none;visibility:hidden" title="googletagmanager"></iframe></noscript>
|
||
<!-- End Google Tag Manager -->
|
||
<!-- TOP NAV -->
|
||
<a class="usa-skipnav" href="#main">Skip to main content</a>
|
||
<div class="usa-banner site-banner" aria-label="Official government website">
|
||
<div class="usa-accordion">
|
||
<header class="usa-banner__header">
|
||
<div class="usa-banner__inner">
|
||
<div class="grid-col-auto"> <img class="usa-banner__header-flag" src="https://assets.nlm.nih.gov/uswds/img/us_flag_small.png" alt="U.S. flag"/> </div>
|
||
<div class="grid-col-fill tablet:grid-col-auto">
|
||
<p class="usa-banner__header-text"> An official website of the United States government </p>
|
||
<p class="usa-banner__header-action" aria-hidden="true"> Here’s how you know </p>
|
||
</div>
|
||
<button class="usa-accordion__button usa-banner__button" aria-expanded="false" aria-controls="gov-banner"> <span class="usa-banner__button-text">Here’s how you know</span> </button>
|
||
</div>
|
||
</header>
|
||
<div class="usa-banner__content usa-accordion__content" id="gov-banner">
|
||
<div class="grid-row grid-gap-lg">
|
||
<div class="usa-banner__guidance tablet:grid-col-6"> <img class="usa-banner__icon usa-media-block__img" src="https://assets.nlm.nih.gov/uswds/img/icon-dot-gov.svg" role="img" alt="" aria-hidden="true"/>
|
||
<div class="usa-media-block__body">
|
||
<p> <strong> Official websites use .gov </strong> <br />
|
||
A <strong>.gov</strong> website belongs to an official government
|
||
organization in the United States. </p>
|
||
</div>
|
||
</div>
|
||
<div class="usa-banner__guidance tablet:grid-col-6"> <img class="usa-banner__icon usa-media-block__img" src="https://assets.nlm.nih.gov/uswds/img/icon-https.svg" role="img" alt="" aria-hidden="true"/>
|
||
<div class="usa-media-block__body">
|
||
<p> <strong> Secure .gov websites use HTTPS </strong> <br />
|
||
A <strong>lock</strong> ( <span class="icon-lock">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="52" height="64" viewBox="0 0 52 64" class="usa-banner__lock-image" role="img" aria-labelledby="banner-lock-title-default banner-lock-description-default" focusable="false">
|
||
<title id="banner-lock-title-default">Lock</title>
|
||
<desc id="banner-lock-description-default">A locked padlock</desc>
|
||
<path fill="#000000" fill-rule="evenodd" d="M26 0c10.493 0 19 8.507 19 19v9h3a4 4 0 0 1 4 4v28a4 4 0 0 1-4 4H4a4 4 0 0 1-4-4V32a4 4 0 0 1 4-4h3v-9C7 8.507 15.507 0 26 0zm0 8c-5.979 0-10.843 4.77-10.996 10.712L15 19v9h22v-9c0-6.075-4.925-11-11-11z"/>
|
||
</svg>
|
||
</span> ) or <strong>https://</strong> means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites. </p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- HEADER -->
|
||
<header id="siteheader" class="usa-header usa-header--basic">
|
||
<div class="usa-nav-container tablet:padding-x-4 mobile-lg:padding-x-2 padding-y-1">
|
||
<div class="grid-row padding-y-105">
|
||
<div class="grid-col-8 desktop:grid-col-4 tablet-lg:grid-col-4 tablet:grid-col-6"> <a href="https://www.nlm.nih.gov/"> <img src="https://assets.nlm.nih.gov/uswds/img/NLM_White.png" alt="NLM logo" class="logo margin-top-1"> </a> </div>
|
||
<div class="desktop:grid-col-4 desktop:grid-offset-4 tablet-lg:grid-col-6 tablet-lg:grid-offset-2 tablet:grid-col-6 grid-col-12">
|
||
<form class="usa-search desktop:margin-top-2 tablet:margin-top-2 mobile:margin-top-1" role="search" data-gtm-form-interact-id="0" method="get" action="//vsearch.nlm.nih.gov/vivisimo/cgi-bin/query-meta" target="_self" name="searchForm" id="searchForm2">
|
||
<input class="usa-input ui-autocomplete-input" aria-label="Search" type="search" name="query" data-gtm-form-interact-field-id="0" id="search2" autocomplete="off" placeholder="Search NLM" >
|
||
<input type="hidden" name="v:project" value="nlm-main-website">
|
||
<button class="usa-button border border-top border-bottom border-right border-white" role="button" aria-label="Search" type="submit"> <span class="usa-search__submit-text"> <i class="fas fa-search"></i> </span> </button>
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="bg-secondary insertCOOP">
|
||
<div class="usa-nav-container">
|
||
<div class="usa-navbar ">
|
||
<button class="usa-menu-btn">Menu</button>
|
||
</div>
|
||
<nav aria-label="Primary navigation" class="usa-nav">
|
||
<button class="usa-nav__close"><img src="https://assets.nlm.nih.gov/uswds/img/close.svg" alt="close"></button>
|
||
<ul class="usa-nav__primary usa-accordion insertNav">
|
||
|
||
<li class="usa-nav__primary-item desktop-lg:margin-x-5 desktop:margin-x-3 tablet:margin-x-0">
|
||
<button type="button" class="usa-accordion__button usa-nav__link usa-current" aria-expanded="false" aria-controls="basic-nav-section-one"> <span>Products and Services <i class="fas fa-caret-down margin-left-05"></i> </span> </button>
|
||
<ul id="basic-nav-section-one" class="usa-nav__submenu bg-secondary" hidden="">
|
||
<li class="usa-nav__submenu-item"> <a href="//eresources.nlm.nih.gov/nlm_eresources/"><span>All Products and Services</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//clinicaltrials.gov/"><span>ClinicalTrials.gov</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//collections.nlm.nih.gov/"><span>Digital Collections</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//catalog.nlm.nih.gov"><span>LocatorPlus Catalog</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//meshb.nlm.nih.gov/search"><span>Medical Subject Headings (MeSH)</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//medlineplus.gov/"><span>MedlinePlus</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//pubmed.ncbi.nlm.nih.gov/"><span>PubMed/MEDLINE</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//uts.nlm.nih.gov/uts/"><span>Unified Medical Language System (UMLS)</span></a> </li>
|
||
</ul>
|
||
</li>
|
||
<li class="usa-nav__primary-item desktop-lg:margin-x-5 desktop:margin-x-3 tablet:margin-x-0">
|
||
<button type="button" class="usa-accordion__button usa-nav__link usa-current" aria-expanded="false" aria-controls="basic-nav-section-two"> <span> Resources for You <i class="fas fa-caret-down margin-left-05"></i></span> </button>
|
||
<ul id="basic-nav-section-two" class="usa-nav__submenu bg-secondary" hidden="">
|
||
<li class="usa-nav__submenu-item"> <a href="/portals/researchers.html"><span>For Researchers</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/portals/publishers.html "><span>For Publishers</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/portals/librarians.html"><span>For Librarians</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/training.html "><span>For Educators/Trainers </span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/portals/healthcare.html"><span>For Health care Professionals</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/portals/public.html "><span>For the Public</span></a> </li>
|
||
</ul>
|
||
</li>
|
||
<li class="usa-nav__primary-item desktop-lg:margin-x-5 desktop:margin-x-3 tablet:margin-x-0">
|
||
<button type="button" class="usa-accordion__button usa-nav__link usa-current" aria-expanded="false" aria-controls="basic-nav-section-three"> <span>Explore NLM <i class="fas fa-caret-down margin-left-05"></i> </span> </button>
|
||
<ul id="basic-nav-section-three" class="usa-nav__submenu bg-secondary" hidden="">
|
||
<li class="usa-nav__submenu-item"> <a href="/about/index.html"><span>About the Library</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/about/visitor.html"><span>Visit the Library</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/hmd/index.html"><span>History of Medicine</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/about/org.html"><span>NLM by Organization</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/news/newsandevents.html"><span>News, Events, and Updates</span></a> </li>
|
||
</ul>
|
||
</li>
|
||
<li class="usa-nav__primary-item desktop-lg:margin-x-5 desktop:margin-x-3 tablet:margin-x-0">
|
||
<button type="button" class="usa-accordion__button usa-nav__link usa-current" aria-expanded="false" aria-controls="basic-nav-section-four"> <span> Grants and Research <i class="fas fa-caret-down margin-left-05"></i> </span> </button>
|
||
<ul id="basic-nav-section-four" class="usa-nav__submenu bg-secondary" hidden="">
|
||
<li class="usa-nav__submenu-item"> <a href="/ep/index.html"><span>NLM Extramural Programs</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="/research/index.html"><span>NLM Intramural Research Program</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="https://www.ncbi.nlm.nih.gov/"><span>National Center for Biotechnology Information</span></a> </li>
|
||
<li class="usa-nav__submenu-item"> <a href="//lhncbc.nlm.nih.gov/"><span>Lister Hill National Center for Biomedical Communications</span></a> </li>
|
||
</ul>
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- End of TOP NAV -->
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!-- DIVISIONAL BANNER -->
|
||
|
||
<div class="bg-gray-70">
|
||
<div class="grid-container">
|
||
<div class="grid-row divisional">
|
||
|
||
|
||
|
||
|
||
<div class="grid-col text-white">
|
||
|
||
<div class="float-left">
|
||
<h4 class="margin-bottom-0"> VSAC Support Center</h4>
|
||
</div>
|
||
<div class="float-right margin-top-05">
|
||
<p>
|
||
|
||
|
||
|
||
<a class="text-white" href="/vsac/support/index.html">VSAC Support Center Home</a>
|
||
|
||
|
||
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!--END DIVISIONAL BANNER -->
|
||
|
||
<!-- Breadcrumbs -->
|
||
<div class="grid-container">
|
||
<nav class="usa-breadcrumb usa-breadcrumb--wrap padding-top-1" aria-label="Breadcrumbs">
|
||
<ol class="usa-breadcrumb__list">
|
||
<li class="usa-breadcrumb__list-item"> <a href="/index.html" class="usa-breadcrumb__link"><span>Home</span></a> </li>
|
||
|
||
|
||
|
||
|
||
|
||
<li class="usa-breadcrumb__list-item"> <a href="/vsac/support/index.html" class="usa-breadcrumb__link"><span>VSAC Support Center Home</span></a> </li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ol>
|
||
</nav>
|
||
</div>
|
||
<!-- End Breadcrumbs -->
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<main class="padding-bottom-5" id="main">
|
||
<div class="grid-container">
|
||
|
||
|
||
|
||
<div class="grid-row">
|
||
|
||
<div class="col">
|
||
|
||
|
||
|
||
<div class="h1">Create Value Sets</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="grid-row grid-gap-1"><!-- start row-->
|
||
|
||
|
||
|
||
<div class="tablet:grid-col-12"><!-- start column-->
|
||
|
||
<h3>How to Create, Save, and Edit Value Sets</h3>
|
||
<p>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.</p>
|
||
<p>Before you can create value sets, you need
|
||
<a href="https://www.nlm.nih.gov/vsac/support/usingvsac/author_registration.html">
|
||
VSAC Authoring Permissions</a>.
|
||
It is helpful to understand the
|
||
<a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/authorstewardroles.html">
|
||
the roles of value set authors and stewards</a>. NLM expects all authors and stewards to review
|
||
the
|
||
<a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/bestpractices.html">
|
||
VSAC Authoring Best Practices</a>.
|
||
</p>
|
||
|
||
|
||
<div class="usa-accordion usa-accordion--bordered margin-bottom-3">
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="createvs-section-1">
|
||
<!--<h4 class="mb-0">-->
|
||
Create an Extensional Value Set
|
||
|
||
<!--</h4>-->
|
||
</button>
|
||
</h4>
|
||
<div id="createvs-section-1" class="usa-accordion__content">
|
||
|
||
<p>Once you obtain authoring permissions, sign into VSAC with your UMLS account.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" alt="sign in"
|
||
src="/vsac/support/authorguidelines/signin.jpg"><br />
|
||
|
||
<ul>
|
||
|
||
<li>Select the <strong>Authoring </strong>tab.</li>
|
||
|
||
<li>Select "Enumerated List (extensional)" in the Define a New Value Set drop-down menu.</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="extnav" alt="extensional value set navigation"
|
||
src="/vsac/support/authorguidelines/selectextensionalvs.jpg"><br />
|
||
|
||
<p>A tab entitled, <strong>New Def…</strong> appears. Under that tab, there are three sub tabs. Complete
|
||
the
|
||
information in each sub tab sequentially.</p>
|
||
|
||
<ol>
|
||
|
||
<li>Metadata</li>
|
||
|
||
<li>Definition</li>
|
||
|
||
<li>Expansion/Publication</li>
|
||
|
||
</ol>
|
||
|
||
<br />
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="authortabs" alt="Three tabs under new value set"
|
||
src="/vsac/support/authorguidelines/threeauthortabs.png"><br /><br />
|
||
|
||
<h4>Add Metadata</h4>
|
||
|
||
<p><strong> Mandatory fields </strong>: OID, Name, Author, Steward, Purpose Statements</p>
|
||
|
||
<h5>OID</h5>
|
||
|
||
<ul>
|
||
|
||
<li><strong>Object Identifier (OID) Assignment </strong> - We strongly encourage the auto generate
|
||
default setting in which VSAC automatically generates an OID for your value set once you have
|
||
entered all the information in the other fields, and have selected the "Save" button. If the
|
||
automatic OID assignment does not meet your purpose, you will need to enter your own OID
|
||
manually.
|
||
</li>
|
||
|
||
<li><strong>Manual Entry of OID (very rare)</strong> - You must first register your organization's
|
||
namespace with an OID registry, such as HL7, and your OID must be previously published and used
|
||
by
|
||
the value set community; the value set you create will have the same content and purpose of your
|
||
pre-existing OID. If your OID satisfies these requirements, uncheck the Auto Generate box under
|
||
the
|
||
OID field and follow these formatting rules:
|
||
|
||
<ul>
|
||
|
||
<li>OIDs consist of dot-separated digits [1-9] or 0 if a single digit number, leading zeros
|
||
are
|
||
not allowed in multi-digit numbers.</li>
|
||
|
||
<li>NLM OID name space: Your manually entered OID must not begin with this reserved NLM
|
||
namespace: 2.16.840.1.113762.1.4.</li>
|
||
|
||
</ul>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" alt="OID.png"
|
||
src="/vsac/support/authorguidelines/OID.png">
|
||
|
||
|
||
|
||
<br /><br />
|
||
|
||
|
||
<h5>Value Set Name and Purpose Statements</h5>
|
||
|
||
<p>Follow<a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/bestpractices.html"> VSAC
|
||
Authoring
|
||
Best Practices</a> to write your value set Name and Purpose Statements.</p>
|
||
|
||
<h5>Save</h5>
|
||
|
||
<p>When finished entering metadata, click the "Save" button.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="extmetadata" alt="extensionalmetadata2.png"
|
||
src="/vsac/support/authorguidelines/extensionalmetadata2.png"><br /><br />
|
||
|
||
<h4>Create Definition</h4>
|
||
|
||
<ol type="1">
|
||
|
||
<li>Select a code system for your value set.<br />
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="extcodesystems" alt="extensionalcodesys.png"
|
||
src="/vsac/support/authorguidelines/extensionalcodesys.png">
|
||
|
||
</li>
|
||
|
||
<li>Add codes to your value set. Methods: SEARCH, IMPORT, ADD(+) <br /><br />
|
||
SEARCH
|
||
|
||
<ol type="a">
|
||
|
||
<li>Search and filter for codes in the Code Systems panel.</li>
|
||
|
||
<li>Select your desired codes, and click "←Add to Value Set"</li>
|
||
|
||
<li>Save.</li>
|
||
|
||
</ol>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="searchcodes" alt="searchcodes.png"
|
||
src="/vsac/support/authorguidelines/searchcodes.png"><br /><br />
|
||
IMPORT
|
||
|
||
|
||
<ol type="a">
|
||
|
||
<li>Import a list of codes you have generated elsewhere.</li>
|
||
|
||
<li>Click "Import" in the Value Set Code List table.</li>
|
||
|
||
<li>Select the character that separates the codes you are copying to the Text Box or in the
|
||
file
|
||
you are importing.</li>
|
||
|
||
<li>Choose "From Text Box" or "From File". Supported file type is .txt</li>
|
||
|
||
<li>Click "Preview": Preview is useful to determine if you selected the correct separator or
|
||
if
|
||
you mistakenly included descriptors in your code import. For example, if you import a
|
||
file
|
||
with 15 codes separated by space, but you mistakenly selected a ; or | , your Code
|
||
Preview
|
||
will display as a single row and total codes: 1</li>
|
||
|
||
<li>Click "Validate": Validates and provides information about your code list you wish to
|
||
import. Removes duplicate codes, shows invalid/inactive codes. Code count difference
|
||
between
|
||
Code Preview and Code Validation can indicate issues in your code list. You must
|
||
validate
|
||
your codes and ensure you include only valid codes before the Import button will
|
||
activate.
|
||
</li>
|
||
|
||
<li>Click "Import"</li>
|
||
</ol>
|
||
<img class="figure-img img-fluid img-thumbnail" id="import" alt="import.png"
|
||
src="/vsac/support/authorguidelines/import.png"><br /><br />
|
||
ADD (+)
|
||
<ol type="a">
|
||
|
||
<li>Click the + in the Value Set Code List table</li>
|
||
|
||
<li>Type or paste your code in the yellow-highlighted row</li>
|
||
</ol>
|
||
<img class="figure-img img-fluid img-thumbnail" id="addnewcode" alt="addnewcode.png"
|
||
src="/vsac/support/authorguidelines/addnewcode.png"><br /><br />
|
||
</li>
|
||
|
||
<li>Click the <strong> Submit </strong> button to submit your value set to your steward for
|
||
approval.
|
||
Your steward will review your value set definition and decide to approve or reject the value set
|
||
definition.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="submittosteward" alt="submittosteward.png"
|
||
src="/vsac/support/authorguidelines/submittosteward.png">
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>Click the <strong> Approve </strong> button. (steward action)
|
||
|
||
<br />
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="clickapprove" alt="clickapprove.png"
|
||
src="/vsac/support/authorguidelines/clickapprove.png">
|
||
|
||
</li>
|
||
|
||
</ol>
|
||
|
||
<p>When the steward approves the value set definition, your value set is in <strong> Ready to Publish
|
||
</strong> status. VSAC will publish a snapshot/temporary expansion of your definition version,
|
||
called
|
||
<strong>Latest</strong>, at midnight Eastern Time expanded/calculated using the most recent code
|
||
system
|
||
versions available in VSAC. VSAC will automatically publish subsequent 'Latest' expansions of your
|
||
value
|
||
set definition whenever code systems update in VSAC. If you require a specific type of expansion for
|
||
your value set, such as a static code list, or based on a later publication date, different code
|
||
system
|
||
version, or a pre-established expansion profile, go to the Expand/Publish tab to create a "Steward
|
||
Expansion."
|
||
</p>
|
||
|
||
<h4>Expand/Publish Value Set</h4>
|
||
|
||
<p>If you require non-default expansion settings, like a specific code system version (Setting A
|
||
Example),
|
||
or a date for expansion (Setting B Example) proceed to the Expansion/Publication sub tab after you
|
||
have
|
||
submitted, saved, and you or the steward has approved your value set definition. Make the selections
|
||
for
|
||
the non-default expansion settings as illustrated below.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" alt="extexpandpublish.jpg"
|
||
src="/vsac/support/authorguidelines/extexpandpublish.jpg">
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="createvs-section-2">
|
||
<!--<h4 class="mb-0">-->
|
||
Create an Intensional Value Set
|
||
|
||
<!--</h4>-->
|
||
</button>
|
||
</h4>
|
||
<div id="createvs-section-2" class="usa-accordion__content">
|
||
|
||
<h4><a id="topics">Topics</a></h4>
|
||
|
||
<ul>
|
||
|
||
<li><a href="#select"><strong>Select Intensional Value Set Option</strong></a></li>
|
||
|
||
<li><a href="#add"><strong>Add Metadata</strong></a></li>
|
||
|
||
<li><a href="#create"><strong>Create Definition</strong></a> </li>
|
||
|
||
<li><a href="#code"><strong>Code Clipboard</strong></a> </li>
|
||
|
||
<li><a href="#validoperators"><strong>Valid Operators for Each Code System</strong></a> </li>
|
||
|
||
<li><a href="#other"><strong>Other Examples of Intensional Value Sets</strong></a> </li>
|
||
|
||
<li><a href="#expand"><strong>Expand/Publish the Value Set</strong></a></li>
|
||
|
||
</ul>
|
||
|
||
<h4><a id="select">Select Intensional Value Set Option</a></h4>
|
||
|
||
<p>Once you obtain authoring permissions, sign into VSAC with your UMLS account.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" alt="sign in"
|
||
src="/vsac/support/authorguidelines/signin.jpg"><br />
|
||
|
||
<ul>
|
||
|
||
<li>Select the <strong>Authoring </strong>tab.</li>
|
||
|
||
<li>Select the rule-based intensional option in the definition method drop-down menu.</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="intnavigate" alt="intensional value set navigation"
|
||
src="/vsac/support/authorguidelines/selectintensionalvs.jpg"><br />
|
||
|
||
<p>A tab entitled, <strong>New Def…</strong> 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:</p>
|
||
|
||
<ol>
|
||
|
||
<li>the Metadata sub tab</li>
|
||
|
||
<li> the Definition sub tab</li>
|
||
|
||
<li> the Expansion/Publication sub tab, if needed</li>
|
||
|
||
</ol>
|
||
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
<h4><a id="add"> Add Metadata</a></h4>
|
||
|
||
<p><strong> Mandatory fields </strong>: OID, Name, Author, Steward, Purpose fields</p>
|
||
|
||
<h5>OID</h5>
|
||
|
||
<ul>
|
||
|
||
<li><strong>Object Identifier (OID) Assignment </strong> - we recommend the auto generate default
|
||
setting in which VSAC automatically generates an OID for your value set once you have entered
|
||
all
|
||
the information in the other fields, and have selected the "Save" button. If the automatic OID
|
||
assignment does not meet your purpose, you will need to to enter your own OID manually.</li>
|
||
|
||
<li><strong>Manual Entry of OID (Rare)</strong> - 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.</li> </ul>
|
||
|
||
|
||
|
||
To manually enter your pre-existing OID, uncheck the Auto Generate box under the OID field,
|
||
and
|
||
follow the instructions in the tool tip<img alt="toolpitimage.jpg"
|
||
src="/vsac/support/authorguidelines/tooltipimage.jpg" style="width: 20px;">to correctly
|
||
enter your OID before selecting the Save button.
|
||
|
||
<ul>
|
||
|
||
<li>If you need to enter an OID manually, the following rules apply:
|
||
|
||
<ul>
|
||
|
||
<li>OID Consists of all digits [1-9] or 0 if a single digit number, but no leading zeros
|
||
if
|
||
multiple digit number </li>
|
||
|
||
<li>Numbers may be separated by dots</li>
|
||
|
||
<li>NLM OID name space: Any OID entered MUST NOT start with 2.16.840.1.113 762.1.4</li>
|
||
|
||
</ul>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
<img class="figure-img img-fluid img-thumbnail" alt="OID.jpg"
|
||
src="/vsac/support/authorguidelines/OID.jpg">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h5>Purpose fields</h5>
|
||
|
||
<p>Follow<a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/bestpractices.html"> VSAC
|
||
Authoring
|
||
Best Practices</a> to write your purpose statements.</p>
|
||
|
||
<h5>Save</h5>
|
||
|
||
<p>When finished entering metadata, click the "Save" button.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="tabs" alt="intensionalmetadata.jpg"
|
||
src="/vsac/support/authorguidelines/intensionalmetadata.jpg"><br /><br />
|
||
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
<h4><a id="create">Create Definition</a></h4>
|
||
|
||
|
||
|
||
<ol>
|
||
|
||
<li>Select a code system for your value set.
|
||
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="codesystem" alt="codesystem.jpg"
|
||
src="/vsac/support/authorguidelines/codesystem.jpg">
|
||
</li>
|
||
|
||
|
||
<li>Get codes for your Include and Exclude clauses.
|
||
<ol type="a">
|
||
|
||
<li>If you already know a code you want to include, type (Method 1) or copy/paste the code
|
||
into
|
||
a clause. Alternatively, if you have already collected your codes in a local text file,
|
||
you
|
||
can import your codes into the Code Clipboard as a holding place for you to then select
|
||
which codes go into which clause.</li>
|
||
|
||
<li>If you know you need to use descriptors to find codes, you can either use "Search for
|
||
Codes"
|
||
(Method 2), as a simple and direct search and filter function, or you can use
|
||
<strong>Browse
|
||
Code Systems</strong> if you need to first study your terminology’s hierarchy and
|
||
relationship details, and then select codes based on your discovery. Browse Code Systems
|
||
will open in a separate tab or window depending on your browser settings.
|
||
</li>
|
||
|
||
<li>Add your desired codes to your Code Clipboard (Add to Code Clipboard), or directly add
|
||
your
|
||
code into your checkbox-selected clause (Method 3) when you use the simple "Search Code"
|
||
or
|
||
the more advanced Browse Code Systems. Your Code Clipboard is a temporary place for you
|
||
to
|
||
gather multiple codes to later include them in specific definition clauses. This
|
||
separate
|
||
Code Clipboard becomes especially important when you are gathering several codes for
|
||
multiple clauses as it gives you control over which codes you specify for your clauses
|
||
within your value set definition. <img class="figure-img img-fluid img-thumbnail"
|
||
id="intgetcodes" alt="intgetcodes.jpg" src="intgetcodes.jpg">
|
||
</li>
|
||
|
||
</ol>
|
||
|
||
</li>
|
||
|
||
<li>Create your logical clauses. You can do this either before or after you get your codes (step 2).
|
||
<img class="figure-img img-fluid img-thumbnail" id="intclauses" alt="intclauses.jpg"
|
||
src="/vsac/support/authorguidelines/intclauses.jpg">
|
||
|
||
<ol type="a">
|
||
|
||
<li>Select your <a href="#validoperators">desired operator</a> and code for your first
|
||
clause,
|
||
in either the Include or Exclude Codes sections. See the blue button Glossary to review
|
||
the
|
||
function of each operator.</li>
|
||
|
||
<li>Add more clauses to create unions (+OR) or intersections (+AND) of your codes.</li>
|
||
|
||
<li>If you already know a code you want to include, type or copy/paste the code into a
|
||
clause.
|
||
Otherwise, to enter a code from your Code Clipboard into a specific clause, select the
|
||
checkbox of the clause you want to modify, then select the checkbox of the code in your
|
||
Code
|
||
Clipboard, and then select Search Code "Add to Clause".</li>
|
||
|
||
<li>If you need to do advanced code editing within your Code Clipboard for a clause, for
|
||
example, if you are working with the IN operator, select the checkbox of your desired
|
||
clause, and then click the blue button "Advanced Code Editor".</li>
|
||
|
||
</ol>
|
||
|
||
</li>
|
||
|
||
<li>When you are satisfied with your value set definition, save your value set definition, by
|
||
clicking
|
||
the <strong> Save </strong> button.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="intsavedef" alt="intsavedef"
|
||
src="/vsac/support/authorguidelines/intsavedef.jpg">
|
||
</li>
|
||
|
||
<li>Preview expansion of your entire constructed definition by selecting the “Full Preview†button,
|
||
or of
|
||
any sub-clause within the definition by selecting the “Preview this Section to review the
|
||
results
|
||
of your expanded code list.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="intpreviewexpand" alt="previewexpansion"
|
||
src="/vsac/support/authorguidelines/previewexpand.jpg">
|
||
</li>
|
||
|
||
|
||
<li>Submit your value set to the steward to approve, by clicking the <strong> Submit </strong>
|
||
button.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="intsubmit" alt="intsubmit"
|
||
src="/vsac/support/authorguidelines/intsubmit.jpg">
|
||
</li>
|
||
|
||
<li>The Steward will review the value set definition and decide to approve or reject your value set
|
||
definition. To approve the value set definition and to enable public access of the value set’s
|
||
expansion, the Steward should click the <strong> Approve </strong> button.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="intapprove" alt="intapprove"
|
||
src="/vsac/support/authorguidelines/intapprove.jpg">
|
||
</li>
|
||
|
||
|
||
</ol>
|
||
|
||
|
||
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
<h4><a id="code">Code Clipboard</a></h4>
|
||
|
||
<p>Your Code Clipboard is a temporary place for you to gather multiple codes so you can later include
|
||
them
|
||
in specific definition clauses. Code Clipboard becomes especially important when you are gathering
|
||
several codes for multiple clauses as it gives you control over which codes you specify for your
|
||
clauses
|
||
within your value set definition. Code Clipboard is currently available to assist you with
|
||
intensional
|
||
value set definitions.</p>
|
||
|
||
<p>You can find your Code Clipboard in three places within the VSAC Authoring environment: the "Search
|
||
for
|
||
Codes" tab, "Browse Code Systems," and the "Advanced Code Editor."</p>
|
||
|
||
<h5>Search for Codes tab</h5>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="searchforcodes" alt="searchforcodes"
|
||
src="/vsac/support/authorguidelines/searchcode.png">
|
||
|
||
<p>Displays your gathered codes only from your currently selected code system.</p>
|
||
|
||
<p>You can gather more codes from the Search Code panel: select the checkboxes of codes you like and
|
||
then
|
||
click Add to Code Clipboard. You can also use the Import feature to import your own local text file
|
||
of
|
||
codes into your Code Clipboard.</p>
|
||
|
||
<p>Add to Clause: select the checkboxes of Code Clipboard codes you need for a specific clause, select
|
||
the
|
||
checkbox of that clause, and then click Add to Clause at the top of your Code Clipboard.</p>
|
||
|
||
<h5>Browse Code Systems</h5>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="browsecodesystems" alt="browsecodesystems"
|
||
src="/vsac/support/authorguidelines/browsecodesys.jpg">
|
||
|
||
<p>Displays all of your gathered codes from all code systems. Only those codes from the code system with
|
||
which you are currently working will be selectable; codes you have gathered previously from other
|
||
code
|
||
systems will be greyed out.</p>
|
||
|
||
<p>You can gather more codes from any of the Browse Code System panels: select the checkboxes of codes
|
||
you
|
||
like and then Add to Code Clipboard. You can also use the Import feature to import your own local
|
||
text
|
||
file of codes into your Code Clipboard.</p>
|
||
|
||
<p>Your Code Clipboard will persist when you switch back to your VSAC Authoring window, where you can
|
||
select
|
||
the checkboxes of codes you like, select the checkbox of your target clause, and then click Add to
|
||
Clause.</p>
|
||
|
||
<h5>Advanced Code Editor</h5>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="advcodeedit3" alt="advcodeedit3"
|
||
src="/vsac/support/authorguidelines/advcodeedit3.jpg">
|
||
|
||
<p>Use the Advanced Code Editor to add more codes to your clause.</p>
|
||
|
||
<p>Select the checkbox next to the clause for which you would like to add codes, and then select the
|
||
Advanced Code Editor button.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="advcodeedit2" alt="advcodeedit2"
|
||
src="/vsac/support/authorguidelines/advcodeedit2.jpg">
|
||
|
||
<p>Displays your gathered codes only from your currently selected code system.</p>
|
||
|
||
<p>You can gather more codes from the Search Code panel within the Advanced Code Editor: select the
|
||
checkboxes of codes you like and then click Add to Code Clipboard.</p>
|
||
|
||
<p>You can select the checkboxes of any of your Code Clipboard codes and then click the centrally
|
||
located
|
||
orange arrow to place those codes into your selected clause. Then click the [Save Changes to Clause]
|
||
button, click the Cancel button to close the Advanced Code Editing dialog window and return to your
|
||
intensional value set definition to see your changes.</p>
|
||
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
<h4><a id="validoperators">Valid Operators for Each Code System</a></h4>
|
||
|
||
<p>This table displays the valid operators for each code system. The "all" operator can be used in just
|
||
a
|
||
few smaller code systems (CDCREC, CVX, HL7, HSLOC, NUCCPT, and SOP). Large code systems like SNOMED
|
||
CT,
|
||
CPT, etc. are either too large to use all codes or have copyright restrictions. Future development
|
||
will
|
||
include intensional value set authoring functionality for RxNorm and LOINC, as well as the ability
|
||
to
|
||
convert existing extensional value sets to logically defined intensional value sets as desired by
|
||
the
|
||
author.</p>
|
||
|
||
<div class="usa-table-container--scrollable" tabindex="0">
|
||
<table class="usa-table">
|
||
|
||
<thead>
|
||
|
||
<tr>
|
||
|
||
<th>Code Systems</th>
|
||
|
||
<th>all</th>
|
||
|
||
<th>equal</th>
|
||
|
||
<th>in</th>
|
||
|
||
<th>descendantOf</th>
|
||
|
||
<th>descendantOrSelfOf</th>
|
||
|
||
<th>childOf</th>
|
||
|
||
<th>ancestorOf</th>
|
||
|
||
<th>ancestororSelfOf</th>
|
||
|
||
<th>parentOf</th>
|
||
|
||
<th>leafOf </th>
|
||
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody>
|
||
|
||
<tr>
|
||
|
||
<th scope="row"></th>
|
||
|
||
<td>All concepts in the code system</td>
|
||
|
||
<td>The specified concept</td>
|
||
|
||
<td>All concepts in the specified concept list</td>
|
||
|
||
<td>All descendants of the specified concept</td>
|
||
|
||
<td>All descendants of the specified concept plus the specified concept itself</td>
|
||
|
||
<td>All children of the specified concept</td>
|
||
|
||
<td>All ancestors of the specified concept</td>
|
||
|
||
<td>All ancestors of the specified concept plus the specified concept itself</td>
|
||
|
||
<td>All parents of the specified concept</td>
|
||
|
||
<td>Terminal descendant codes of the specified header code; excludes header codes that
|
||
are
|
||
descendants of the specified header code</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">CDCREC</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
<td> </td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">CDT</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">CPT</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">CVX</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">HCPCS</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">HL7</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">HSLOC</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">ICD10CM</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">ICD10PCS</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">ICD9CM</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">LOINC</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">MED-RT</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td> </td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">NCI</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td> </td>
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">NDFRT</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td> </td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">NUCCPT</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">RxNorm</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">SNOMED CT</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">SOP</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td> </td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">UCUM</th>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
|
||
<th scope="row">UNII</th>
|
||
|
||
<td></td>
|
||
|
||
<td>x</td>
|
||
|
||
<td>x</td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
|
||
<td></td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
|
||
</table>
|
||
</div>
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
<h4><a id="other">Other Examples of Intensional Value Sets</a></h4>
|
||
|
||
<p>All direct descendants (children) of Race as illustrated in the image below.</p>
|
||
|
||
<ul>
|
||
|
||
<li>Code System: CDCREC</li>
|
||
|
||
<li>Include: childOf 1000-9</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="race" alt="CDCREC Race"
|
||
src="/vsac/support/authorguidelines/CDCRECRace.jpg"><br /><br />
|
||
|
||
<p>All codes in the CDCREC terminology as illustrated in the image below.</p>
|
||
|
||
<ul>
|
||
|
||
<li>Code System: CDCREC</li>
|
||
|
||
<li>Include: All (to get 966 codes)</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="all" alt="CDCREC All"
|
||
src="/vsac/support/authorguidelines/CDCRECall.jpg"><br /><br />
|
||
|
||
<p><a href="#topics" style="color: black">Back to Topics</a></p>
|
||
|
||
<h4><a id="expand">Expand/Publish Value Set</a></h4>
|
||
|
||
<p>If you require non-default expansion settings, like a specific code system version (Setting A
|
||
Example),
|
||
or a date for expansion (Setting B Example) proceed to the Expansion/Publication sub tab after you
|
||
have
|
||
submitted, saved, and you or the steward has approved your value set definition. Make the selections
|
||
for
|
||
the non-default expansion settings as illustrated below.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="extexpandpublish" alt="extexpandpublish.jpg"
|
||
src="/vsac/support/authorguidelines/extexpandpublish.jpg">
|
||
|
||
<p><a href="#topics">Back to Topics</a></p>
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="createvs-section-3">
|
||
<!--<h4 class="mb-0">-->
|
||
Create a Grouping Value Set
|
||
|
||
<!-- </h4>-->
|
||
</button>
|
||
</h4>
|
||
<div id="createvs-section-3" class="usa-accordion__content">
|
||
|
||
<p>Once you obtain authoring permissions, sign into VSAC with your UMLS account.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" alt="sign in"
|
||
src="/vsac/support/authorguidelines/signin.jpg"><br />
|
||
|
||
<ul>
|
||
|
||
<li>Select the <strong>Authoring </strong>tab.</li>
|
||
|
||
<li>Select the Group Existing Value Set Definitions (grouping) option in the Define a New Value Set
|
||
drop-down menu.</li>
|
||
|
||
</ul>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="selectgrp" alt="select grouping value set"
|
||
src="/vsac/support/authorguidelines/selectgroupingvs.jpg"><br />
|
||
|
||
<p>A tab entitled, <strong>New Def…</strong> 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:</p>
|
||
|
||
<ol>
|
||
|
||
<li>Metadata sub tab</li>
|
||
|
||
<li>Definition sub tab</li>
|
||
|
||
<li>Expansion/Publication sub tab, if needed</li>
|
||
|
||
</ol>
|
||
|
||
<br />
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="grpthreetabs" alt="Three tabs under new value set"
|
||
src="/vsac/support/authorguidelines/threeauthortabs.jpg"><br /><br />
|
||
|
||
<h4>Add Metadata</h4>
|
||
|
||
<p><strong> Mandatory fields </strong>: OID, Name, Author, Steward, Purpose fields</p>
|
||
|
||
<h5>OID</h5>
|
||
|
||
<ul>
|
||
|
||
<li><strong>Object Identifier (OID) Assignment </strong> - we recommend the auto generate default
|
||
setting in which VSAC automatically generates an OID for your value set once you have entered
|
||
all
|
||
the information in the other fields, and have selected the "Save" button. If the automatic OID
|
||
assignment does not meet your purpose, you will need to to enter your own OID manually.</li>
|
||
|
||
<li><strong>Manual Entry of OID (Rare)</strong> - 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.
|
||
|
||
<ul>
|
||
|
||
<li>To manually enter your pre-existing OID, uncheck the Auto Generate box under the OID
|
||
field,
|
||
and follow the instructions in the tool tip<img alt="toolpitimage.jpg"
|
||
src="/vsac/support/authorguidelines/tooltipimage.jpg" style="width: 20px;">to
|
||
correctly
|
||
enter your OID before selecting the Save button. </li>
|
||
|
||
<li>If you need to enter an OID manually, the following rules apply:
|
||
|
||
<ul>
|
||
|
||
<li>OID Consists of all digits [1-9] or 0 if a single digit number, but no leading
|
||
zeros
|
||
if multiple digit number </li>
|
||
|
||
<li>Numbers may be separated by dots</li>
|
||
|
||
<li>NLM OID name space: Any OID entered MUST NOT start with 2.16.840.1.113 762.1.4
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
<img class="figure-img img-fluid img-thumbnail" alt="OID.jpg"
|
||
src="/vsac/support/authorguidelines/OID.jpg">
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
|
||
<h5>Purpose fields</h5>
|
||
|
||
<p>Follow<a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/bestpractices.html"> VSAC
|
||
Authoring
|
||
Best Practices</a> to write your purpose statements.</p>
|
||
|
||
<h5>Save</h5>
|
||
|
||
<p>When finished entering metadata, click the "Save" button.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="grpmetadata" alt="groupingmetadata2.jpg"
|
||
src="/vsac/support/authorguidelines/groupingmetadata2.jpg"><br /><br />
|
||
|
||
<h4>Create Definition</h4>
|
||
|
||
<ol type="1">
|
||
|
||
<li>Search for and select value sets you would like to group together into your grouping value
|
||
set.<br />
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="grpgetcodes" alt="grpgetcodes.jpg"
|
||
src="/vsac/support/authorguidelines/grpgetcodes.jpg"><br /><br />
|
||
|
||
</li>
|
||
|
||
<li>Enter OIDs, value set names, or terms to search for value sets.</li>
|
||
|
||
<li>Add selected value sets your grouping value set.</li>
|
||
|
||
<li>Save the value set definition.</li>
|
||
|
||
<li>Submit your value set to the steward to approve by clicking the <strong> Submit </strong>
|
||
button.
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="grpsubmit" alt="grpsubmit.jpg"
|
||
src="/vsac/support/authorguidelines/grpsubmit.jpg">
|
||
</li>
|
||
|
||
<li>The steward will review the value set defintion and decide to approve or reject your value set.
|
||
To
|
||
approve the value set definition and to enable public access of the value set’s expansion, the
|
||
Steward should click the <strong> Approve </strong> button.
|
||
|
||
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="groupapprove" alt="groupapprove.jpg"
|
||
src="/vsac/support/authorguidelines/groupapprove.jpg">
|
||
</li>
|
||
|
||
</ol>
|
||
|
||
<p>When the steward approves the value set definition, your value set is in <strong> Ready to Publish
|
||
</strong> status. At midnight (EST), VSAC will publish a snapshot/temporary expansion of the
|
||
definition,
|
||
called Latest, based on the most recent code systems available in VSAC.</p>
|
||
|
||
<h4>Expand/Publish Value Set</h4>
|
||
|
||
<p>If you require non-default expansion settings, like a specific code system version (Setting A
|
||
Example),
|
||
or a date for expansion (Setting B Example) proceed to the Expansion/Publication sub tab after you
|
||
have
|
||
submitted, saved, and you or the steward has approved your value set definition. Make the selections
|
||
for
|
||
the non-default expansion settings as illustrated below.</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="grpexpandpublish" alt="grpexpandpublish.jpg"
|
||
src="/vsac/support/authorguidelines/grpexpandpublish.jpg">
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="createvs-section-4">
|
||
<!--<h4 class="mb-0">-->
|
||
Clone an Existing Value Set
|
||
|
||
<!-- </h4>-->
|
||
</button>
|
||
</h4>
|
||
<div id="createvs-section-4" class="usa-accordion__content">
|
||
<p>You can use the Clone function, in Authoring, if you find a published or draft value set that is close to what you want to use, but you want to revise it in some way for a new purpose. Your cloned value set will have a new value set OID. (Note: You may not use Clone for updating published value sets. Please refer to <a href="https://www.nlm.nih.gov/vsac/support/authorguidelines/updatingvaluesets.html">Updating Value Sets</a>.)</p>
|
||
|
||
<img class="figure-img img-fluid img-thumbnail" id="clonebutton" alt="clonebutton.png"
|
||
src="/vsac/support/authorguidelines/clonebutton.png">
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div><!-- end accordion-->
|
||
|
||
</div><!-- end column-->
|
||
</div><!-- end row-->
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class=”margin-top-5”><small>Last Reviewed: February 9, 2024</small></p>
|
||
|
||
</div>
|
||
</main>
|
||
|
||
<!-- FOOTER -->
|
||
<footer class="usa-footer__primary-section padding-top-5 padding-bottom-3 insertfooter">
|
||
|
||
<div class="grid-container">
|
||
<div class="grid-row">
|
||
<div class="desktop:grid-col-3 grid-col-6"> <a href="https://www.nlm.nih.gov/socialmedia/index.html">
|
||
<p class="text-white">Connect with NLM</p>
|
||
</a>
|
||
<ul class="social_media add-list-reset">
|
||
<li class="margin-right-05"><a href="https://www.facebook.com/nationallibraryofmedicine"><img class="bg-secondary" src="https://www.nlm.nih.gov/images/facebook.svg" alt="Facebook"></a></li>
|
||
<li class="margin-right-05"><a title="External link: please review our privacy policy." href="https://www.linkedin.com/company/national-library-of-medicine-nlm/"><img class="bg-secondary" src="//www.nlm.nih.gov/images/linkedin.svg" alt="LinkedIn"></a></li>
|
||
<li class="margin-right-05"><a title="External link: please review our privacy policy." href="https://twitter.com/NLM_NIH"><img src="//www.nlm.nih.gov/images/twitter.svg" class="img-fluid bg-secondary" alt="Twitter"></a></li>
|
||
<li class="margin-right-05"><a title="External link: please review our privacy policy." href="https://www.youtube.com/user/NLMNIH"><img src="//www.nlm.nih.gov/images/youtube.svg" class="bg-secondary" alt="You Tube"></a></li>
|
||
<li class="margin-right-05"><a title="External link: please review our privacy policy." href="https://public.govdelivery.com/accounts/USNLMOCPL/subscriber/new?preferences=true"><img src="//www.nlm.nih.gov/images/mail.svg" class=" bg-secondary" alt="Government Delivery"></a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="desktop:grid-col-3 grid-col-6">
|
||
<p class="address_footer text-white"> National Library of Medicine <br>
|
||
<a href="https://www.google.com/maps/place/8600+Rockville+Pike,+Bethesda,+MD+20894/@38.9959508,-77.101021,17z/data=!3m1!4b1!4m5!3m4!1s0x89b7c95e25765ddb:0x19156f88b27635b8!8m2!3d38.9959508!4d-77.0988323" class="text-white"> 8600 Rockville Pike <br>
|
||
Bethesda, MD 20894 </a></p>
|
||
</div>
|
||
<div class="desktop:grid-col-3 grid-col-6">
|
||
<p><a href="/web_policies.html" class="text-white"> Web Policies </a><br>
|
||
<a href="https://www.nih.gov/institutes-nih/nih-office-director/office-communications-public-liaison/freedom-information-act-office" class="text-white"> FOIA </a><br>
|
||
<a href="https://www.hhs.gov/vulnerability-disclosure-policy/index.html" class="text-white">HHS Vulnerability Disclosure</a> </p>
|
||
</div>
|
||
<div class="desktop:grid-col-3 grid-col-6">
|
||
<p><a class="supportLink text-white" href="//support.nlm.nih.gov?from="> NLM Support Center </a> <br>
|
||
<a href="/accessibility.html" class="text-white"> Accessibility </a><br>
|
||
<a href="/careers/careers.html" class="text-white"> Careers </a></p>
|
||
</div>
|
||
</div>
|
||
<div class="grid-row">
|
||
<div class="grid-col-12">
|
||
<p class="text-center text-white"> <a class="text-white" href="//www.nlm.nih.gov/">NLM</a> | <a class="text-white" href="https://www.nih.gov/">NIH</a> | <a class="text-white" href="https://www.hhs.gov/">HHS</a> | <a class="text-white" href="https://www.usa.gov/">USA.gov</a></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
<script src="//assets.nlm.nih.gov/uswds/js/uswds.min.js"></script>
|
||
<script src="//assets.nlm.nih.gov/jquery/jquery-latest.min.js"></script>
|
||
<script src="//assets.nlm.nih.gov/jquery/jquery-migrate-latest.min.js"></script>
|
||
<script src="/scripts/nlm_autocomplete.js"></script>
|
||
<script src="/scripts/nlm_uswds.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|
||
|
||
|