UTS Logo

UMLS API Technical Documentation


Current REST API Version: 0.63 beta

We welcome your feedback on our customer service form. Please use "UMLS REST API feedback" in your subject line.
Gotta question for other UMLS users? Join the UMLS listserv.
Check out the Postman sample collections, or code samples in Python, Java, and Perl on Github to help you get started using the UMLS REST API.

Retrieving Source-Asserted Relations

URIs | Query Parameters | Sample Output

URIs with /relations support the following use cases:

  • Retrieve the source-asserted relationships for a known source-asserted identifier.

Note that ‘current’ in the URI can always be used to search against the latest UMLS publication.
You may use any valid UMLS release back to 2008AA in your URI if you would like to search against a particular version of the UMLS.

URIs

The base URI is https://uts-ws.nlm.nih.gov/rest

Sample URI Description Returned JSON Object classType
/content/current/source/LNC/44255-8/relations Retrieves relationships of LOINC code 44255-8 AtomClusterRelation

Query Parameters

Parameter name Required? Y/N Description Valid Values Default value Usage Note
ticket Y A single-use service ticket is required for each call to the API. See authentication for more information n/a n/a n/a
includeRelationLabels N One or more relation labels Any relation label in the UMLS n/a Use a comma between each relation label to specify more than one.
includeAdditionalRelationLabels N One or more relation attribute Any relation attribute in the UMLS n/a Use a comma between each relation attribute to specify more than one.
pageNumber N Whole number that specifies which page of results to fetch. 1,2,3, etc 1 n/a
pageSize N Whole number that specifies the number of results to include per page. 1,2,3, etc 25 n/a

Sample Output

Sample output for /content/2015AA/source/LNC/44255-8/relations?includeAdditionalRelationLabels=has_answer&ticket=ST…

{

   "pageSize": 25,
   "pageNumber": 1,
   "pageCount": 1,
   "result": 

[

{

   "classType": "AtomClusterRelation",
   "ui": "R150334726",
   "suppressible": false,
   "sourceUi": "NONE",
   "obsolete": false,
   "sourceOriginated": false,
   "rootSource": "LNC",
   "relationLabel": "RO",
   "additionalRelationLabel": "has_answer",
   "groupId": "NONE",
   "attributeCount": 1,
   "relatedId": "https://uts-ws.nlm.nih.gov/rest/content/2015AA/source/LNC/LA6568-5",
   "relatedIdName": "Not at all"

},
{

   "classType": "AtomClusterRelation",
   "ui": "R150349583",
   "suppressible": false,
   "sourceUi": "NONE",
   "obsolete": false,
   "sourceOriginated": false,
   "rootSource": "LNC",
   "relationLabel": "RO",
   "additionalRelationLabel": "has_answer",
   "groupId": "NONE",
   "attributeCount": 1,
   "relatedId": "https://uts-ws.nlm.nih.gov/rest/content/2015AA/source/LNC/LA6570-1",
   "relatedIdName": "More than half the days"

},
{

   "classType": "AtomClusterRelation",
   "ui": "R150379228",
   "suppressible": false,
   "sourceUi": "NONE",
   "obsolete": false,
   "sourceOriginated": false,
   "rootSource": "LNC",
   "relationLabel": "RO",
   "additionalRelationLabel": "has_answer",
   "groupId": "NONE",
   "attributeCount": 1,
   "relatedId": "https://uts-ws.nlm.nih.gov/rest/content/2015AA/source/LNC/LA6571-9",
   "relatedIdName": "Nearly every day"

},

{
    "classType": "AtomClusterRelation",
    "ui": "R150401508",
    "suppressible": false,
    "sourceUi": "NONE",
    "obsolete": false,
    "sourceOriginated": false,
    "rootSource": "LNC",
    "relationLabel": "RO",
    "additionalRelationLabel": "has_answer",
    "groupId": "NONE",
    "attributeCount": 1,
    "relatedId": "https://uts-ws.nlm.nih.gov/rest/content/2015AA/source/LNC/LA6569-3",
    "relatedIdName": "Several days"
}
]

}