NLM logo

UMLS API Technical Documentation

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.

API Terms of Service

Retrieving Source-Asserted Information

URIs | Query Parameters | Sample Output

URIs with /source/{source}/{id} support the following use cases:

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/SNOMEDCT_US/9468002 Retrieves Source Concept SourceAtomCluster
/content/current/source/MSH/D015242 Retrieves Source Descriptor SourceAtomCluster
/content/current/source/LNC/54112-8 Retrieves Code SourceAtomCluster
/content/current/source/SNOMEDCT_US/9468002/atoms Retrieve atoms in a source-asserted identifier Atom
/content/current/source/SNOMEDCT_US/9468002/parents Retrieve immediate parents of a source-asserted identifier SourceAtomCluster
/content/current/source/SNOMEDCT_US/9468002/children Retrieve immediate children of source-asserted identifier SourceAtomCluster
/content/current/source/SNOMEDCT_US/9468002/ancestors Retrieve all ancestors of a source-asserted identifier SourceAtomCluster
/content/current/source/SNOMEDCT_US/9468002/descendants Retrieve all descendants of source-asserted identifier SourceAtomCluster
/content/current/source/SNOMEDCT_US/9468002/attributes Retrieves information about source-asserted attributes Attribute

Query Parameters

Parameter name Required? Y/N Description Valid Values Default value Usage Note
apiKey Y An API key is required for each call to the API. Visit your UTS profile to obtain your API key. n/a n/a n/a

Sample Output

Sample output for https://uts-ws.nlm.nih.gov/rest/content/current/source/SNOMEDCT_US/9468002?apiKey=YOUR_APIKEY…

{
	"pageSize" : 25,
	"pageNumber" : 1,
	"pageCount" : 1,
	"result" : {
		"classType" : "SourceAtomCluster",
		"ui" : "9468002",
		"suppressible" : false,
		"obsolete" : false,
		"rootSource" : "SNOMEDCT_US",
		"atomCount" : 8,
		"cVMemberCount" : 0,
		"attributes" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/attributes",
		"atoms" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/atoms",
		"descendants" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/descendants",
		"ancestors" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/ancestors",
		"parents" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/parents",
		"children" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/children",
		"relations" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/relations",
		"definitions" : "NONE",
		"concepts" : "https://uts-ws.nlm.nih.gov/rest/search/2016AA?string=9468002&sabs=SNOMEDCT_US&searchType=exact&inputType=sourceUi",
		"defaultPreferredAtom" : "https://uts-ws.nlm.nih.gov/rest/content/2016AA/source/SNOMEDCT_US/9468002/atoms/preferred",
		"name" : "Closed fracture of carpal bone"
	}
}