917 lines
44 KiB
HTML
917 lines
44 KiB
HTML
|
||
<!DOCTYPE html>
|
||
<html lang="en" id="general" class="nojs us" data-root="https://medlineplus.gov/">
|
||
|
||
<head>
|
||
|
||
<meta charset="utf-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||
<meta http-equiv="window-target" content="_top" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://medlineplus.gov/medlineplus-connect/web-service/" />
|
||
|
||
|
||
|
||
|
||
<link href="https://medlineplus.gov/medlineplus-connect/web-service/" hreflang="x-default" rel="alternate">
|
||
|
||
|
||
|
||
|
||
<meta name="ac-dictionary" content="medlineplus-ac-dictionary" />
|
||
|
||
<meta name="description" content="MedlinePlus Connect is available as a web service. Learn more about implementing the web service and how it responds to requests for information." />
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="https://medlineplus.gov/images/favicon.ico" type="image/x-icon" />
|
||
<link rel="apple-touch-icon" href="https://medlineplus.gov/images/touch-icon.png" />
|
||
|
||
|
||
<meta property="fb:app_id" content="1042245625821448" />
|
||
|
||
|
||
|
||
<meta property="og:title" content="MedlinePlus: MedlinePlus Connect: Web Service" />
|
||
<meta property="og:url" content="https://medlineplus.gov/medlineplus-connect/web-service/" />
|
||
|
||
|
||
|
||
<meta property="og:image" content="https://medlineplus.gov/images/mplus_fb.jpg" />
|
||
|
||
|
||
|
||
<meta property="og:description" content="MedlinePlus Connect is available as a web service. Learn more about implementing the web service and how it responds to requests for information." />
|
||
|
||
|
||
<meta name="twitter:card" content="summary_large_image" />
|
||
<meta name="twitter:site" content="@medlineplus" />
|
||
<meta name="twitter:creator" content="@medlineplus" />
|
||
<meta name="twitter:title" content="MedlinePlus: MedlinePlus Connect: Web Service" />
|
||
<meta name="twitter:description" content="MedlinePlus Connect is available as a web service. Learn more about implementing the web service and how it responds to requests for information." />
|
||
<meta name="twitter:image" content="https://medlineplus.gov/images/mplus_fb.png" />
|
||
|
||
<meta name="twitter:image:alt" content=""/>
|
||
<meta property="og:image:alt" content="" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<title>MedlinePlus: MedlinePlus Connect: Web Service</title>
|
||
|
||
<link rel="stylesheet" href="https://medlineplus.gov/css/common_new.css?1738956700331" />
|
||
<!--[if IE 8]> <link rel="stylesheet" href="https://medlineplus.gov/css/ie8/common.css"> <![endif]-->
|
||
<link rel="stylesheet" href="https://medlineplus.gov/uswds/css/uswds_styles.css" />
|
||
|
||
<link rel="stylesheet" href="https://medlineplus.gov/utilities/lostatic.css">
|
||
|
||
|
||
|
||
<script type="text/javascript">document.getElementsByTagName('html')[0].className = document.getElementsByTagName('html')[0].className.replace( /(?:^|\s)nojs(?!\S)/g , '').trim();</script>
|
||
<script src="https://medlineplus.gov/uswds/js/uswds-init.min.js" type="text/javascript"></script>
|
||
|
||
|
||
|
||
|
||
<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=
|
||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||
})(window,document,'script','dataLayer','GTM-MMVM77');</script>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MMVM77"
|
||
height="0" width="0" style="display:none;visibility:hidden" title="googletagmanager"></iframe></noscript>
|
||
|
||
|
||
|
||
<a name="top" id="top"></a>
|
||
<a class="hide-offscreen" href="#start">Skip navigation</a>
|
||
|
||
|
||
|
||
<section
|
||
class="usa-banner"
|
||
aria-label="Official website of the United States government"
|
||
>
|
||
<div class="usa-accordion">
|
||
<header class="usa-banner__header">
|
||
<div class="usa-banner__inner">
|
||
<div class="grid-col-auto">
|
||
<img
|
||
aria-hidden="true"
|
||
class="usa-banner__header-flag"
|
||
src="https://medlineplus.gov/uswds/img/us_flag_small.png"
|
||
alt=""
|
||
/>
|
||
</div>
|
||
<div class="grid-col-fill tablet:grid-col-auto" aria-hidden="true">
|
||
<p class="usa-banner__header-text">
|
||
An official website of the United States government
|
||
</p>
|
||
<p class="usa-banner__header-action">Here’s how you know</p>
|
||
</div>
|
||
<button
|
||
type="button"
|
||
class="usa-accordion__button usa-banner__button"
|
||
aria-expanded="false"
|
||
aria-controls="gov-banner-default-default"
|
||
>
|
||
<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-default-default"
|
||
>
|
||
<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://medlineplus.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://medlineplus.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-description-default"
|
||
focusable="false"
|
||
>
|
||
<title id="banner-lock-title-default">Lock</title>
|
||
<desc id="banner-lock-description-default">Locked padlock icon</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>
|
||
</section>
|
||
|
||
|
||
<div id="mplus-wrap">
|
||
<header>
|
||
<div id="mplus-header">
|
||
|
||
<div id="mplus-orgs">
|
||
<a href="https://www.nih.gov/" class="nih-org" target="_blank" title="National Institutes of Health">
|
||
<img class="nihlogo" src="https://medlineplus.gov/images/nihlogo.png" alt="National Institutes of Health"/>
|
||
</a><a href="https://www.nlm.nih.gov/" target="_blank"> National Library of Medicine</a>
|
||
</div>
|
||
|
||
|
||
<div id="mplus-logo" class="years-25">
|
||
<a href="https://medlineplus.gov/">
|
||
<img alt="MedlinePlus Trusted Health Information for You" title="MedlinePlus Trusted Health Information for You" src="https://medlineplus.gov/images/m_logo_25.png"/>
|
||
</a>
|
||
</div>
|
||
|
||
|
||
<div id="mplus-nav">
|
||
|
||
<div aria-live="polite" class="sm-live-area hide-offscreen"></div>
|
||
<button id="sm-menu-btn" class="navmenu-btn" title="Menu" role="button" aria-controls="mplus-menu-list" type="submit">Menu<span class="icon icon-nav-menu"></span></button>
|
||
<ul id="mplus-menu-list" class="nav-list">
|
||
<li><a href="https://medlineplus.gov/healthtopics.html">Health Topics</a></li>
|
||
<li><a href="https://medlineplus.gov/druginformation.html">Drugs & Supplements</a></li>
|
||
<li><a href="https://medlineplus.gov/genetics/">Genetics</a></li>
|
||
<li><a href="https://medlineplus.gov/lab-tests/">Medical Tests</a></li>
|
||
<li><a href="https://medlineplus.gov/encyclopedia.html">Medical Encyclopedia</a></li>
|
||
<li><a href="https://medlineplus.gov/about/">About MedlinePlus</a></li>
|
||
</ul><button id="sm-search-btn" class="navmenu-btn" title="Search" role="button" aria-controls="mplus-search" type="submit"><span class="hide-offscreen"></span>Search<span class="icon icon-nav-search"></span></button>
|
||
|
||
<div class="top-1">
|
||
|
||
<form id="mplus-search" method="get" action="https://vsearch.nlm.nih.gov/vivisimo/cgi-bin/query-meta" title="Search MedlinePlus" target="_self">
|
||
|
||
<input type="hidden" name="v:project" value="medlineplus"/>
|
||
<input type="hidden" name="v:sources" value="medlineplus-bundle"/>
|
||
|
||
<div class="form-box text-combo">
|
||
<div class="form-area"><label class="hide-offscreen" for="searchtext_primary">Search MedlinePlus</label>
|
||
<input id="searchtext_primary" class="form-text" type="text" placeholder="Search MedlinePlus" alt="#Site Search input" title="Site Search input" maxlength="400" size="40" name="query" autocomplete="off" role="textbox" aria-autocomplete="list" aria-haspopup="true"/>
|
||
</div>
|
||
<div class="button-area">
|
||
<button class="form-btn" title="Search MedlinePlus" alt="Search MedlinePlus" type="submit">GO</button>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
|
||
<div class="secondarynav">
|
||
<ul class="nav-list">
|
||
<li><a href="https://medlineplus.gov/about/"><span>About MedlinePlus</span></a></li>
|
||
<li><a href="https://medlineplus.gov/whatsnew/">What's New</a></li>
|
||
<li><a href="https://medlineplus.gov/sitemap.html"><span>Site Map</span></a></li>
|
||
|
||
|
||
<li><a href="https://support.nlm.nih.gov/knowledgebase/category/?id=CAT-01231&category=medlineplus&from=https%3A//medlineplus.gov/medlineplus-connect/web-service/" target="_blank"><span>Customer Support</span></a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
<div id="mplus-nav-bar">
|
||
<ul class="nav-list">
|
||
<li><a href="https://medlineplus.gov/healthtopics.html">Health Topics</a></li><li><a href="https://medlineplus.gov/druginformation.html">Drugs & Supplements</a></li><li><a href="https://medlineplus.gov/genetics/">Genetics</a></li><li><a href="https://medlineplus.gov/lab-tests/">Medical Tests</a></li><li><a href="https://medlineplus.gov/encyclopedia.html">Medical Encyclopedia</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</header>
|
||
|
||
<div id="mplus-content">
|
||
|
||
<div id="breadcrumbs">
|
||
<div itemprop="breadcrumb" itemscope="" itemtype="http://schema.org/BreadcrumbList">
|
||
<span class="hide-offscreen">You Are Here:</span>
|
||
<div itemscope itemprop="itemListElement" itemtype="http://schema.org/ListItem">
|
||
<a href="https://medlineplus.gov/" itemprop="item"><span itemprop="name">Home</span></a>
|
||
→
|
||
<meta itemprop="position" content="1"/>
|
||
</div>
|
||
|
||
|
||
<div itemscope itemprop="itemListElement" itemtype="http://schema.org/ListItem">
|
||
<a href="https://medlineplus.gov/medlineplus-connect/" itemprop="item"><span itemprop="name">MedlinePlus Connect</span></a>
|
||
→
|
||
<meta itemprop="position" content="2"/>
|
||
</div>
|
||
|
||
|
||
|
||
<div>
|
||
<span>MedlinePlus Connect: Web Service</span>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<span class="page-url print-only">URL of this page: https://medlineplus.gov/medlineplus-connect/web-service/</span>
|
||
|
||
<div >
|
||
|
||
<article>
|
||
<div class="page-info">
|
||
<div class="page-title">
|
||
<a name="start" id="start"></a>
|
||
<h1>MedlinePlus Connect: Web Service</h1>
|
||
</div>
|
||
<div class="page-actions"></div>
|
||
<noscript><span class="js-disabled-message">To use the sharing features on this page, please enable JavaScript.</span></noscript>
|
||
</div>
|
||
<div class="main-one">
|
||
|
||
<section><div class="mp-content"><!-- BEGIN "ON THIS PAGE - TOC" -->
|
||
<div class="resrow">
|
||
<div class="connect-toc-onethird">
|
||
<section>
|
||
<div class="connect-toc-border">
|
||
<div>
|
||
<span class="connect-toc-label">On this page</span>
|
||
</div>
|
||
<div>
|
||
<ul class="bulletlist">
|
||
<li><a href="#overview">Web Service Overview</a></li>
|
||
<li><a href="#diagnosis">Diagnosis (Problem) Code Requests</a></li>
|
||
<li><a href="#medication">Drug Code Requests</a></li>
|
||
<li><a href="#labs">Lab Test Code Requests</a></li>
|
||
<li><a href="#procedures">Medical Procedure Code Requests</a></li>
|
||
<li><a href="#acceptableusepolicy">Acceptable Use Policy</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="clear">
|
||
<br/>
|
||
</div>
|
||
<!-- END "ON THIS PAGE - TOC" -->
|
||
<p>
|
||
<a href="https://medlineplus.gov/medlineplus-connect/">MedlinePlus Connect</a> is available as a <a href="https://medlineplus.gov/medlineplus-connect/web-application/">Web application</a> or Web service. Below are the technical details for implementing the Web service, which responds to requests based on: diagnosis (problem) code requests, drug code requests, lab test code requests, and medical procedure code requests.
|
||
</p>
|
||
<p>
|
||
You are welcome to link to and display the data returned by MedlinePlus Connect. You may not copy MedlinePlus pages onto your site. If you use data from the MedlinePlus Connect Web Service, please indicate that the information is from <a href="https://medlineplus.gov/">MedlinePlus.gov</a> but do not use the MedlinePlus logo or otherwise imply that MedlinePlus endorses your particular product. For more information on how to link to MedlinePlus content outside of this service, please see our <a href="https://medlineplus.gov/about/using/usingcontent/">guidelines and instructions</a> on linking.
|
||
</p>
|
||
<p>
|
||
If you decide to use MedlinePlus Connect, sign up for the <a href="https://medlineplus.gov/medlineplus-connect/email-list/">email list</a> to keep up with developments and exchange ideas with your colleagues. Please tell us if you implement MedlinePlus Connect by <a href="https://support.nlm.nih.gov/support/create-case/?category=medlineplus_connect&from=https://medlineplus.gov/medlineplus-connect/web-service/" target="_blank">contacting us</a>.
|
||
</p>
|
||
<section>
|
||
<h2>
|
||
<a name="overview"></a>Web Service Overview</h2>
|
||
<p>
|
||
The parameters for the Web service requests conform to the <a href="https://www.hl7.org/implement/standards/product_brief.cfm?product_id=22" target="TheNewWin">HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide</a>. The REST-based response conforms to the <a href="https://www.hl7.org/implement/standards/product_brief.cfm?product_id=283" target="TheNewWin">HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide</a>. The output of the request can be XML in the Atom feed format, JSON, or JSONP.
|
||
</p>
|
||
<p>
|
||
The structure of the request indicates what type of code you are sending. In all cases, the base URL for the Web service is:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service
|
||
</span>
|
||
</p>
|
||
<p>
|
||
MedlinePlus Connect uses HTTPS connections. HTTP requests will not be accepted and existing implementations using HTTP should update to HTTPS.
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2>
|
||
<a id="output" name="output"></a>Output Parameters </h2>
|
||
<p>
|
||
These parameters are optional. If you leave them out, the default response is English information in XML format.
|
||
</p>
|
||
<p>
|
||
<span class="text-label">Language</span>
|
||
<br/> Identify if you would like the response to be in English or Spanish. MedlinePlus Connect will assume English is the language if it is not specified.
|
||
</p>
|
||
<p>
|
||
If you wish the response to the problem code lookup to be in Spanish, use :
|
||
<span class="code-text">informationRecipient.languageCode.c=es <br/> (=sp also accepted)</span>
|
||
</p>
|
||
<p>
|
||
To specify English, use the following:
|
||
<span class="code-text">informationRecipient.languageCode.c=en</span>
|
||
</p>
|
||
<p>
|
||
<span class="text-label">Format</span>
|
||
<br/> Identify if you would like the response format to be XML, JSON, or JSONP. XML is the default.
|
||
</p>
|
||
<dl>
|
||
<dt>To request JSON, use:</dt>
|
||
<dd><span class="code-text">knowledgeResponseType=application/json</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For JSONP, use:</dt>
|
||
<dd><span class="code-text">knowledgeResponseType=application/javascript&callback=CallbackFunction</span> where CallbackFunction is a name you give the call back function.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For a response in XML, use:</dt>
|
||
<dd><span class="code-text">knowledgeResponseType=text/xml</span> or leave the <span class="text-label">knowledgeResponseType</span> parameter out of the request.
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
<br/>
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2>
|
||
<a name="diagnosis"></a>Diagnosis (Problem) Code Requests</h2>
|
||
<p>
|
||
MedlinePlus Connect matches ICD-10-CM, ICD-9-CM or SNOMED CT codes to related MedlinePlus <a href="https://medlineplus.gov/healthtopics.html">health topic pages</a>, <a href="https://medlineplus.gov/genetics/condition/">genetics pages</a>, or pages from other NIH Institutes. For example, a patient diagnosed with ICD-9-CM code 493.12, Extrinsic asthma with exacerbation, could be presented a link in an electronic health record (EHR) that leads to the MedlinePlus page <a href="https://medlineplus.gov/asthma.html">Asthma</a>.
|
||
</p>
|
||
<p>
|
||
For diagnosis codes, MedlinePlus Connect will return the following:
|
||
</p>
|
||
<ul class="bulletlist">
|
||
<li>
|
||
Page title
|
||
</li>
|
||
<li>
|
||
Page URL
|
||
</li>
|
||
<li>
|
||
Synonyms, if available ("Also called")
|
||
</li>
|
||
<li>
|
||
Page summary
|
||
</li>
|
||
<li>
|
||
Summary attribution
|
||
</li>
|
||
</ul>
|
||
<p>
|
||
There may not always be a match for each code. In those cases, MedlinePlus Connect will return a null response.</p>
|
||
<p>The base URL of the service is:
|
||
<span class="code-text">https://connect.medlineplus.gov/service</span>
|
||
</p>
|
||
<p>
|
||
There are two required parameters for any query to this service:
|
||
</p>
|
||
<ol>
|
||
<li>
|
||
<span class="text-label">Code System</span>
|
||
<br/> Identify the problem code system you will be using.
|
||
|
||
<dl>
|
||
<dt>For ICD-10-CM use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.90</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For ICD-9-CM use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.103</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For SNOMED CT use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.96</span></dd>
|
||
</dl>
|
||
</li>
|
||
<li>
|
||
<span class="text-label">Code</span>
|
||
<br/> Identify the actual code that you are trying to look up:
|
||
<br/>
|
||
<span class="code-text">mainSearchCriteria.v.c=250.33</span>
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
<br/>
|
||
</p>
|
||
<h3>Optional Parameters</h3>
|
||
<p>
|
||
<span class="label-text">Code Title</span>
|
||
<br/> You may also identify the name/title of the problem code. However, this information does not impact the response (unlike the MedlinePlus Connect Web application where the name/title information may be used).
|
||
<span class="code-text">mainSearchCriteria.v.dn=Diabetes mellitus with other coma type 1 uncontrolled</span> See the above section on <a href="#output">Output Parameters</a> for details on language and output formats.
|
||
</p>
|
||
<h3>Description of Selected Atom Elements (or JSON objects) in Response to Problem Code Requests </h3>
|
||
<div class="table-box basic">
|
||
<table border="0" class="service" summary="summary"><thead>
|
||
<tr><th scope="col">Element</th>
|
||
<th scope="col">Class node</th>
|
||
<th scope="col">Description</th></tr>
|
||
</thead>
|
||
<tbody><tr><td>title</td>
|
||
<td> </td>
|
||
<td>Title of matched MedlinePlus health topic page or GHR page</td></tr>
|
||
<tr><td>link</td>
|
||
<td> </td>
|
||
<td>URL for matched MedlinePlus health topic page or GHR page</td></tr>
|
||
<tr><td>summary</td>
|
||
<td> </td>
|
||
<td>The full summary for the health topic. This includes embedded links to other relevant health topics, and all formatting, including bullets and paragraph spacing. The summary is in HTML.</td></tr>
|
||
<tr><td>summary</td>
|
||
<td><span>class=</span><span>"NLMalsoCalled"</span></td>
|
||
<td>Synonyms for the topic. These are referred to as "Also called" on a health topic page. Not all topics have "Also called" terms.</td></tr>
|
||
<tr><td>summary</td>
|
||
<td><span>class=</span><span>"NLMattribution"</span></td>
|
||
<td>Attribution acknowledgement for summary text if the majority of the summary was from another federal agency. Not all summaries have an attribution. Unattributed text is original to MedlinePlus. </td></tr>
|
||
<tr><td>summary</td>
|
||
<td><span>class=</span><span>"NLMrelatedLinks"</span></td>
|
||
<td>Selected links associated with the topic. This includes the page name, URL, and associated organization (when applicable). The links are formatted in a bulleted list. Not all topics have these links. The number of links can range from zero to dozens.</td></tr></tbody></table>
|
||
</div>
|
||
<h3>Examples of Requests for Problem Codes</h3>
|
||
<p>
|
||
A complete request for Diabetes Mellitus with other coma type 1 uncontrolled, ICD-9 code 250.33, for a Spanish speaking patient would have the following URL address:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.v.c=250.33&mainSearchCriteria.v.dn=Diabetes%20mellitus%20with%20other%20coma%20type%201%20uncontrolled&informationRecipient.languageCode.c=es
|
||
</span>
|
||
</p>
|
||
<p>
|
||
A patient with the same diagnosis but the requested format is JSON and the language is English:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.v.c=250.33&knowledgeResponseType=application/json
|
||
</span>
|
||
</p>
|
||
<p>
|
||
A patient diagnosed with "Pneumonia due to Pseudomonas" using SNOMED CT code 41381004:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&mainSearchCriteria.v.dn=Pneumonia%20due%20to%20Pseudomonas%20%28disorder%29&informationRecipient.languageCode.c=en
|
||
</span>
|
||
</p>
|
||
<p>
|
||
A patient with the same diagnosis but the requested format is JSONP:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callback=CallbackFunction
|
||
</span>
|
||
</p>
|
||
<h3>Related Services and Files</h3>
|
||
<p>
|
||
To receive MedlinePlus health topics in response to text requests, as opposed to problem codes, investigate the <a href="https://medlineplus.gov/about/developers/webservices/">MedlinePlus Web service</a>. Also, if you need the full set of MedlinePlus health topics in XML format, see our <a href="https://medlineplus.gov/xml.html">XML files</a> page.
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2>
|
||
<a name="medication"></a>Drug Code Requests</h2>
|
||
<p>
|
||
MedlinePlus Connect provides the best drug information matches when receiving an RXCUI. It also provides good results when receiving an NDC code. MedlinePlus Connect can provide responses in English or Spanish.
|
||
</p>
|
||
<p>
|
||
For requests for English medication information, if you do not send an NDC or RXCUI or if we find no match based on the code, the application will use the text string that you send to display the best drug information match. For requests for Spanish medication information, MedlinePlus Connect responds only to NDCs or RXCUIs and does not use text strings. It is possible to have a reponse in English but no response in Spanish.
|
||
</p>
|
||
<p>
|
||
The MedlinePlus Connect Web service will return the following:
|
||
</p>
|
||
<ul class="bulletlist">
|
||
<li>MedlinePlus medication page title</li>
|
||
<li>MedlinePlus medication page URL</li>
|
||
<li>Source attribution for the content</li>
|
||
</ul>
|
||
<p>
|
||
There could be multiple responses to one medication request. There may not always be a match for each request. In those cases, MedlinePlus Connect will return a null response.
|
||
</p>
|
||
<p>
|
||
For requests for drug information, the base URL is:
|
||
<span class="code-text">https://connect.medlineplus.gov/service</span>
|
||
</p>
|
||
<p>
|
||
To send a request, include these pieces of information:
|
||
</p>
|
||
<ol>
|
||
<li>
|
||
<span class="text-label">Code System</span>
|
||
<br/> Identify the type of medication code you are sending. (Required for English and Spanish)
|
||
<br/>
|
||
<dl>
|
||
<dt>For RXCUI use: </dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.88</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For NDC use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.69</span></dd>
|
||
</dl>
|
||
MedlinePlus Connect can also accept a text string for requests for medication information in English, but you must indicate you are looking for medication information by including one of the two code systems listed above.
|
||
</li>
|
||
<li>
|
||
<span class="text-label">Code</span>
|
||
<br/> Identify the actual code that you are trying to look up. (Preferred for English, Required for Spanish)
|
||
<br/>
|
||
<span class="code-text">mainSearchCriteria.v.c=637188</span>
|
||
</li>
|
||
<li>
|
||
<span class="text-label">Drug Name</span>
|
||
<br/> Identify the name of the drug with a text string. (Optional for English, Not used for Spanish)
|
||
<br/>
|
||
<span class="code-text">mainSearchCriteria.v.dn=Chantix 0.5 MG Oral Tablet</span>
|
||
</li>
|
||
</ol>
|
||
At a minimum you should identify the code system and the code, or the code system and the name of the drug. Send all three for best results for English requests. Send the code system and the code for Spanish requests.
|
||
|
||
<p>
|
||
<br/>
|
||
</p>
|
||
<h3>Optional Parameters</h3>
|
||
<span class="code-text">Code Title</span>
|
||
<p>
|
||
When sending a request for English information, you may include the optional parameter of the name of the medication. This is detailed in the above section.
|
||
<span class="code-text">mainSearchCriteria.v.dn=Chantix 0.5 MG Oral Tablet</span>
|
||
</p>
|
||
<p>
|
||
See the above section on <a href="#output">Output Parameters</a> for details on language and output formats.
|
||
</p>
|
||
<h3>Description of Selected Atom Elements (or JSON objects) in Response to Medication Requests</h3>
|
||
<div class="table-box basic">
|
||
<table border="0" class="service" summary=""><thead>
|
||
<tr><th scope="col">Element</th>
|
||
<th scope="col">Description</th></tr>
|
||
</thead>
|
||
<tbody><tr><td>title</td>
|
||
<td>Title for matched MedlinePlus medication page</td></tr>
|
||
<tr><td>link</td>
|
||
<td>URL for the matched MedlinePlus medication page</td></tr>
|
||
<tr><td>author</td>
|
||
<td>Source attribution for medication information</td></tr></tbody></table>
|
||
</div>
|
||
<h3>Examples of Requests for Drug Codes </h3>
|
||
<p>
|
||
Your medication information request should look like one of the following.
|
||
</p>
|
||
<p>
|
||
To request information by an RXCUI, your request should look like this:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.88&mainSearchCriteria.v.c=637188&mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode.c=en
|
||
</span>
|
||
</p>
|
||
<p>
|
||
To request information by an NDC for a Spanish speaker, your request should look like this:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.v.c=00310-0751-39&informationRecipient.languageCode.c=es
|
||
</span>
|
||
</p>
|
||
<p>
|
||
To send a text string without a medication code, you must identify your query as an NDC-type request so MedlinePlus Connect knows you are looking for medication information. This will work for English requests only. Your request could look like this:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode.c=en
|
||
</span>
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2>
|
||
<a name="labs"></a>Lab Test Code Requests</h2>
|
||
<p>
|
||
MedlinePlus Connect provides matches to laboratory test information when receiving a LOINC request. The service can provide a response in English or Spanish.
|
||
</p>
|
||
<p>
|
||
The MedlinePlus Connect Web service will return the following:
|
||
</p>
|
||
<ul class="bulletlist">
|
||
<li>MedlinePlus lab test page title </li>
|
||
<li>MedlinePlus lab test page URL</li>
|
||
<li>Snippet of the content of the lab test information</li>
|
||
<li>Source attribution for the content</li>
|
||
</ul>
|
||
<p>
|
||
There may not always be a match for each code. In those cases, MedlinePlus Connect will return a null response.
|
||
<br/>
|
||
<br/>The base URL of the service is:
|
||
<span class="code-text">https://connect.medlineplus.gov/service</span>
|
||
</p>
|
||
<p>
|
||
These are two required parameters for any lab test query to this service:
|
||
</p>
|
||
<ol>
|
||
<li>
|
||
<span class="text-label">Code System</span>
|
||
<br/>
|
||
<dl>
|
||
<dt>Identify that you are using the LOINC code system. Use: </dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.1</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>MedlinePlus Connect will also accept: </dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.11.79</span></dd>
|
||
</dl>
|
||
</li>
|
||
<li>
|
||
<span class="text-label">Code</span>
|
||
<br/> identify the actual code you are trying to look up:
|
||
<br/>
|
||
<span class="code-text">mainSearchCriteria.v.c=3187-2</span>
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
<br/>
|
||
</p>
|
||
<h3>Optional Parameters</h3>
|
||
<span class="text-label">Code Title</span>
|
||
<p>
|
||
You may also identify the name of the lab test. However, this information does not impact the response.
|
||
<span class="code-text">mainSearchCriteria.v.dn=Factor IX assay</span>
|
||
</p>
|
||
<p>
|
||
See the above section on <a href="#output">Output Parameters</a> for details on language and output formats.
|
||
</p>
|
||
<h3>Description of Selected Atom Elements (or JSON objects) in Response to Lab Test Requests</h3>
|
||
<div class="table-box basic">
|
||
<table border="0" class="service" summary="" width="100%"><thead>
|
||
<tr><th scope="col">Element</th>
|
||
<th scope="col">Description</th></tr>
|
||
</thead>
|
||
<tbody><tr><td>title</td>
|
||
<td>Title of matched MedlinePlus lab test page</td></tr>
|
||
<tr><td>link</td>
|
||
<td>URL for matched MedlinePlus lab test page</td></tr>
|
||
<tr><td>summary</td>
|
||
<td>Snippet from the page content</td></tr>
|
||
<tr><td>author</td>
|
||
<td>Source attribution for the lab test content</td></tr></tbody></table>
|
||
</div>
|
||
<h3>Examples of Requests for Lab Tests</h3>
|
||
<p>
|
||
To request information for an English speaker, your request may look like one of the following:
|
||
<span class="code-text">https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.v.c=3187-2&mainSearchCriteria.v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=en
|
||
</span>
|
||
<span class="code-text">https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.v.c=3187-2&informationRecipient.languageCode.c=en
|
||
</span>
|
||
</p>
|
||
<p>
|
||
To request information for a Spanish speaker, your request may look like one of the following:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.v.c=3187-2&mainSearchCriteria.v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=es
|
||
</span>
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.v.c=3187-2&informationRecipient.languageCode.c=es
|
||
</span>
|
||
</p>
|
||
</section>
|
||
<!-- Begin Medical Procedure Information section -->
|
||
<section>
|
||
<h2>
|
||
<a name="procedures"></a>Medical Procedure Code Requests</h2>
|
||
<p>For medical procedure codes, MedlinePlus Connect supports:</p>
|
||
<ul class="bulletlist">
|
||
<li><a href="https://www.ama-assn.org/amaone/cpt-current-procedural-terminology" target="TheNewWin">CPT® (Current Procedural Terminology)</a></li>
|
||
<li><a href="https://www.nlm.nih.gov/healthit/snomedct/index.html" target="TheNewWin">SNOMED CT®</a> (Systematized Nomenclature of Medicine, Clinical Terms)</li>
|
||
</ul>
|
||
<p>MedlinePlus Connect matches CPT® or SNOMED CT procedure codes to related MedlinePlus <a href="https://medlineplus.gov/healthtopics.html">health topic pages</a> or <a href="https://medlineplus.gov/lab-tests/">medical test pages</a>. MedlinePlus Connect can provide responses to procedure requests in English or Spanish and will return a link to a results page with the best matches from MedlinePlus.</p>
|
||
<p>
|
||
For requests for medical procedure information, the base URL is:
|
||
<span class="code-text">
|
||
https://connect.medlineplus.gov/service
|
||
</span>
|
||
</p>
|
||
<p>
|
||
These are two required parameters for any procedure query to this application:
|
||
</p>
|
||
<ol>
|
||
<li>Identify the procedure code system you will be using.
|
||
<br/>
|
||
<dl>
|
||
<dt>For CPT use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs= 2.16.840.1.113883.6.12</span></dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>For SNOMED CT use:</dt>
|
||
<dd><span class="code-text">mainSearchCriteria.v.cs=2.16.840.1.113883.6.96</span></dd>
|
||
</dl>
|
||
</li>
|
||
<li>
|
||
<span class="label-text">Identify the actual code you are trying to look up.</span>
|
||
<br/>
|
||
<span class="code-text">mainSearchCriteria.v.c=59015</span>
|
||
</li>
|
||
</ol>
|
||
<h3>Optional Parameters</h3>
|
||
<p>Identify the name/title of the procedure. However, this information does not impact the response.
|
||
<span class="code-text">mainSearchCriteria.v.dn=Chorionic villus sampling</span>
|
||
</p>
|
||
<p>
|
||
Identify if you would like the request to be in English or Spanish. MedlinePlus Connect will assume English is the language if it is not specified.
|
||
</p>
|
||
<p>
|
||
If you wish the response to the procedure code lookup to be in Spanish, use:
|
||
<span class="code-text">informationRecipient.languageCode.c=es (=sp also accepted)</span>
|
||
</p>
|
||
<p>
|
||
To specify English, use the following:
|
||
<span class="code-text">informationRecipient.languageCode.c=en</span>
|
||
</p>
|
||
<h3>Examples of Requests for Medical Procedures</h3>
|
||
<p>To request information by CPT code for an English speaker, your request may look like one of the following:
|
||
<span class="code-text">https://connect.medlineplus.gov/service?mainSearchCriteria.v.c=0001A&mainSearchCriteria.v.cs=2.16.840.1.113883.6.12&mainSearchCriteria.v.dn=&informationRecipient.languageCode.c=en</span>
|
||
</p>
|
||
<p>To request information by SNOMED code for a Spanish speaker, your request may look like this:
|
||
<span class="code-text">https://connect.medlineplus.gov/service?mainSearchCriteria.v.c=104107006&mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.dn=&informationRecipient.languageCode.c=es</span>
|
||
</p>
|
||
</section>
|
||
<!-- End Medical Procedure Information section -->
|
||
<section>
|
||
<h2>
|
||
<a name="acceptableusepolicy"></a>Acceptable Use Policy</h2>
|
||
<p>In order to avoid overloading the MedlinePlus servers, NLM requires that users of MedlinePlus Connect send no more than 100 requests per minute per IP address. Requests that exceed this limit will not be serviced, and service will not be restored for 300 seconds or until the request rate falls beneath the limit, whichever comes later. To limit the number of requests that you send to Connect, NLM recommends caching results for a 12-24 hour period.
|
||
</p>
|
||
<p>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 MedlinePlus Connect, and thus exceed the request rate limit outlined in this policy, please <a href="https://support.nlm.nih.gov/support/create-case/?category=medlineplus_connect&from=https://medlineplus.gov/medlineplus-connect/web-service/" target="_blank">contact us</a>. NLM staff will evaluate your request and determine if an exception may be granted. Please also review the MedlinePlus <a href="https://medlineplus.gov/xml.html">XML files</a> documentation. These XML files contain complete health topic records and can serve as an alternate method of accessing MedlinePlus data.
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2>More Information</h2>
|
||
<ul class="bulletlist">
|
||
<li><a href="https://medlineplus.gov/medlineplus-connect/how-it-works/">How MedlinePlus Connect Works</a></li>
|
||
<li>
|
||
<a data-pid="37645" href="https://medlineplus.gov/medlineplus-connect/news/">MedlinePlus Connect News</a></li>
|
||
<li>
|
||
Demonstrations — <a href="https://connect.medlineplus.gov/demo/application/">Web application</a> and <a href="https://connect.medlineplus.gov/demo/service/">Web service</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://medlineplus.gov/medlineplus-connect/technical-information/">Technical information</a> for developers
|
||
</li>
|
||
<li>
|
||
<a href="https://medlineplus.gov/medlineplus-connect/users-and-partners/">MedlinePlus Connect Users and Partners</a></li>
|
||
<li>MedlinePlus Connect <a href="https://medlineplus.gov/connect/medlineplusconnecthandout.pdf">handout</a> - PDF
|
||
</li>
|
||
<li>
|
||
<a href="https://medlineplus.gov/medlineplus-connect/faqs/">Frequently Asked Questions (FAQs)</a>
|
||
</li>
|
||
<li>
|
||
MedlinePlus Connect <a href="https://medlineplus.gov/medlineplus-connect/email-list/">email list</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://support.nlm.nih.gov/support/create-case/?category=medlineplus_connect&from=https://medlineplus.gov/medlineplus-connect/" target="_blank">Contact</a> MedlinePlus Connect</li>
|
||
</ul>
|
||
</section></div>
|
||
</section>
|
||
|
||
</div>
|
||
</article>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<footer>
|
||
<div id="mplus-footer">
|
||
<div class="footer1">
|
||
|
||
<ul class="secondarynav">
|
||
<li><a href="https://medlineplus.gov/about/">About MedlinePlus</a></li>
|
||
<li><a href="https://medlineplus.gov/whatsnew/">What's New</a></li>
|
||
<li><a href="https://medlineplus.gov/sitemap.html">Site Map</a></li>
|
||
|
||
|
||
<li><a href="https://support.nlm.nih.gov/knowledgebase/category/?id=CAT-01231&category=medlineplus&from=https%3A//medlineplus.gov/medlineplus-connect/web-service/" target="_blank"><span>Customer Support</span></a></li>
|
||
|
||
</ul>
|
||
|
||
<ul class="follow-footer">
|
||
<li>
|
||
<a href="https://medlineplus.gov/rss.html" class="follow-item">Subscribe to RSS<img src="https://medlineplus.gov/images/feed.png" class="social-media-toolkit-icon" alt="RSS" title="RSS"></a>
|
||
</li>
|
||
<li>
|
||
<span class="follow-label">Follow us</span>
|
||
<a href="https://twitter.com/medlineplus" class="follow-item" target="_blank">
|
||
<img src="https://medlineplus.gov/images/i_share_twitter.png" class="follow-icon" alt="X" title="X">
|
||
</a>
|
||
<a href="https://facebook.com/Mplus.gov/" class="follow-item" target="_blank">
|
||
<img src="https://medlineplus.gov/images/i_share_fb.png" class="follow-icon" alt="Facebook" title="Facebook">
|
||
</a>
|
||
<a href="https://www.instagram.com/mplusgov/" class="follow-item" target="_blank">
|
||
<img src="https://medlineplus.gov/images/Instagram_Glyph_Gradient_RGB.png" class="follow-icon" alt="Instagram" title="Instagram">
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="https://medlineplus.gov/social-media-toolkit/" class="social-media-toolkit-item">Social Media Toolkit<img src="https://medlineplus.gov/images/i_social_media_toolkit.png" class="social-media-toolkit-icon" alt="Social Media Toolkit" title="Social Media Toolkit"></a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="footer2">
|
||
<ul>
|
||
|
||
|
||
<li><a href=" https://www.nlm.nih.gov/web_policies.html" target='_blank'>NLM Web Policies</a></li>
|
||
|
||
<li><a href="https://medlineplus.gov/about/using/usingcontent/" >Copyright</a></li>
|
||
|
||
<li><a href="https://medlineplus.gov/accessibility.html">Accessibility</a></li>
|
||
<li><a href="https://medlineplus.gov/about/using/criteria/">Guidelines for Links</a></li>
|
||
<li><a href="https://medlineplus.gov/plugins.html">Viewers & Players</a></li>
|
||
<li><a href="https://www.hhs.gov/vulnerability-disclosure-policy/index.html" target="_blank">HHS Vulnerability Disclosure</a></li>
|
||
|
||
<li><a href="https://medlineplus.gov/medlineplus-connect/">MedlinePlus Connect for EHRs</a></li>
|
||
<li><a href="https://medlineplus.gov/about/developers/">For Developers</a></li>
|
||
|
||
</ul>
|
||
|
||
<div class="address">
|
||
<a href="https://www.nlm.nih.gov" target="_blank">National Library of Medicine</a>
|
||
<span>8600 Rockville Pike, Bethesda, MD 20894</span>
|
||
<a href="https://www.hhs.gov" target="_blank">U.S. Department of Health and Human Services</a>
|
||
<a href="https://www.nih.gov" target="_blank">National Institutes of Health</a>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="date">
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="return-top"><a href="#top" title="Return to top"><img class="return-top-icon" alt="Return to top" src="https://medlineplus.gov/images/return-top.png"></a></div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
</div>
|
||
|
||
|
||
<script src="https://medlineplus.gov/jslib/jquery-3.6.0.min.js" type="text/javascript"></script>
|
||
<script src="https://medlineplus.gov/jslib/mplus-frontend-controls-new.js" type="text/javascript"></script>
|
||
<script src="https://medlineplus.gov/jslib/mplus-share.js?id=1112022" type="text/javascript"></script>
|
||
<!--[if lte IE 9]><script src="//www.nlm.nih.gov/medlineplus/jslib/jquery.placeholder.js" type="text/javascript"></script><![endif]-->
|
||
<script src="https://medlineplus.gov/jslib/control.js" type="text/javascript"></script>
|
||
<script src="https://medlineplus.gov/uswds/js/uswds.min.js" type="text/javascript"></script>
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|