1292 lines
59 KiB
HTML
1292 lines
59 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>VSAC API Resources</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="VSAC API Resources" />
|
||
|
||
<meta name="DC.Subject.Keyword" content="vsac svs api, FHIR API" />
|
||
<meta name="DC.Publisher" content="U.S. National Library of Medicine" />
|
||
<meta name="DC.Date.Issued" content="2015-05-21" />
|
||
<meta name="DC.Date.Modified" content="2023-09-07" />
|
||
<meta name="NLMDC.Date.LastReviewed" content="2023-09-07" />
|
||
<meta name="NLM.Contact.Email" content="nlmumlscustserv@mail.nlm.nih.gov" />
|
||
<meta name="DC.Type" content="Technical Documentation" />
|
||
<meta name="NLM.Permanence.Level" content="Permanence Not Guaranteed" />
|
||
<meta name="DC.Rights" content="Public Domain" />
|
||
<meta name="DC.Language" content="eng" />
|
||
|
||
|
||
<style>
|
||
p.normal {
|
||
font-weight: normal;
|
||
}
|
||
</style>
|
||
<!-- 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">VSAC API Resources</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="grid-row grid-gap-1"><!-- start row--><!-- start FHIR terminology service for VSAC Resources row-->
|
||
<div class="tablet:grid-col-12"><!-- start column-->
|
||
|
||
|
||
<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="umlstos-section-1">UMLS
|
||
License Requirement and Terms of Service</button> <!--title goes inside button element -->
|
||
<!-- <h4 class="mb-0">
|
||
UMLS License Requirement and Terms of Service
|
||
|
||
</h4>
|
||
-->
|
||
<!-- <div>
|
||
<i class="fas fa-angle-down"></i>
|
||
</div>
|
||
-->
|
||
<!-- </button>
|
||
-->
|
||
</h4>
|
||
<div id="umlstos-section-1" class="usa-accordion__content">
|
||
|
||
<h5>UMLS License Requirement</h5>
|
||
|
||
<p>The VSAC APIs require a UMLS account. If you do not have a UMLS account, you may apply for a
|
||
license
|
||
on the
|
||
<a href="https://uts.nlm.nih.gov/uts/signup-login">UMLS Terminology Services (UTS)
|
||
website.</a>
|
||
</p>
|
||
|
||
<h5>Terms of Service</h5>
|
||
|
||
<p>In order to avoid overloading our servers, NLM requires that users send no more than 20
|
||
requests per
|
||
second
|
||
per IP address. Requests that exceed this limit may not be serviced, and service will not be
|
||
restored until
|
||
the request rate falls beneath the limit. To limit the number of requests that you send to
|
||
the APIs,
|
||
NLM
|
||
recommends caching results for a 12-24 hour period. This policy is in place to ensure that
|
||
the
|
||
service
|
||
remains available and accessible to all users. If you have a specific use case that requires
|
||
you to
|
||
send a
|
||
large number of requests to one of our APIs, and thus exceed the request rate limit outlined
|
||
in this
|
||
policy,
|
||
please contact us. NLM staff will evaluate your request and determine if an exception may be
|
||
granted. We
|
||
invite you to develop computer and mobile applications using National Library of Medicine
|
||
(NLM)
|
||
resources.
|
||
We request that any application that makes use of NLM data include the following statement:
|
||
<i>"This
|
||
product
|
||
uses publicly available data from the U.S. National Library of Medicine (NLM), National
|
||
Institutes of
|
||
Health, Department of Health and Human Services; NLM is not responsible for the product
|
||
and does
|
||
not
|
||
endorse or recommend this or any other product."</i> Developers may not use the
|
||
NLM name
|
||
and/or
|
||
logo in conjunction with their applications.
|
||
</p>
|
||
|
||
<p>DISCLAIMER: It is not the intention of NLM to provide specific medical advice, but rather to
|
||
provide
|
||
users
|
||
with information to better understand their health and their medications. NLM urges you to
|
||
consult
|
||
with a
|
||
qualified physician for medical advice.</p>
|
||
|
||
</div><!-- end accordion content-->
|
||
</div><!-- end accordion-->
|
||
|
||
|
||
<h3>FHIR<sup>®</sup> Terminology Service for VSAC Resources</h3>
|
||
<p>The <a href="https://www.nlm.nih.gov/vsac/support/usingvsac/vsacfhirapi.html" target="_blank">FHIR
|
||
Terminology
|
||
Service for VSAC Resources</a> is a RESTful API service for accessing the VSAC value sets
|
||
and
|
||
supported
|
||
code
|
||
systems. </p>
|
||
|
||
<!-- fhirapi-section-1 -->
|
||
<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="fhirapi-section-1">Authentication</button>
|
||
|
||
</h4>
|
||
<div id="fhirapi-section-1" class="usa-accordion__content">
|
||
|
||
<p>The FHIR Terminology Service for VSAC Resources authentication service requires a free <a
|
||
href="https://uts.nlm.nih.gov/">UMLS account</a>.
|
||
Use basic authentication with your UMLS API Key.</p>
|
||
|
||
For example, if you are using a RESTful client platform such as Postman, choose:
|
||
<ul>
|
||
<li> Authorization Type = Basic Auth
|
||
<li> username = ‘apikey’ or leave it blank </li>
|
||
<li> password = user’s actual UMLS API Key </li>
|
||
</ul>
|
||
|
||
<p>For software developers, here is a <a href="FHIR-Client-Java.html">Java example</a> of
|
||
embedding
|
||
a
|
||
VSAC FHIR
|
||
API call within a program.</p>
|
||
|
||
<p>You can find your API Key in the My Profile area of the <a href="https://uts.nlm.nih.gov/">UMLS
|
||
Terminology
|
||
Services (UTS)</a> after signing in. If the API Key field in your UTS profile is
|
||
blank,
|
||
click
|
||
Edit
|
||
Profile, select the Generate New API Key checkbox, then scroll down and click Save
|
||
Profile. Your
|
||
new
|
||
API Key
|
||
is now available for use. An API Key remains active as long as the associated UTS
|
||
account is
|
||
active.
|
||
</p>
|
||
|
||
</div><!-- end accordion content-->
|
||
</div><!-- end accordion-->
|
||
|
||
|
||
<!-- START OF COMMENTED OUT FUTURE EDITS-->
|
||
|
||
<!-- fhirapi-section-2 -->
|
||
|
||
<!--
|
||
<h4 class="accordion-header" id="heading-fhirapi-section-2">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false" aria-controls="fhirapi-section-2" onclick="window.location.href='https://www.nlm.nih.gov/vsac/support/usingvsac/vsacfhirapi.html';">Base URI, Capability Statement, Sample Queries</button>
|
||
</h4>
|
||
|
||
<div id="fhirapi-section-2" class="usa-accordion__content">
|
||
|
||
|
||
|
||
</div> -->
|
||
|
||
<p><a class="usa-button bg-base-lightest text-black"
|
||
onclick="window.location.href='https://www.nlm.nih.gov/vsac/support/usingvsac/vsacfhirapi.html'">Base
|
||
URI,
|
||
Capability Statement, Sample Queries</a></p>
|
||
|
||
|
||
|
||
|
||
<!-- -->
|
||
|
||
<!-- BEGINNING OF COMMENTED OUT FUTURE EDITS
|
||
<div class="accordion-item">
|
||
<div class="accordion-header" id="heading-fhirapi-section-2">
|
||
<button class="accordion-button collapsed bg-secondary border" type="button" data-bs-toggle="collapse" data-bs-target="#fhirapi-section-2" aria-expanded="false" aria-controls="fhirapi-section-2">Capability Statement</button>
|
||
|
||
</div>
|
||
<div id="fhirapi-section-2" class="accordion-collapse collapse" aria-labelledby="heading-vsacsvsapi-section-2" data-bs-parent="#accordion-vsacsvsapi">
|
||
<div class="accordion-body">
|
||
<p><a href="https://cts.nlm.nih.gov/fhir/" target="_blank">FHIR Terminology Service for VSAC Resources</a></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="accordion-item">
|
||
<div class="accordion-header" id="heading-fhirapi-section-2">
|
||
<button class="accordion-button collapsed bg-secondary border" type="button" data-bs-toggle="collapse" data-bs-target="#fhirapi-section-2" aria-expanded="false" aria-controls="fhirapi-section-2">Code System Filter Operator Mappings (intensional operators)</button>
|
||
|
||
</div>
|
||
<div id="fhirapi-section-2" class="accordion-collapse collapse" aria-labelledby="heading-vsacsvsapi-section-2" data-bs-parent="#accordion-vsacsvsapi">
|
||
<div class="accordion-body">
|
||
<p>WRITE SOMETHING HERE</p>
|
||
<br/>
|
||
|
||
<table class="table table-bordered">
|
||
<thead>
|
||
<tr><td colspan="6"><strong>WRITE SOMETHING HERE</td></tr>
|
||
<tr>
|
||
<th style="text-align:center">VSAC Filter Property</th>
|
||
<th style="text-align:center; white-space:nowrap">VSAC Filter Operator</th>
|
||
<th style="text-align:center">FHIR Filter Property</th>
|
||
<th style="text-align:center">Equivalent FHIR Operator</th>
|
||
<th style="text-align:center">VSAC Modifier Extension to FHIR Operator</th>
|
||
<th style="text-align:center">FHIR Compose Statement Example (JSON)</th>
|
||
</tr>
|
||
</thead>
|
||
|
||
<tr><td>Concept</td><td>All</td><td></td><td></td><td></td><td>{"include": [
|
||
{"system": "http://www.nlm.nih.gov/research/umls/sop"}
|
||
]}</td></tr>
|
||
<tr><td>Concept</td><td>ancestorOf</td><td>concept</td><td></td><td>generalizes</td>
|
||
<td><pre><code>
|
||
{"include": [
|
||
{
|
||
"system": "http://snomed.info/sct/731000124108",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "generalizes",
|
||
"value": "100000000",
|
||
"modifierExtension": [
|
||
{
|
||
"url": "vsacOpModifier",
|
||
"valueString": "ancestorOf"
|
||
} ]
|
||
} ]
|
||
}]}
|
||
</pre></code></td></tr>
|
||
<tr><td>Concept</td><td>ancestorOrSelfOf</td><td>concept</td><td>generalizes</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://snomed.info/sct/731000124108",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "generalizes",
|
||
"value": "100000000"
|
||
}]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>childOf</td><td>concept</td><td></td><td>is-a</td><td>{"include": [
|
||
{
|
||
"system": "http://snomed.info/sct/731000124108",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "is-a",
|
||
"value": "10001005",
|
||
"modifierExtension": [
|
||
{
|
||
"url": "vsacOpModifier",
|
||
"valueString": "childOf"
|
||
}]
|
||
}]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>descendantOf</td><td>concept</td><td>descendent-of</td><td></td><td>{"include": [
|
||
{
|
||
"system": " http://hl7.org/fhir/sid/icd-10-cm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "descendent-of",
|
||
"value": "N80"
|
||
}
|
||
]
|
||
}
|
||
]}</td></tr>
|
||
<tr><td>Concept</td><td>descendantOrSelfOf</td><td>concept</td><td>is-a</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://hl7.org/fhir/sid/icd-10-cm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "is-a",
|
||
"value": "N80"
|
||
} ]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>Equal</td><td>concept</td><td>=</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "=",
|
||
"value": "1000000"
|
||
} ]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>In</td><td>concept</td><td>in</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "in",
|
||
"value": "1000000,1000001"
|
||
}]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>leafOf</td><td>concept</td><td></td><td>is-a</td><td>{"include": [
|
||
{
|
||
"system": "http://hl7.org/fhir/sid/icd-10-cm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "is-a",
|
||
"value": "N80",
|
||
"modifierExtension": [
|
||
{
|
||
"url": "vsacOpModifier",
|
||
"valueString": "leafOf"
|
||
} ]
|
||
} ]
|
||
}]}</td></tr>
|
||
<tr><td>Concept</td><td>parentOf</td><td>concept</td><td></td><td>generalizes</td><td>{"include": [
|
||
{
|
||
"system": "http://hl7.org/fhir/sid/icd-10-cm",
|
||
"filter": [
|
||
{
|
||
"property": "concept",
|
||
"op": "generalizes",
|
||
"value": "N80",
|
||
"modifierExtension": [
|
||
{
|
||
"url": "vsacOpModifier",
|
||
"valueString": "parentOf"
|
||
} ]
|
||
}]
|
||
}]}</td></tr>
|
||
<tr><td>TTY</td><td>Equal</td><td>tty</td><td>=</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
|
||
"filter": [
|
||
{
|
||
"property": "tty",
|
||
"op": "=",
|
||
"value": "BN"
|
||
}]
|
||
}]}</td></tr>
|
||
<tr><td>TTY</td><td>In</td><td>tty</td><td>in</td><td></td><td>{"include": [
|
||
{
|
||
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
|
||
"filter": [
|
||
{
|
||
"property": "tty",
|
||
"op": "in",
|
||
"value": "BN,BPCK"
|
||
}
|
||
]
|
||
}
|
||
]}</td></tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
END OF COMMENTED OUT FUTURE EDITS -->
|
||
|
||
<br /><br />
|
||
|
||
</div><!-- end column-->
|
||
</div><!-- end row--><!-- end FHIR terminology service for VSAC Resources row-->
|
||
|
||
|
||
|
||
|
||
<div class="grid-row grid-gap-1"><!-- start row VSAC SVS API -->
|
||
|
||
<h3>VSAC SVS API</h3>
|
||
<p>The VSAC SVS API is based on the <a href="http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf">IHE
|
||
SVS
|
||
Technical Framework, section 2.2.21 Sharing Value Set Integration Profile (SVS)</a>, and the <a
|
||
href="ftp://ftp.ihe.net/TF_Implementation_Material/ITI/schema/IHE/SVS.xsd">IHE SVS XML
|
||
Schema</a>
|
||
</p>
|
||
|
||
|
||
<div class="tablet:grid-col-12"><!-- start column-->
|
||
|
||
|
||
|
||
<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="vsacsvsapi-section-1">Base URLs</button>
|
||
|
||
</h4>
|
||
<div id="vsacsvsapi-section-1" class="usa-accordion__content">
|
||
|
||
|
||
|
||
|
||
<p><strong>Content (SVS API) URL</strong> https://vsac.nlm.nih.gov/vsac/svs </p>
|
||
|
||
<p>Two Available VSAC SVS API Content Requests</p>
|
||
<ul>
|
||
<li>RetrieveValueSet<br />
|
||
Use this request to retrieve only the value set concept list.
|
||
This request does not retrieve value set metadata content.</li>
|
||
|
||
<li>RetrieveMultipleValueSets<br />
|
||
Use this request to retrieve value set metadata content as
|
||
well as the value set concept list.</li>
|
||
</ul>
|
||
|
||
<p><strong>Utility API URL</strong> https://vsac.nlm.nih.gov/vsac/ </p>
|
||
|
||
<p>Authentication URL: https://vsac.nlm.nih.gov/vsac/ws (Deprecated and discontinued by
|
||
November
|
||
2023.
|
||
This URL
|
||
was for use with the TGT/STS authentication method.)</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="vsacsvsapi-section-2">Authentication</button>
|
||
|
||
</h4>
|
||
<div id="vsacsvsapi-section-2" class="usa-accordion__content">
|
||
|
||
<p>The VSAC SVS API authentication service requires a free <a href="https://uts.nlm.nih.gov/">UMLS
|
||
account</a>.
|
||
<br />
|
||
|
||
Use basic authentication with your UMLS API Key.<br />
|
||
For example, if you are using a platform such as Postman, choose:
|
||
</p>
|
||
<ul>
|
||
<li> Authorization Type = Basic Auth
|
||
<li> username = ‘apikey’ or leave it blank </li>
|
||
<li> password = user’s actual UMLS API Key </li>
|
||
</ul>
|
||
|
||
<p>For software developers, here is a <a href="SVS-Client-Java.html">Java example</a> of
|
||
embedding a
|
||
VSAC SVS
|
||
API call within a program.</p>
|
||
|
||
<p>You can find your API Key in the My Profile area of the <a href="https://uts.nlm.nih.gov/">UMLS
|
||
Terminology
|
||
Services (UTS)</a> after signing in. If the API Key field in your UTS profile is
|
||
blank,
|
||
click
|
||
Edit
|
||
Profile, select the Generate New API Key checkbox, then scroll down and click Save
|
||
Profile.
|
||
Your
|
||
new
|
||
API Key
|
||
is now available for use. An API Key remains active as long as the associated UTS
|
||
account is
|
||
active.
|
||
</p>
|
||
|
||
<p><strong>NOTE:</strong>The Ticket Granting Ticket authentication for the VSAC SVS API has
|
||
been
|
||
deprecated. The
|
||
VSAC SVS API authentication method will switch exclusively to the API key authentication
|
||
method
|
||
by
|
||
the end
|
||
of November 2023. If you have a need to use this deprecated TGT/ST authentication method
|
||
between
|
||
now
|
||
and the
|
||
end of November 2023, see <a
|
||
href="https://documentation.uts.nlm.nih.gov/authentication-deprecated.html">Ticket-Granting
|
||
Ticket and
|
||
Service Ticket Documentation</a> and remember to append
|
||
"&ticket={ST}" to each of your VSAC SVS API calls.
|
||
</p>
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="vsacsvsapi-section-3">Endpoint Calls and Related Utility Calls</button>
|
||
|
||
</h4>
|
||
<div id="vsacsvsapi-section-3" class="usa-accordion__content">
|
||
|
||
|
||
<h3>Endpoints to search and retrieve VSAC content</h3>
|
||
<p>Use basic authentication with your UMLS API Key.</p>
|
||
|
||
<div class="table-example-container">
|
||
<div class="width-mobile">
|
||
<table class="usa-table">
|
||
<thead>
|
||
<tr>
|
||
<td colspan="4"><strong>Basic
|
||
URL https://vsac.nlm.nih.gov/vsac/svs</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th style="text-align:center">Request Method</th>
|
||
<th style="text-align:center; white-space:nowrap">Path<p class="normal">
|
||
Click to
|
||
view use
|
||
cases, sample calls and output</p>
|
||
</th>
|
||
<th style="text-align:center">Description</th>
|
||
<th style="text-align:center">Related Utility Calls<p class="normal">
|
||
Click
|
||
to
|
||
view
|
||
use
|
||
cases, sample calls and output</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/mostrecentexpansion.html">/RetrieveMultipleValueSets?id={oid}</a>
|
||
</td>
|
||
<td><strong>Retrieve Most Recent Value Set Expansions: </strong>
|
||
includes
|
||
value
|
||
set
|
||
metadata
|
||
and concept list.</td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/mostrecentexpansion.html">/RetrieveValueSet?id={oid}</a>
|
||
</td>
|
||
<td><strong>Retrieve Most Recent Value Set Expansions: </strong>
|
||
includes
|
||
only
|
||
value
|
||
set
|
||
concept list, no metadata.</td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/programreleaseexpansion.html">/RetrieveMultipleValueSets?id={oid}&release={releaseName}</a>
|
||
</td>
|
||
<td><strong>Retrieve Value Set Expansions Published by a Program
|
||
Release</strong>
|
||
</td>
|
||
<td><a
|
||
href="svsapiendpoints/programs.html">https://vsac.nlm.nih.gov/vsac/programs<br /><br />https://vsac.nlm.nih.gov/vsac/program/{programName}<br /><br />https://vsac.nlm.nih.gov/vsac/oid/{oid}/programs<br /><br />https://vsac.nlm.nih.gov/vsac/oid/{oid}/program/{programName}</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/expansionversion.html">/RetrieveMultipleValueSets?id={oid}&version={version}</a>
|
||
</td>
|
||
<td><strong>Retrieve Value Set Expansion for a Specified Expansion
|
||
Version</strong>
|
||
</td>
|
||
<td><a
|
||
href="svsapiendpoints/listexpansionversions.html">https://vsac.nlm.nih.gov/vsac/oid/{oid}/versions</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/expansionprofile.html">/RetrieveMultipleValueSets?id={oid}&profile={profileName}</a>
|
||
</td>
|
||
|
||
<td><strong>Retrieve Value Set Expansion Calculated with Expansion
|
||
Profile:
|
||
</strong>Use the
|
||
utility call <a
|
||
href="svsapiendpoints/listexpansionprofiles.html">https://vsac.nlm.nih.gov/vsac/program/{programName}/latest
|
||
profile</a> to retrieve a specified program's (example: "CMS
|
||
eCQM
|
||
and
|
||
Hybrid
|
||
Measure") latest expansion profile.</td>
|
||
|
||
<td><a href="svsapiendpoints/listexpansionprofiles.html">https://vsac.nlm.nih.gov/vsac/profiles<br /><br />
|
||
https://vsac.nlm.nih.gov/vsac/program/{programName}/latest
|
||
profile</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/includedraft.html">/RetrieveMultipleValueSets?id={oid}&profile={profileName}&includeDraft=yes</a>
|
||
</td>
|
||
<td><strong>Retrieve Value Set Expansion of a Draft Value Set
|
||
Definition:
|
||
</strong>Use the
|
||
includeDraft parameter to retrieve a temporary expansion of draft
|
||
value
|
||
set
|
||
content.
|
||
Only VSAC authors and stewards, who are members of at least one VSAC
|
||
author
|
||
or
|
||
steward
|
||
group, have permissions to retrieve any draft content.</td>
|
||
<td><a href="svsapiendpoints/listexpansionprofiles.html">https://vsac.nlm.nih.gov/vsac/profiles<br /><br />
|
||
https://vsac.nlm.nih.gov/vsac/program/{programName}/latest
|
||
profile</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/all-vs-for-an-ecqmeasure.html">/RetrieveMultipleValueSets?tagName={tagName}&tagValue={tagValue}</a>
|
||
</td>
|
||
<td><strong>Retrieve Expansions for All Value Sets Specified by a CMS
|
||
eMeasure
|
||
ID,
|
||
or
|
||
eMeasure Identifier, or NQF Number</strong></td>
|
||
<td><a href="svsapiendpoints/tagnames.html">https://vsac.nlm.nih.gov/vsac/tagNames<br /><br />
|
||
https://vsac.nlm.nih.gov/vsac/tagName/{tagName}/tagValues
|
||
</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/effectivedate.html">/RetrieveMultipleValueSets?id={oid}&effectiveDate={yyyymmdd}</a>
|
||
</td>
|
||
<td><strong>Retrieve a Value Set Expansion Published on or before a
|
||
Specific
|
||
Date</strong>
|
||
</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><a
|
||
href="svsapiendpoints/effectivedate.html">/RetrieveMultipleValueSets?id={oid}&effectiveDate={yyyymmdd}&programType=eCQM</a>
|
||
</td>
|
||
<td><strong>Retrieve a Value Set Expansion Published on or before a
|
||
Specific
|
||
Date</strong>
|
||
in the most recent eCQM program release.</td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
</div><!-- end div width mobile-->
|
||
</div><!-- end table example container-->
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="vsacsvsapi-section-4">Parameter Descriptions</button>
|
||
|
||
</h4>
|
||
|
||
<div id="vsacsvsapi-section-4" class="usa-accordion__content">
|
||
|
||
<table class="usa-table">
|
||
|
||
<thead>
|
||
|
||
<tr>
|
||
|
||
<th style="text-align:center">Parameter<p class="normal">Click to view use
|
||
cases,
|
||
sample
|
||
calls
|
||
and
|
||
output</p>
|
||
</th>
|
||
|
||
<th style="text-align:center">Description</th>
|
||
|
||
<th style="text-align:center">Use Case</th>
|
||
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/effectivedate.html">effectiveDate</a></td>
|
||
<td>A date on or before which a published value set expansion is published and
|
||
available
|
||
in the
|
||
VSAC
|
||
public repository.</td>
|
||
<td><strong>Retrieve a Value Set Expansion Published on or before a Specific
|
||
Date</strong></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>id</td>
|
||
<td>Value set object unique identifier (OID).</td>
|
||
<td></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/includedraft.html">includeDraft</a></td>
|
||
<td>Allows retrieval of a non-published draft value set definition. Value is
|
||
'yes'
|
||
or
|
||
'no'.</td>
|
||
<td><strong>Retrieve Value Set Expansion of a Draft Value Set
|
||
Definition</strong>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/expansionprofile.html">latest profile</a></td>
|
||
<td>A specified program's latest expansion profile label that defines a
|
||
calculation
|
||
algorithm
|
||
that
|
||
applies predetermined code system versions and legacy codes. Example: 'eCQM
|
||
Update
|
||
2020-05-07'.
|
||
</td>
|
||
<td><strong>Retrieve Value Set Expansion Calculated with Expansion
|
||
Profile</strong>
|
||
</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/expansionprofile.html">profile</a></td>
|
||
<td>An expansion profile label that defines a calculation algorithm that applies
|
||
predetermined
|
||
code
|
||
system versions and legacy codes. Examples: 'eCQM Update 2019-05-10', or
|
||
'Most
|
||
Recent Code
|
||
System Versions in VSAC'.</td>
|
||
<td><strong>Retrieve Value Set Expansion Calculated with Expansion
|
||
Profile</strong>
|
||
</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/programs.html">program</a></td>
|
||
<td>"Program" is the word VSAC applies to the administrative organization and/or
|
||
application
|
||
that
|
||
sponsors, authors and stewards a published release of value sets that
|
||
together
|
||
serve
|
||
a
|
||
purpose.
|
||
A program has a pre-arranged agreement with VSAC to publish their value sets
|
||
as
|
||
a
|
||
group.
|
||
</td>
|
||
<td><strong>VSAC Utility API Calls: 'programs' and 'latest profile' for
|
||
program:</strong>
|
||
<ul>
|
||
<li>Retrieve all release names and releaseDates for a given program name
|
||
</li>
|
||
<li>Retrieve all published program releases (release names) for a given
|
||
value
|
||
set OID
|
||
and
|
||
program name</li>
|
||
<li>Return the value of the most recently available expansion profile to
|
||
be
|
||
used
|
||
by the
|
||
specified program in an upcoming VSAC program release of that
|
||
program's
|
||
value set
|
||
content. Value of latest profile is subject to change according to
|
||
the
|
||
goals
|
||
of the
|
||
program it represents</li>
|
||
</ul>
|
||
</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/programs.html">programs</a></td>
|
||
<td>Retrieve all program name values for programs supported by VSAC.</td>
|
||
<td><strong>VSAC Utility API Calls: 'programs' and 'latest profile' for
|
||
program:</strong>
|
||
<ul>
|
||
<li>Retrieve available values for programs that will enable you to then
|
||
retrieve
|
||
release
|
||
name values for a program of interest.</li>
|
||
</ul>
|
||
</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/effectivedate.html">programType</a></td>
|
||
<td>The name of a program that contains the requested OID. Available value: eCQM
|
||
</td>
|
||
<td><strong>Retrieve a Value Set Expansion Published on or before a Specific
|
||
Date:</strong> by a
|
||
specified program.</td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/programreleaseexpansion.html">release</a></td>
|
||
<td>Name of a program release. A program release contains multiple pre-selected
|
||
value
|
||
sets
|
||
designated by the program's release manager.</td>
|
||
<td><strong>Retrieve Value Set Expansions Published by a Program
|
||
Release</strong>
|
||
</td>
|
||
|
||
</tr>
|
||
|
||
<!--
|
||
<tr>
|
||
<td>subType</td>
|
||
<td>The name of a subtype designated by a program such as eCQM. Available values: 'EP/EC' and 'EH'. Must be used together with programType=eCQM.</td>
|
||
<td></td>
|
||
|
||
</tr>
|
||
-->
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/all-vs-for-an-ecqmeasure.html">tagName</a></td>
|
||
<td>A tag for a collection of value sets, for example: 'CMS eMeasure ID'. Must
|
||
be
|
||
used
|
||
together
|
||
with
|
||
'tagValue'.</td>
|
||
<td><strong>Retrieve Expansions for All Value Sets Specified by a CMS eMeasure
|
||
ID,
|
||
or
|
||
eMeasure
|
||
Identifier, or NQF Number</strong></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/all-vs-for-an-ecqmeasure.html">tagNames</a></td>
|
||
<td>Retrieves all supported tagNames.</td>
|
||
<td><strong>Retrieve Expansions for All Value Sets Specified by a CMS eMeasure
|
||
ID,
|
||
or
|
||
eMeasure
|
||
Identifier, or NQF Number</strong></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/all-vs-for-an-ecqmeasure.html">tagValue</a></td>
|
||
<td>The value of a member within a collection (tagName) of value sets. For
|
||
example,
|
||
'CMS68v9' is
|
||
one
|
||
of the valid values (tagValue) within the tagName CMS eMeasure ID.</td>
|
||
<td><strong>Retrieve Expansions for All Value Sets Specified by a CMS eMeasure
|
||
ID,
|
||
or
|
||
eMeasure
|
||
Identifier, or NQF Number</strong></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/all-vs-for-an-ecqmeasure.html">tagValues</a></td>
|
||
<td>Retrieves all supported tagValues.</td>
|
||
<td><strong>Retrieve Expansions for All Value Sets Specified by a CMS eMeasure
|
||
ID,
|
||
or
|
||
eMeasure
|
||
Identifier, or NQF Number</strong></td>
|
||
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><a href="svsapiendpoints/expansionversion.html">version</a></td>
|
||
<td>A release version label that uniquely identifies a specific value set
|
||
expansion.
|
||
For
|
||
example:
|
||
'eCQM Update 2017-05-05' or '20170505'.</td>
|
||
<td><strong>Retrieve Value Set Expansion for a Specified Expansion
|
||
Version</strong>
|
||
</td>
|
||
|
||
</tr>
|
||
</tbody>
|
||
|
||
</table>
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
|
||
<h4 class="usa-accordion__heading">
|
||
<button class="usa-accordion__button" type="button" aria-expanded="false"
|
||
aria-controls="vsacsvsapi-section-5">HTTP Binding</button>
|
||
|
||
</h4>
|
||
|
||
<div id="vsacsvsapi-section-5" class="usa-accordion__content">
|
||
<p>All the value set transactions described in this document are represented by a RESTful
|
||
URL
|
||
and
|
||
one or
|
||
more
|
||
request parameters. The HTTP request uses the GET method for RetrieveValueSet and
|
||
RetrieveMultipleValueSets.
|
||
Encode each parameter as an HTTP Get parameter. The Content-Type field of the HTTP
|
||
header
|
||
shall
|
||
be
|
||
'text/xml'. The HTTP request returns an error code if the request parameters are
|
||
invalid, or
|
||
if
|
||
the
|
||
specified parameter combination is not supported. The request returns an HTTP status
|
||
code of
|
||
404, with
|
||
an
|
||
HTTP Warning header containing warning code 111, and warning text 'INV: Invalid search
|
||
parameters'. A
|
||
request with valid parameters and parameter combinations that finds no matching value
|
||
set is
|
||
not
|
||
an
|
||
error.
|
||
It will return an empty body with HTTP status code of 200.</p>
|
||
|
||
|
||
|
||
|
||
</div><!-- end accordion content-->
|
||
|
||
</div><!-- end accordion-->
|
||
</div><!-- end column-->
|
||
</div><!-- end VSAC SVS API row-->
|
||
|
||
|
||
|
||
|
||
<p class=”margin-top-5”><small>Last Reviewed: September 7, 2023</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>
|
||
|
||
|