API for Major Surgeries and Implants
This procedures list was derived from the Regenstrief Institute's Medical Gopher program and contains about 280 major surgeries and implants procedures. It also contains an extensive list of full term and word synonyms. This list was used for the NLM's Personal Health Record (PHR) project. To see a demo of the NLM PHR, visit https://phr-demo.nlm.nih.gov.This service is provided "as is" and free of charge. Please see the Frequently Asked Questions page for more details on terms of service, etc.
The following demo shows how this API might be used with an autocompleter we've developed.
For further experimentation with the autocompleter and this API, try the autocompleter demo page.
API Base URL: https://clinicaltables.nlm.nih.gov/api/procedures/v3/search (+ query string parameters)
This data set may also be accessed through the FHIR ValueSet $expand operation.
In addition to the base URL, you will need to specify other parameters. See the query string parameters section below for details.
At a minimum, when using the above base URL, you will need to specify the "terms" parameter containing a word or partial word to match.
|Parameter Name||Default Value||Description|
|terms||(Required.) The search string (e.g., just a part of a word) for which to find matches in the list. More than one partial word can be present in "terms", in which case there is an implicit AND between them.|
|maxList||Optional, with a default of 7. Specifies the number of results requested, up to the upper limit of 500. If present but the value is empty, 500 will be used.|
|q||An optional, additional query string used to further constrain the results returned by the "terms" field. Unlike the terms field, "q" is not automatically wildcarded, but can include wildcards and can specify field names. See the Elasticsearch query string page for documentation of supported syntax.|
|df||consumer_name||A comma-separated list of display fields (from the fields section below) which are intended for the user to see when looking at the results.|
|sf||consumer_name, primary_name, word_synonyms, synonyms, term_icd9_code, term_icd9_text||A comma-separated list of fields to be searched.|
|cf||key_id||A field to regard as the "code" for the returned item data.|
|ef||A comma-separated list of additional fields to be returned for each retrieved list item. (See the Output format section for how the data for fields is returned.) If you wish the keys in the returned data hash to be something other than the field names, you can specify an alias for the field name by separating it from its field name with a colon, e.g., "ef=field_name1:alias1,field2,field_name3:alias3,etc. Note that not every field specified in the ef parameter needs to have an alias.|
|primary_name||The name of the procedure.|
|consumer_name||A more consumer-friendly version of the procedure name in the primary_name field.|
|key_id||A unique idenitifier (a code) for the procedure|
|term_icd9_code||The ICD-9-CM code for the term. Not all terms are coded with ICD-9-CM.|
|term_icd9_text||The ICD-9-CM display text for the term. Not all terms are coded with ICD-9-CM.|
|word_synonyms||Synonyms for each of the words in the term.|
|synonyms||Synonyms for the whole term.|
|info_link_data||Links to information about the procedure. The returned data is an array of arrays. There is one inner array for each available link about the procedure, and each inner array contains the link and the linked page's title (which is useful if you are displaying the list of links for the user to pick one).|
Output for an API query is an array of the following elements:
- The total number of results on the server (which can be more than the number returned). For APIs in which there are millions of records, this number might be a lower bound due to early termination if there are more than a hundred thousand results.
- An array of codes for the returned items. (This is the field specified with the cf query parameter above.)
- A hash of the "extra" data requested via the "ef" query parameter above. The keys on the hash are the fields (or their requested aliases) named in the "ef" parameter, and the value for a field is an array of that field's values in the same order as the returned codes.
- An array, with one element for each returned code, where each element is an array of the display strings specified with the "df" query parameter.
- An array, with one element for each returned code, where each element is the "code system" for the returned code. Note that only code-system aware APIs will return this array.
Sample API Queries
|https://clinicaltables.nlm.nih.gov/api/procedures/v3/search?terms=gast||[13,["2563","26540","26541","2827","4152","2048","5611"],null,[["Gastrostomy"],["Roux-en-Y gastric bypass - open"],["Roux-en-Y gastric bypass - laparoscopic"],["Gastrectomy - total"],["Gastric repair"],["Billroth I gastrectomy"],["Gastrointestinal surgery"]]]||Returns 7 (out of 13 total) procedures that match (or have as prefix) the string "gast". The first array in the results above has the key_id values for the returned procedures, the second array has the primary_name values.|