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/application.html
Scott Williams 7bcb500d37 Initial commit.
2025-02-26 13:17:41 -05:00

791 lines
39 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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/web-application/" />
<link href="https://medlineplus.gov/medlineplus-connect/web-application/" hreflang="x-default" rel="alternate">
<meta name="ac-dictionary" content="medlineplus-ac-dictionary" />
<meta name="description" content="MedlinePlus Connect is available as a web application. Learn more about implementing the application and requesting information through MedlinePlus Connect." />
<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 Application" />
<meta property="og:url" content="https://medlineplus.gov/medlineplus-connect/web-application/" />
<meta property="og:image" content="https://medlineplus.gov/images/mplus_fb.jpg" />
<meta property="og:description" content="MedlinePlus Connect is available as a web application. Learn more about implementing the application and requesting information through MedlinePlus Connect." />
<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 Application" />
<meta name="twitter:description" content="MedlinePlus Connect is available as a web application. Learn more about implementing the application and requesting information through MedlinePlus Connect." />
<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 Application</title>
<link rel="stylesheet" href="https://medlineplus.gov/css/common_new.css?1738956700384" />
<!--[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-application/" 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: Web Application</span>
</div>
</div>
</div>
<span class="page-url print-only">URL of this page: https://medlineplus.gov/medlineplus-connect/web-application/</span>
<div >
<article>
<div class="page-info">
<div class="page-title">
<a name="start" id="start"></a>
<h1>MedlinePlus Connect: Web Application</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 Application 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 Web application or <a href="https://medlineplus.gov/medlineplus-connect/web-service/">Web service</a>. Below are the technical details for implementing the Web application, which responds to requests based on: diagnosis (problem) code requests, drug code requests, lab test code requests, and medical procedure code requests.
</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&amp;from=https://medlineplus.gov/medlineplus-connect/web-application/" target="_blank">contacting us</a>. You are welcome to link to and display the data provided by MedlinePlus Connect. 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>
<section>
<h2>
<a name="overview"></a>Web Application Overview</h2>
<p>
The API for the Web application conforms 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 specification</a>. The structure of the request indicates what type of code you are sending. In all cases, the base URL for the Web application is:
<span class="code-text">
https://connect.medlineplus.gov/application
</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 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>
<span>For requests by problem, the base URL of the application is: </span>
<span class="code-text">https://connect.medlineplus.gov/application</span>
<p>This link displays a page with an empty search box. There are two required parameters for any query to this application:
</p>
<ol>
<li>Identify the problem code system you will be using.
<br/>
<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="label-text">Identify the actual code that you are trying to look up:</span>
<br/>
<span class="code-text">mainSearchCriteria.v.c=250.33</span>
</li>
</ol>
<p>
<br/>
</p>
<h3>Optional Parameters</h3>
<p>
Identify the name/title of the problem code.
<span class="code-text">mainSearchCriteria.v.dn=Diabetes mellitus with other coma type 1 uncontrolled</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 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>
<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/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&amp;mainSearchCriteria.v.c=250.33&amp;mainSearchCriteria.v.dn=Diabetes%20mellitus%20with%20other%20coma%20type%201%20uncontrolled&amp;informationRecipient.languageCode.c=es
</span>
</p>
<p>
A patient diagnosed with "Pneumonia due to Pseudomonas" using SNOMED CT code 41381004:
<span class="code-text">
https://connect.medlineplus.gov/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&amp;mainSearchCriteria.v.c=41381004&amp;mainSearchCriteria.v.dn=Pneumonia%20due%20to%20Pseudomonas%20%28disorder%29&amp;informationRecipient.languageCode.c=en
</span>
</p>
<p>A freeform query, with no code system or problem code, will use the MedlinePlus search engine.</p>
<p>Identify if you would like the request to be sent to the English language MedlinePlus search engine or the MedlinePlus en español search engine. MedlinePlus Connect will assume English as the language if it is not specified and will send the query to the English language MedlinePlus search engine by default:
<span class="code-text">
https://connect.medlineplus.gov/application?mainSearchCriteria.v.dn=Type+2+Diabetes
</span>
</p>
<p>To specify English, use the following:
<span class="code-text">
informationRecipient.languageCode.c=en
</span>
<span class="code-text">
https://connect.medlineplus.gov/application?mainSearchCriteria.v.dn=Type+2+Diabetes&amp;informationRecipient.languageCode.c=en
</span>
</p>
<p>If the freeform query is in Spanish, then send it to the MedlinePlus en español search engine by using the following:
<span class="code-text">
informationRecipient.languageCode.c=es<br/>
(=sp also accepted)
</span>
<span class="code-text">
https://connect.medlineplus.gov/application?mainSearchCriteria.v.dn=Diabetes+Tipo+2&amp;informationRecipient.languageCode.c=es
</span>
</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 to medication code requests in English or Spanish and will return a link to a results page with the best matches from the MedlinePlus drug information.
</p>
<p>
For requests for English medication information, if you do not send an NDC or RXCUI code or if we find no match based on the code, we 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; it does not use text strings. It is possible to have a response in English but no response in Spanish.
</p>
<p>
There may be multiple responses to one medication request. There may not always be a match for each request. If MedlinePlus Connect finds a null response for a drug request, the program displays a search box for the MedlinePlus site. A user can type in a drug name and may get a good response.
</p>
<p>
For requests for drug information, the base URL is:
<span class="code-text">
https://connect.medlineplus.gov/application
</span>
</p>
<p>
Requests for English and Spanish medication information have different requirements. To send a request, include these pieces of information:
</p>
<ol>
<li>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>
</li>
<li>
<span class="label-text">Identify the actual code you are trying to look up. (Preferred for English, Required for Spanish)</span>
<br/>
<span class="code-text">mainSearchCriteria.v.c=637188</span>
</li>
<li>
<span class="label-text">Identify the name of the drug with a text string. (Optional for English, Not used for Spanish)</span>
<br/>
<span class="code-text">mainSearchCriteria.v.dn=Chantix 0.5 MG Oral Tablet</span>
</li>
</ol>
<p>
<br/>
</p>
<p>
For English requests, you should identify at a minimum 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. For Spanish requests, you should identity the code system and the code.
</p>
<h3>Optional Parameters</h3>
<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. This parameter is not used for Spanish requests.
</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 medication 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>
<h3>Examples of Requests for Drug Codes</h3>
<p>Your drug 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/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.88&amp;mainSearchCriteria.v.c=%20637188%20&amp;mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&amp;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/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&amp;mainSearchCriteria.v.c=%2000310-0751-39&amp;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 only. Your request could look like this:
<span class="code-text">
https://connect.medlineplus.gov/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&amp;mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&amp;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. MedlinePlus Connect can provide responses to lab test requests in English or Spanish and will return a link to a results page with the best matches from the MedlinePlus lab test information.
</p>
<p>
For requests for lab test information, the base URL is:
<span class="code-text">
https://connect.medlineplus.gov/application
</span>
</p>
<p>
These are two required parameters for any lab test query to this application:
</p>
<ol>
<li>Identify that you are using the LOINC code system.
<br/>
<dl>
<dt>For LOINC 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="label-text">Identify the actual code you are trying to look up. </span>
<br/>
<span class="code-text">mainSearchCriteria.v.c=3187-2</span>
</li>
</ol>
<p>
<br/>
</p>
<h3>Optional Parameters</h3>
<p>
Identify the name/title 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>
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 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>
A freeform query, with no code system or lab code, will use the MedlinePlus search engine. This approach is more effective with diagnoses (see the problem code information above) instead of lab test text strings. Your lab test information request should look like one of the following.
</p>
<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/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&amp;mainSearchCriteria.v.c=3187-2&amp;mainSearchCriteria.v.dn=Factor%20IX%20assay&amp;informationRecipient.languageCode.c=en </span>
<span class="code-text">https://connect.medlineplus.gov/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&amp;mainSearchCriteria.v.c=3187-2&amp;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/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&amp;mainSearchCriteria.v.c=3187-2&amp;mainSearchCriteria.v.dn=Factor%20IX%20assay&amp;informationRecipient.languageCode.c=es </span>
<span class="code-text">https://connect.medlineplus.gov/application?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&amp;mainSearchCriteria.v.c=3187-2&amp;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/application
</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/application?mainSearchCriteria.v.c=0001A&amp;mainSearchCriteria.v.cs=2.16.840.1.113883.6.12&amp;mainSearchCriteria.v.dn=&amp;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/application?mainSearchCriteria.v.c=104107006&amp;mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&amp;mainSearchCriteria.v.dn=&amp;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&amp;from=https://medlineplus.gov/medlineplus-connect/web-application/" 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/web-application/" 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