publicdata/nih-gov
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nih-gov/www.nlm.nih.gov/vsac/support/usingvsac/vsacfhirapi.html
Scott Williams 7bcb500d37 Initial commit.
2025-02-26 13:17:41 -05:00

601 lines
30 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="stylesheet" href="/home_assets/uswds/css/styles.css">
<title>FHIR Terminology Service for VSAC 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="FHIR Terminology Service for VSAC Resources" />
<meta name="DC.Subject.Keyword" content="VSAC HL7 FHIR API ValueSet CodeSystem" />
<meta name="DC.Publisher" content="U.S. National Library of Medicine" />
<meta name="DC.Date.Issued" content="2021-06-21" />
<meta name="DC.Date.Modified" content="2024-08-20" />
<meta name="NLMDC.Date.LastReviewed" content="2024-08-20" />
<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="grid-col">
<div class="h1">FHIR Terminology Service for VSAC Resources</div>
</div>
</div>
<div class="grid-row" id="vsacfhir"><!-- start row--><!-- start intro paragraph row-->
<div class="tablet:grid-col">
<h1 style="display: block ! important;" class="vsacheader"></h1>
<!-- <h2 style="text-align:left; float:left;">
FHIR<sup>&reg;</sup> Terminology Service for VSAC Resources
</h2> -->
<hr style="clear: both;" />
<br />
<p id="fhirInfo">
The FHIR Terminology Service for VSAC Resources is a REST API service for accessing the VSAC value sets and supported code systems. This service requires a free <a href="https://uts.nlm.nih.gov/uts/signup-login" target='_blank'>Unified Medical Language System<sup>&reg;</sup> Metathesaurus License</a>, due to usage restrictions on some of the codes included in the
value sets.
</p>
<p>The VSAC FHIR API is subject to change as we update it according to the developing <a
href="https://hl7.org/fhir/us/cqfmeasures/STU4/index.html" target='_blank'>HL7 Quality Measure
Implementation Guide (QMIG)</a> specifications and CMS requirements. Please refer to our <a href="https://cts.nlm.nih.gov/fhir/metadata">Capability
Statement</a> for full documentation of the VSAC FHIR API.</p>
<br />
</div><!-- end col-->
</div><!-- end row--><!-- end intro paragraph row-->
<div class="grid-row"><!-- start row-->
<div class="tablet:grid-col">
<h3>Authentication</h3>
<p>Use basic authentication with your UMLS API Key. For
example, if you are using a platform such as Postman, choose:<br />
<strong>Authorization Type</strong> = Basic Auth; <br />
<strong>Username</strong> = ‘apikey’ or leave it blank; <br />
<strong>Password</strong> = user’s actual UMLS API Key. <br />
You can find your API Key in the <a class="usa-link" href="https://uts.nlm.nih.gov/" target="_blank">My
Profile</a> area after signing in to the
UMLS. <br />
</p>
<h3>Additional Information</h3>
<ul>
<li>Using the VSAC FHIR API assumes your familiarity with the <a href="https://www.hl7.org/fhir/terminologies.html">HL7 FHIR Terminology Module</a> resources and the operations outlined in the VSAC FHIR Capability Statement.</li>
<li>VSAC value set identifiers must be specified as a VSAC value set object identifier (OID). Value set names are not unique in VSAC.</li>
<li>Due to performance and resource size concerns, VSAC FHIR does not display hierarchy information for <a href="https://www.hl7.org/fhir/codesystem.html">CodeSystem</a> definitions. Additionally, VSAC FHIR displays the complete code list only if the total number of code system codes is less than 1200. If the number of codes exceeds 1200, VSAC FHIR returns just one example code. You can explore each code system's full hierarchy and complete code list in the <a href="https://vsac.nlm.nih.gov/context/cs/codesystem/CDCREC/version/1.2/code/1000-9/info">Browse Code System</a> functionality in the VSAC web browser.</li>
<li><a href="https://www.nlm.nih.gov/vsac/support/usingvsac/mapping-review-statuses.html">Mapping of Value Set Review Statuses between VSAC and FHIR</a></li>
<li><a href="https://www.nlm.nih.gov/vsac/support/usingvsac/vsacname-fhirname-fhirtitle.html">VSAC Value Set Name, FHIR Value Set Name and FHIR Value Set Title</a></li>
</ul>
<br />
<h3>FHIR version 4.0.1</h3>
<table class="usa-table">
<tr>
<td style="vertical-align:top"><strong>Base URI:</strong> https://cts.nlm.nih.gov/fhir/<br />
<strong>Base URI for Testing:</strong> https://uat-cts.nlm.nih.gov/fhir/<br />
<a class="usa-link" href="https://support.nlm.nih.gov/">Contact us</a> for permissions to use
the User
Acceptance Testing (UAT) server.
</td>
</tr>
<tr>
<td style="vertical-align:top"><strong>Capability Statement (public):</strong> <a
href="https://cts.nlm.nih.gov/fhir/metadata?_format=html/json">JSON |</a> <a
href="https://cts.nlm.nih.gov/fhir/metadata?_format=html/xml"> XML</a><br>
<strong>Capability Statement (UAT):</strong> <a
href="https://uat-cts.nlm.nih.gov/fhir/metadata?_format=html/json">JSON |</a> <a
href="https://uat-cts.nlm.nih.gov/fhir/metadata?_format=html/xml"> XML</a>
</td>
</tr>
</table>
<br />
If you need to access the previous FHIR version 3.0, use the <a class="usa-link"
href="http://www.hl7.org/fhir/http.html#version-parameter">MIME-type parameter <em>fhirVersion</em></a>
in your
Accept header to indicate which version of the FHIR release you intend to use. If you do not specify a FHIR
version
in the Accept header, then the default FHIR 4.0.1 shall be used. Any other Accept <em>fhirVersion</em> value
shall
return an error.
<br />
<div style="padding: 0px 70px">Accept:&nbsp;&nbsp; application/fhir+json; fhirVersion=3.0</div>
<br />
</div><!-- end col-->
</div><!-- end row--><!-- end Authentication and Version row-->
<div class="grid-row"><!-- start row--> <!-- start Sample Queries row-->
<div class="tablet:grid-col">
<h3>Sample Queries</h3>
<p>Study the Capability Statements above to discover all supported parameters.</p>
<table class="usa-table">
<thead>
<tr>
<th>FHIR Resource</th>
<th>FHIR Operation</th>
<th>Examples</th>
<th>Use Case</th>
</tr>
</thead>
<tr>
<td><a class="usa-link" href="https://www.hl7.org/fhir/valueset.html">ValueSet</a></td>
<td>&nbsp;</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.46</td>
<td>Retrieve FHIR compose statement (VSAC definition) for specified intensional (logically
defined) value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.464.1003.113.11.1090</td>
<td>Retrieve the FHIR compose statement (VSAC definition) for specified extensional value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/ValueSet-operation-expand.html">$expand</a>
</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.464.1003.113.11.1090/$expand</td>
<td>Retrieve expansion for specified extensional value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/ValueSet-operation-expand.html">$expand</a></td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.464.1003.113.11.1090/$expand?filter=spine</td>
<td>Retrieve expansion of codes and descriptors matching filter=spine within specified extensional value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/ValueSet-operation-expand.html">$expand</a></td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.46/$expand</td>
<td>Retrieve expansion for specified intensional (logically defined) value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link"
href="https://www.hl7.org/fhir/ValueSet-operation-validate-code.html">$validate-code</a></td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.464.1003.113.11.1090/$validate-code?system=http://hl7.org/fhir/sid/icd-10-cm&amp;code=M45.0</td>
<td>Validate that a coded value is in the set of codes allowed by specified value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem.html">CodeSystem</a></td>
<td>&nbsp;</td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/CDCREC</td>
<td>Retrieve details of a code system.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-lookup.html">$lookup</a>
</td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&amp;code=1963-8</td>
<td>Retrieve details of a code from a code system.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-lookup.html">$lookup</a></td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&amp;code=1963-8&amp;version=2.56</td>
<td>Retrieve details of a code from a code system version.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-lookup.html">$lookup</a></td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&amp;code=1963-8&amp;date=20150501</td>
<td>Retrieve details of a code from a code system as of specified date.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-subsumes.html">$subsumes</a></td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$subsumes?system=http://snomed.info/sct&amp;codeA=29857009&amp;codeB=10000006</td>
<td>Test subsumption relationship between code A and code B.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-subsumes.html">$subsumes</a></td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$subsumes?system=http://hl7.org/fhir/sid/icd-10-cm&amp;version=2018&amp;codeA=A01.01&amp;codeB=A00-A09</td>
<td>Test subsumption relationship between code A and code B, given a code system version.</td>
</tr>
</table>
<br />
</div><!-- end col-->
</div><!-- end row--><!-- end Sample Queries row-->
<div class="grid-row"><!-- start row--><!-- start Special Cases row-->
<div class="tablet:grid-col">
<h3>Special Cases with No UMLS Authentication Requirement</h3>
<table class="usa-table">
<thead>
<tr>
<th>FHIR Resource</th>
<th>FHIR Operation</th>
<th>Examples</th>
<th>Use Case</th>
</tr>
</thead>
<tr>
<td><a class="usa-link" href="https://www.hl7.org/fhir/valueset.html">ValueSet</a></td>
<td>&nbsp;</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet?usage=VSAC$covid</td>
<td>Retrieve the current list of COVID-19 value sets designated by authors in VSAC. <a class="usa-link"
href="https://www.nlm.nih.gov/vsac/support/usingvsac/covid19valuesets.html">More
information.</a>
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1114.13</td>
<td>Retrieve FHIR compose statement (VSAC definition) for specified COVID-19 value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/ValueSet-operation-expand.html">$expand</a>
</td>
<td>https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1114.13/$expand</td>
<td>Retrieve expansion for specified COVID-19 value set.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem.html">CodeSystem</a></td>
<td><a class="usa-link" href="https://www.hl7.org/fhir/codesystem-operation-lookup.html">$lookup</a>
</td>
<td>https://cts.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://www.nlm.nih.gov/research/umls/rxnorm&amp;code=1000000
</td>
<td>Retrieve details of a specified code from RxNorm.</td>
</tr>
</table>
</div><!-- end row-->
</div><!-- end row--><!-- end Special Queries row-->
<p class=”margin-top-5”><small>Last Reviewed: August 20, 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 margin-bottom-1">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="https://www.nlm.nih.gov/images/twitter.svg" class="padding-1 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>
Reference in a new issue View git blame Copy permalink