Base URI: https://uts-ws.nlm.nih.gov/rest
| Path Pattern | Description |
|---|---|
| /search/{version} | Searches by term or code and returns CUIs or source-asserted identifiers, depending on parameters |
| /metadata/{version}/sources | Retrieves UMLS source vocabulary metadata and valid source abbreviations |
| Path Pattern | Description |
|---|---|
| /content/{version}/CUI/{CUI} | Retrieves information about a known CUI |
| /content/{version}/CUI/{CUI}/atoms | Retrieves atoms for a known CUI |
| /content/{version}/CUI/{CUI}/atoms/preferred | Retrieves the default preferred atom for a known CUI |
| /content/{version}/CUI/{CUI}/definitions | Retrieves definitions for a known CUI |
| /content/{version}/CUI/{CUI}/relations | Retrieves relationships for a known CUI |
| /content/{version}/AUI/{AUI} | Retrieves information about a known atom |
| /content/{version}/AUI/{AUI}/parents | Retrieves immediate parents of a known atom |
| /content/{version}/AUI/{AUI}/children | Retrieves immediate children of a known atom |
| /content/{version}/AUI/{AUI}/ancestors | Retrieves ancestors of a known atom |
| /content/{version}/AUI/{AUI}/descendants | Retrieves descendants of a known atom |
| Path Pattern | Description |
|---|---|
| /content/{version}/source/{source}/{id} | Retrieves information about a known source concept, source descriptor, or code |
| /content/{version}/source/{source}/{id}/atoms | Retrieves atoms for a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/atoms/preferred | Retrieves the default preferred atom for a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/parents | Retrieves immediate parents of a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/children | Retrieves immediate children of a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/ancestors | Retrieves ancestors of a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/descendants | Retrieves descendants of a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/relations | Retrieves relationships for a known source-asserted identifier |
| /content/{version}/source/{source}/{id}/attributes | Retrieves attributes for a known source-asserted identifier |
| /crosswalk/{version}/source/{source}/{id} | Retrieves source-asserted identifiers that share a UMLS CUI with a particular code |
| Path Pattern | Description |
|---|---|
| /semantic-network/{version}/TUI/{id} | Retrieves information for a known semantic type identifier (TUI) |
We welcome your feedback on our customer service form. Please use "UMLS REST API feedback" in your subject line.
Check out the Postman sample collection to help you get started using the UMLS REST API.
We added new semanticTypes and semanticGroups search parameters to the
search endpoint so users can filter search results by
semantic type and semantic group.
We added the UMLS API Interactive Interface so users can try search requests, inspect raw JSON, review request URLs, and navigate to related API documentation from the results.
We have shut down the Source-Asserted Subsets API Endpoint and the Content Views API Endpoint as of December 31, 2023. We deprecated these endpoints in May of 2022. Source-Asserted Subset information and Content View information can be retrieved from the UMLS Metathesaurus files.
We are pleased to announce the publication of a (/automating-downloads.html)[new API endpoint for NLM terminology releases]. This endpoint provides an updated list of releases for many of our terminology products. You can use this endpoint to automate the download of the latest release files for RxNorm, SNOMED CT, and UMLS.
We have made adjustments to the way in which the search API stems individual words. The most significant impact is that queries that include plural forms of words will now find singular forms, for example, a query for "lungs" will find all instances of "lung". In general, API search queries and search queries in the Metathesaurus Browser will produce a higher number of results than before.
We now offer an endpoint for validating API keys. If you have developed an application that integrates UMLS data and you need to determine whether a user is a UMLS licensee, you can use this endpoint to validate the user's API key.
Make a request that includes both your API key (validatorApiKey) and the API key of the user of your application (apiKey). For example:
https://utslogin.nlm.nih.gov/validateUser?validatorApiKey=YOUR_API_KEY&apiKey=USER_API_KEY
For more information see our
authentication documentation.
Search for partial matches, for example:
/search/current
?string=Congenital Nephrogenic Diabetes Insipidus
&partialSearch=true
Adding partialSearch=true to your search query will return partial matches. If your query contains four words, it will return results that include all four words, then results that contain three of four words, then two of four words, then one of four words.
For more information see our
search documentation.
Download any RxNorm, SNOMED CT, or UMLS release using a single command, for example:
curl
"https://uts-ws.nlm.nih.gov/download
?url=https://download.nlm.nih.gov/
umls/kss/rxnorm/
RxNorm_weekly_10052022.zip
&apiKey=YOUR_API_KEY"
-o RxNorm_weekly_10052022.zip
For more information, see our Automating UMLS Terminology Services Downloads page.
Search for a CUI, return a source-asserted code: The search endpoint now supports searching for a UMLS CUI and returning a source-asserted
code, for example:
/search/current
?string=C0009044
&sabs=SNOMEDCT_US
&returnIdType=code.
For more information see our
search documentation.
Changes to the concept relations endpoint: The concept relations api endpoint will return any relation associated with a UMLS CUI, including source-asserted relations. Previously, this endpoint only returned NLM-asserted relations.
New authentication method: Users can request data by simply including an API key with a data request. For more information see: 2022AA release announcement and authentication documentation. Ticket-granting tickets and service tickets are deprecated.
Changes to API search: The UMLS API started using ElasticSearch for search. Users may notice changes in search ranking.
Changes to relation data returned: Relations api requests will return additional data fields: relatedFromId and relatedFromIdName. These data fields indicate the subject of the relationship, which can be a code, CUI, AUI, SCUI, or SDUI. See the sample output on the source-asserted relations documentation page.