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

565 lines
27 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" 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/technical-information/" />
<link href="https://medlineplus.gov/medlineplus-connect/technical-information/" hreflang="x-default" rel="alternate">
<meta name="ac-dictionary" content="medlineplus-ac-dictionary" />
<meta name="description" content="Learn technical quick facts for MedlinePlus Connect, compare implementation options for the web application and web service, and see the Acceptable Use Policy." />
<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: Technical Information" />
<meta property="og:url" content="https://medlineplus.gov/medlineplus-connect/technical-information/" />
<meta property="og:image" content="https://medlineplus.gov/images/mplus_fb.jpg" />
<meta property="og:description" content="Learn technical quick facts for MedlinePlus Connect, compare implementation options for the web application and web service, and see the Acceptable Use Policy." />
<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: Technical Information" />
<meta name="twitter:description" content="Learn technical quick facts for MedlinePlus Connect, compare implementation options for the web application and web service, and see the Acceptable Use Policy." />
<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: Technical Information</title>
<link rel="stylesheet" href="https://medlineplus.gov/css/common_new.css?1738956704065" />
<!--[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/technical-information/" 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>
&rarr;
<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>
&rarr;
<meta itemprop="position" content="2"/>
</div>
<div>
<span>MedlinePlus Connect: Technical Information</span>
</div>
</div>
</div>
<span class="page-url print-only">URL of this page: https://medlineplus.gov/medlineplus-connect/technical-information/</span>
<div >
<article>
<div class="page-info">
<div class="page-title">
<a name="start" id="start"></a>
<h1>MedlinePlus Connect: Technical Information</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"><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 a
<a href="https://medlineplus.gov/medlineplus-connect/web-service/">Web service</a>.
</p>
<p>
Sign up for the MedlinePlus Connect <a href="https://medlineplus.gov/medlineplus-connect/email-list/">email list</a> to keep up with developments and exchange ideas with your colleagues. It's the best way for us to keep you informed of updates and enhancements. Please tell us if you implement MedlinePlus Connect by
<a href="https://support.nlm.nih.gov/support/create-case/?category=medlineplus_connect&amp;from=https://medlineplus.gov/medlineplus-connect/technical-information/" target="_blank">contacting us</a>.
</p>
<section>
<h2>Technical Quick Facts:</h2>
<ul class="bulletlist">
<li>
<a href="https://medlineplus.gov/medlineplus-connect/">MedlinePlus Connect</a> is an API provided by the National Library of Medicine. It is available as a <a href="https://medlineplus.gov/medlineplus-connect/web-application/">Web application</a> or a <a href="https://medlineplus.gov/medlineplus-connect/web-service/">Web service</a>.
</li>
<li>
MedlinePlus Connect will update and maintain the responses to code requests. The possible types of queries and reponses are described on the <a href="https://medlineplus.gov/medlineplus-connect/how-it-works/">How it Works page</a>.
<ul class="bulletlist">
<li>Queries are URL-based. Connect uses the GET method not POST.</li>
<li>Only one code can be submitted per request.</li>
</ul>
</li>
<li>
Supports the <a href="https://www.hl7.org/implement/standards/product_brief.cfm?product_id=22" target="TheNewWin">HL7 Context-Aware Knowledge Retrieval (Infobutton) standard</a>.
</li>
<li>
Connects using HTTPS connections.
</li>
<li>
A personal health record (PHR) or electronic health record (EHR) vendor may activate MedlinePlus Connect at an enterprise level so it is available to all users.
</li>
<li>
Health IT managers, such as at hospital systems or health care providers, may implement MedlinePlus Connect in their system if they have the administrative rights to make these adjustments.
</li>
</ul>
<p>For detailed implementation instructions, request parameters, demonstrations, and examples, go to the</p>
<ul class="bulletlist">
<li>
<a href="https://medlineplus.gov/medlineplus-connect/web-application/">Web Application Technical Information Page</a>
</li>
<li>
<a href="https://medlineplus.gov/medlineplus-connect/web-service/">Web Service Technical Information Page</a>
</li>
</ul>
</section>
<section>
<h2>MedlinePlus Connect Implementation Options</h2>
<!-- Begin layout of Web Application and Web Service -->
<div class="resrow">
<div class="full-half">
<div class="connect-block">
<div class="whitearea">
<div class="connect-block connect-block-minheight">
<h3>Web Application</h3>
<p><strong>How does it work?</strong></p>
<ul class="bulletlist">
<li>
Responds to requests with an on-demand, formatted MedlinePlus Connect Web page
</li>
<li>
The page is responsively-designed, has a toggle button for Spanish/English (when appropriate).
</li>
<li>
<a href="https://connect.medlineplus.gov/demo/application/">Web Application demonstration</a>
</li>
</ul>
<p><strong>Technical Details and Demonstrations</strong></p>
<ul class="bulletlist">
<li>
<a href="https://medlineplus.gov/medlineplus-connect/web-application/">Web Application Technical Information page</a> — Includes implementation instructions and information.
</li>
<li>
<a href="https://connect.medlineplus.gov/demo/application/">Web Application demonstration page</a> — Includes examples of MedlinePlus Connect Web Application response pages.
</li>
</ul>
</div>
</div>
</div>
</div>
<!-- end Web Application Full Half -->
<div class="full-half">
<div class="connect-block">
<div class="whitearea">
<div class="connect-block connect-block-minheight">
<h3>Web Service</h3>
<p><strong>How does it work?</strong></p>
<ul class="bulletlist">
<li>
Responds to requests with XML, JSON, or JSONP, which implementers can use to incorporate MedlinePlus information and links into any health IT interface
</li>
<li>
It is a REST-based Web Service
</li>
<li>
The implementer may select which MedlinePlus links and information to provide from within the system instead of automatically providing a link to the standard MedlinePlus Connect response page
</li>
<li>
<a href="https://connect.medlineplus.gov/demo/service">Web Service demonstration</a>
</li>
</ul>
<p><strong>Technical Details and Demonstrations</strong></p>
<ul class="bulletlist">
<li>
<a href="https://medlineplus.gov/medlineplus-connect/web-service/">Web Service Technical Information page</a> — Includes implementation instructions and information.
</li>
<li>
<a href="https://connect.medlineplus.gov/demo/service">Web Service demonstration page</a> — Includes examples of responses generated by the Web service.
</li>
</ul>
</div>
</div>
</div>
</div>
<!-- end Web Service Full Half -->
</div>
<!-- end resrow -->
<!-- End layout of Web Application and Web Service -->
</section>
<section>
<h2>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&amp;from=https://medlineplus.gov/medlineplus-connect/technical-information/" 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&amp;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/technical-information/" 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>
Reference in a new issue View git blame Copy permalink