...

Page info
title title

{Include:LexEVS Code Pages to Include}

LexEVS 6.0 Examples

Differences from the 5.0 examples include:

...

LexEVS Data Services to be discontinued.

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.

...

Get CodingScheme details

...

https://lexevsapi6.nci.nih.gov/

...

lexevsapi64/

...

GetXML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish

httpshttp://lexevsapi60lexevscts2.nci.nih.gov/lexevsapi60lexevscts2/GetHTMLcodesystemversions?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafishmatchvalue=Zebrafish&format=xml

Note that you could also add a version to a URL targeting a specific load in LexEVS. The following non-working example show shows the form to target the 1.2November_June24_14_2010 2016 version of the Zebrafish terminology.

httpshttp://lexevsapi60lexevsapi6.nci.nih.gov/lexevsapi60lexevsapi64/GetHTMLGetXML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish&codingSchemeVersion=1.2November_June_14_2010

Get Concept by Code

...

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

http://lexevsapi60.nci.nih.gov/lexevscts2/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Entity&org.LexGrid.concepts.Entity[@_entityCode=ZFA:0001234]&codingSchemeName=Zebrafish

Get Concept by Code with wildcard

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Entity&org.LexGrid.concepts.Entity\[@_entityCode=ZFA:000123*\]&codingSchemeName=Zebrafish

codesystem/NCI_Thesaurus/version/17.01e?format=json

The GetHTML function is not supported in CTS2

https://lexevsapi6

http://lexevsapi60.nci.nih.gov/lexevsapi60lexevsapi64/GetHTML?query=org.LexGrid.conceptscodingSchemes.EntityCodingScheme&org.LexGrid.concepts.Entity[@_entityCode=ZFA:000123*]codingSchemes.CodingScheme&codingSchemeName=Zebrafish

Get Concept by Code

...

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Entity,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription\[@_content=heart\]&codingSchemeName=Zebrafish

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Entity,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=heart]&codingSchemeName=Zebrafish

Code Block
title
Code Block
Get Concept by Code

...

6.4

http://

...

lexevsapi6.nci.nih.gov/

...

lexevsapi64/

...

GetXML?query=org.LexGrid.concepts.Entity

...

&

...

Code Block
http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Entity,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=he*rt*entityCode=C33999]&codingSchemeName=Zebrafish

Get Concept by Presentation

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Presentation,Text&Text\[@_content=heart\]&codingSchemeName=Zebrafish

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart]&codingSchemeName=Zebrafish

Get Concept by Presentation with wildcard

...

NCI_Thesaurus

https://lexevscts2.nci.nih.gov/

...

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart*]&codingSchemeName=Zebrafishlexevscts2/codesystem/NCI_Thesaurus/entity/C33999

Get Concept by

...

Code with wildcard

...

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Definition,Text&Text\[@_content=Bilateral%20groups%20of%20cells*\]&codingSchemeName=Zebrafish

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Concept,Definition,Text&Text[@_content=Bilateral%20groups%20of%20cells*]&codingSchemeName=Zebrafish

Show Presentations of a Concept

 -  Not supported

Searching by code with wildcard is not supported in CTS2http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Presentation&org.LexGrid.concepts.Entity\[@_entityCode=ZFA:0001234\]&roleName=_presentationList&codingSchemeName=Zebrafish

http://lexevsapi60lexevsapi6.nci.nih.gov/lexevsapi60lexevsapi64/GetHTMLGetXML?query=org.LexGrid.concepts.Presentation&org.LexGrid.concepts.Entity[@_entityCode=ZFA:0001234]&roleName=_presentationList&codingSchemeName=Zebrafish

Show Definitions of a Concept

...

&org.LexGrid.concepts.Entity

...

[@_entityCode=ZFA:

...

000123*]&

...

codingSchemeName=Zebrafish

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.concepts.Definition&org.LexGrid.concepts.Entity[@_entityCode=ZFA:0001234]&roleName=_definitionList&codingSchemeName=Zebrafish

Show Supported Associations for a CodingScheme

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.naming.SupportedAssociation&org.LexGrid.naming.SupportedAssociation&codingSchemeName=Zebrafish

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=org.LexGrid.naming.SupportedAssociation&org.LexGrid.naming.SupportedAssociation&codingSchemeName=Zebrafish

LexEVS 5.0 Examples

Get CodingScheme details

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish

Note that you could also add a version to a URL targeting a specific load in LexEVS. For example, you might use this if you wanted to target the 1.2_June_14_2010 version of the Zebrafish terminology.

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.codingSchemes.CodingScheme&org.LexGrid.codingSchemes.CodingScheme&codingSchemeName=Zebrafish&codingSchemeVersion=1.2_June_14_2010

Get Concept by Code

...

Search for Concept by EntityDescription - Not fully supported

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.

...

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.ConceptcommonTypes.EntityDescription&org.LexGrid.conceptscommonTypes.ConceptEntityDescription[@_entityCodecontent=ZFA:0001234Heart]&codingSchemeName=Zebrafish

Get Concept by Code with wildcard

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.Concept&org.LexGrid.concepts.Concept\[@_entityCode=ZFA:000123*\]&codingSchemeName=Zebrafish

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.Concept&org.LexGrid.concepts.Concept[@_entityCode=ZFA:000123*]&codingSchemeName=Zebrafish

Get Concept by Code by EntityDescription

...

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/

...

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.Concept,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=heart]&codingSchemeName=Zebrafish

Get Concept by Code by EntityDescription with wildcard

...

lexevscts2/codesystem/NCI_Thesaurus/entities?matchvalue=Heart&matchalgorithm=exactMatch?format=xml

Search for Concept with wildcard

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.Zebrafish

httphttps://lexevsapilexevscts2.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.Concept,org.LexGrid.commonTypes.EntityDescription&org.LexGrid.commonTypes.EntityDescription[@_content=he*rt*]&codingSchemeName=Zebrafish

...

/lexevscts2/codesystem/NCI_Thesaurus/entities?matchalgorithm=luceneQuery&format=xml&matchvalue=He*rt

Search for Concept by Presentation - Not fully supported

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://lexevsapilexevscts2.nci.nih.gov/lexevsapi50/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart]&codingSchemeName=Zebrafish

...

/lexevscts2/codesystem/NCI_Thesaurus/entities?matchvalue=Heart&matchalgorithm=exactMatch?format=xml

Search for Concept by Presentation with wildcard - Not fully supported

http://lexevsapilexevsapi60.nci.nih.gov/lexevsapi50lexevsapi60/GetHTML?query=Concept,Presentation,Text&Text\[@_content=heart*\]&codingSchemeName=ZebrafisZebrafish

http://lexevsapilexevsapi6.nci.nih.gov/lexevsapi50lexevsapi64/GetHTML?query=Concept,Presentation,Text&Text[@_content=heart*]&codingSchemeName=Zebrafish

Get Concept by Definition with wildcard

...

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/lexevsapi50/GetHTML?query=Concept,Definition,Text&Text\[@_content=Bilateral%20groups%20of%20cells*\]&codingSchemeName=Zebrafish

http://lexevsapilexevsapi6.nci.nih.gov/lexevsapi50lexevsapi64/GetHTMLGetXML?query=Concept,Definition,Text&Text[@_content=Bilateral%20groups%20of%20cells*]&codingSchemeName=Zebrafish

Show Presentations of a Concept  - Not fully supported

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.

Show Definitions of a Concept - Not fully supported

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.

Show Supported Associations for a CodingScheme - Not supported

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

http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.naming.SupportedAssociation&org.LexGrid.naming.SupportedAssociation&codingSchemeName=Zebrafish

...

caCORE to LexEVS XML Mapping

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.