API for Cytogenetic Locations
This API provides access to information about cytogenetic locations, taken from the NCBI ideogram data.
Currently using: Data for
The following demo shows how this API might be used with an autocompleter we've developed. (Example: Try typing 2p.)
For further experimentation with the autocompleter and this API, try the autocompleter demo page.
API Base URL: https://clinicaltables.nlm.nih.gov/api/cytogenetic_locs/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||cytogenetic||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||All fields||A comma-separated list of fields to be searched.|
|cf||cytogenetic||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.|
|chromosome||The chromosome number.|
|arm||The arm (p or q) of the location.|
|band||The band number of the location.|
|iscn_start||The cytogenetic start position.|
|iscn_stop||The cytogenetic stop position.|
|stain||The "stain" field from the source data file|
|cytogenetic||A concatenation of the chromosome, arm, and band values; the cytogenetic location.|
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/cytogenetic_locs/v3/search?terms=1p&df=chromosome,arm,band||[34,["1p36.32","1p36.13","1p34.2","1p32.1","1p22.2","1p13.3","1p11.1"],null,[["1","p","36.32"],["1","p","36.13"],["1","p","34.2"],["1","p","32.1"],["1","p","22.2"],["1","p","13.3"],["1","p","11.1"]]]||Returns the first 7 matches of 34 for cytogenetic locations starting with 1p. The combined "cytogenetic" field was returns as the code values, while the individual pieces of the location (chromosome, arm, and band) were returned as the display values.|