The caCORE type REST queries will be discontinued with the LexEVS 6.5 release. The CTS2 will replace the previous REST services. Please replace your old queries with the listed examples.
If a version is not included then LexEVS will look for a version tagged as "PRODUCTION". If no such coding scheme exists then an error will be returned. |
https://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish |
https://lexevscts2.nci.nih.gov/lexevscts2/codesystemversions?matchvalue=Zebrafish&format=xml |
Note that you could also add a version to a URL targeting a specific load in LexEVS. The following example shows the form to target the November_24_2016 version of the Zebrafish terminology.
https://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish&codingSchemeVersion=November_24_2016 |
https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/Zebrafish/version/November_24_2016?format=xml |
The information can also be returned as JSON.
https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.01e?format=json |
The GetHTML function is not supported in CTS2
https://lexevsapi6.nci.nih.gov/lexevsapi64/GetHTML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish |
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Entity&org.LexGrid.concepts.Entity[@_entityCode=C33999]&codingSchemeName=NCI_Thesaurus |
https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/entity/C33999 |
Searching by code with wildcard is not supported in CTS2
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Entity&org.LexGrid.concepts.Entity[@_entityCode=ZFA:000123*]&codingSchemeName=Zebrafish |
The old DataServices performed a strict exact match. This query will return only one result. It also specifies to only search the EntityDescription.
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Entity,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=Heart]&codingSchemeName=NCI_Thesaurus |
CTS2 does a tokenized exact match. A concept where any one token is an exact match will be included in the result set. As a result, this returns multiple concepts. In addition, CTS2 does not support specifying what value to search, so looks at all presentation properties, not just the EntityDescription.
http://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/entities?matchvalue=Heart&matchalgorithm=exactMatch?format=xml |
https://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Entity,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=He*rt*]&codingSchemeName=NCI_Thesaurus |
In CTS2 the match algorithm must be specified as luceneQuery in order to use wildcards.
https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/entities?matchalgorithm=luceneQuery&format=xml&matchvalue=He*rt |
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart]&codingSchemeName=Zebrafish |
CTS2 by default searches all presentation properties, so this use case is coincidentally supported. However CTS2 does not allow the user to specifically choose what is searched.
http://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/entities?matchvalue=Heart&matchalgorithm=exactMatch?format=xml |
Search for Concept by Presentation with wildcard - Not fully supported
http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Presentation,Text&Text\[@_content=heart*\]&codingSchemeName=Zebrafish
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart*]&codingSchemeName=Zebrafish |
As above, the user cannot specify that only Presentation properties should be searched, but this is the default.
https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/entities?matchalgorithm=luceneQuery&format=xml&matchvalue=He*rt |
Get Concept by Definition with wildcard - Not supported
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=Concept,Definition,Text&Text[@_content=Bilateral%20groups%20of%20cells*]&codingSchemeName=Zebrafish |
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Presentation&org.LexGrid.concepts.Entity[@_entityCode=ZFA:0001234]&roleName=_presentationList&codingSchemeName=Zebrafish |
CTS2 does not permit the user to specify what properties should be returned by a search. The Presentations will be returned within the body of results from an entity query.
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.concepts.Definition&org.LexGrid.concepts.Entity[@_entityCode=ZFA:0001234]&roleName=_definitionList&codingSchemeName=Zebrafish |
CTS2 does not permit the user to specify what properties should be returned by a search. The Definition will be returned within the body of results from an entity query.
CTS2 does allow the retrieval of specific associations attached to a given concept or coding scheme but does not support the listing of all supported associations
http://lexevsapi6.nci.nih.gov/lexevsapi64/GetXML?query=org.LexGrid.naming.SupportedAssociation&org.LexGrid.naming.SupportedAssociation&codingSchemeName=Zebrafish |
The results from CTS2 are formatted in the LexEVS model which varies somewhat from the caCORE model. This mapping spreadsheet was created to allow users to update their parsers to use the new format.