NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Browser
  • Java
  • Scala
  • Python
  • JavaScript
  • Unix Command line
  • Any platform able to handle REST calls and XML or JSON formatted responses

Browser

Any Browser browser window is a REST client. A User user can type in the REST command and view the resulting XML or otherwise formatted text/JSON. Click on image to expand:

...

We recommend using the free community edition of Intellij

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include
. Download and install the Scala plugin according to the directions. Then follow instructions for creating a Scala project and an object like the following. Change the URL to whatever CTS2 service is available.

Code Block
languagejava
titleScala REST Example
collapsetrue
package mayo.edu.cts2.client.rest.scala

import java.net.{HttpURLConnection, URL}
import io.Source

/**
 * Created with IntelliJ IDEA.
 */
object CTS2RestClient extends App{
  val connection =
    new URL("http://http://lexevscts2.nci.nih.gov/lexevscts2/valuesets").openConnection().asInstanceOf[HttpURLConnection]
  val inputStream = connection.getInputStream
  val src = Source.fromInputStream(inputStream)
  src.getLines().foreach(println)
}

...

Install Python on your system. Create a text file with the .py extension and run with the "python myrestclient.py" command.

Code Block
languagepython
titleSimple Python Rest Client
collapsetrue
__author__ = 'sbauer'
import urllib2

try:
    file = urllib2.urlopen('http://lexevscts2.nci.nih.gov/lexevscts2/resolvedvaluesets')
except urllib2.URLError, e:
    if e.code == 404:
        print("check url")
#     continue to handle other errors here
else:
    print(file.read())

...

Code Block
languagepython
titlePython REST Client
collapsetrue
__author__ = 'sbauer'
from restful_lib import Connection

conn = Connection("http://http://lexevscts2.nci.nih.gov/lexevscts2")
reply = conn.request_get("/valuesets")
if reply['headers']['status'] == '200':
    print reply['body']


conn = Connection("http://http://lexevscts2.nci.nih.gov/lexevscts2")
reply = conn.request_get("/valuesets?format=json",headers={'Accept':'application/json;q=1.0'})
if reply['headers']['status'] == '200':
    print reply['body']
    print eval(reply['body'])

conn = Connection("http://http://lexevscts2.nci.nih.gov/lexevscts2")
print conn.request_get("/valuesets?matchvalue='Sequence'")['body']

JavaScript (JQuery and Bootstrap.js)

Warning

This script example features JSON parsing.  The JSON structure in CTS2 1.0 was non-standard and will not be compatible with the standardized JSON in CTS2 1.1.  CTS2 XML is standard.  CTS2 associated with LexEVS 6.2 will contain the standard version of JSON for CTS 1.1.

 

  • Download JQuery 1.10.x
    Multiexcerpt include
    MultiExcerptNameExitDisclaimer
    nopaneltrue
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    and Bootstrap 3.0.x
    Multiexcerpt include
    MultiExcerptNameExitDisclaimer
    nopaneltrue
    PageWithExcerptwikicontent:Exit Disclaimer to Include
  • Create a CTSRest directory for your files
  • Add directories bootstrap and cts2 to this root
  • Add subdirectories js and css to both directories you've just created
  • Add bootstrap.js to the bootstrap/js directory
  • Add bootstrap.min.css to the bootstrap/css directory
  • Add jquery-1.10.2.js to the cts2/js library
  • Create a codeSystem.js text file and add the following text (adjust the serviceUrl to point to a convenient CTS2 service)
Code Block
languagejavascript
titleJavaScript REST Client
collapsetrue
var CodeSystemListConfig = {
    serviceUrl: "http://<base url>/codesystemversions?format=json"
};

function init() {

    $(document).ready(
        function() {
            var url = CodeSystemListConfig.serviceUrl;
            $.getJSON(url + "&callback=?", function (data) {

                for (var i in data.codeSystemVersionCatalogEntryDirectory.entryList) {
                    var entry = data.codeSystemVersionCatalogEntryDirectory.entryList[i];
                    var key = entry.formalName;
                    var designation = entry.documentURI;
                    var uri = entry.href;
                    $("ul").append("<li><a href=\"" + uri +"\">" + key + "</a></li>");
                }
            });
        });
}
  • when complete add codesystem.js to the cts2/js directory
  • Create a new html file containing the following html and add it to the root CTSRest folder
Code Block
languagehtml/xml
titleHTML
collapsetrue
<!DOCTYPE html>
<html>
<head>
    <title>Code System</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- Bootstrap -->
    <link href="bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">
    <script src="cts2/js/codeSystem.js"></script>
    <script src="cts2/js/jquery-1.10.2.js"></script>
</head>
<body>
<h1>Code Systems</h1>
<script>init()</script>
<ul class="nav nav-pills nav-stacked">
    <li class="active"><a href="#">Home</a></li>
</ul>
<script src="bootstrap/js/bootstrap.js"></script>
</body>
</html>
  • Open the new HTML file in a browser and you should see  code systems displayed on a browser page.

Warning
titleTroubleshooting

If this page shows errors in your browser's debugging tools, you may have extraneous characters in your text file. Try removing all indentations, save and run again.

Unix Command Line

returns XML that can be piped to a file

Code Block
languagebash
titleShell Script using Unix curl command
r0223758:~ m029206$ curl http://lexevscts2.nci.nih.gov/lexevscts2/codesystemversions

Java Serialization using the CTS2 Framework

CTS2 Framework Serialization snippet

A reference implementation framework in Java includes parsing and marshaling utilities as well as CTS2 model elements in Java to serialize the JSON responses. For example:

Code Block
           JsonConverter converter = new JsonConverter();
            ResolvedValueSetDirectory valuesetdir = converter.fromJson(
            <JSON>, ResolvedValueSetDirectory.class);
Getting the Framework

Unix Command Line

returns XML that can be piped to a file

Code Block
languagebash
titleShell Script using Unix curl command
$ curl http://lexevscts2.nci.nih.gov/lexevscts2/codesystemversions

Java Serialization using the CTS2 Framework

CTS2 Framework Serialization snippet

A reference implementation framework in Java includes parsing and marshaling utilities as well as CTS2 model elements in Java to serialize the JSON responses. For example:

Code Block
           JsonConverter converter = new JsonConverter();
            ResolvedValueSetDirectory valuesetdir = converter.fromJson(
            <JSON>, ResolvedValueSetDirectory.class);
Getting the Framework
Note
titleHint

You may have handshake errors running maven against the new SSL enabled repository URL. If so try adjusting Maven Options as follows:

export MAVEN_OPTS

Note
titleHint

You may have handshake errors running maven against the new SSL enabled repository URL. If so try adjusting Maven Options as follows:

export MAVEN_OPTS="-Dhttps.protocols=TLSv1.1,TLSv1.2 -Dforce.http.jre.executor=true -Xmx3072m -XX:MaxPermSize=752m"

...

Info

Generally returned summary lists are returned as Directories and single elements are returned as messages such as "EntryMsg"such as "EntryMsg"

Info

The following examples show how to have the output formatted to JSON with the "format=json" parameter.  When the format is not specified, it will default to XML.

DescriptionRESTModel Element Class
Code System Versions<base url>codesystemversions?format=jsonCodeSystemVersionCatalogEntryDirectory
Code System Read
<base url>/codesystem/NCI_Thesaurus/version/17.06d
CodeSystemVersionCatalogEntryMsg
Code System Version Query<base url>/codesystemversions?matchvalue=nci_thesaurus&filtercomponent=resourceName&format=jsonCodeSystemVersionCatalogEntryDirectory
Value Sets<base url>resolvedvaluesets?format=jsonResolvedValueSetDirectory
Value Set Definition Read<base url>/cts2/valueset/CDISC ADaM Terminology/definition/5f51c37b?format=jsonValueSetDefinitionMsg
Value Set Query
<base url>/resolvedvaluesets?matchvalue=imputation&filtercomponent=resourceName&format=json
ResolvedValueSetDirectory
Value Set Entries<base url>/valueset/valueset/CDISC Questionnaire Terminology/definition/aa5e7b3f/resolution/1?format=json
IteratableResolvedValueSet
Entities
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?format=json
EntityDirectory
Entity Read<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399?format=jsonEntityDescriptionMsg
Entity Query
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?matchvalue=swelling&format=json
EntityDirectory
Association parents<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399?format=json

EntityDescriptionMsg
with an instance entity with method calls:

entity.getEntityDescription().getNamedEntity().getParent()

returning an instance of URIAndEntityName[]

Association children
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/children?format=json
EntityDirectory
Association subjectOf
<base url>/codesystem/npo/version/TestForMultiNamespace/entity/GO:NPO_1607/subjectof?format=json
AssociationDirectory
Association targetOf
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof?format=json
AssociationDirectory
Maps
<base url>/mapversions?format=json
MapVersionDirectory
Map Version Query<base url>/mapversions?matchvalue=ncit&filtercomponent=resourceSynopsis&format=jsonMapVersionDirectory
Map Version Read
<base url>/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0?format=json
MapVersionMsg
Map Entities
<base url>/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entries?format=json
 MapEntryDirectory 
Map Restriction To, From, or Both Role
<base url>/mapversions?codesystem=ICD10CM&codesystemsmaprole=MAP_TO_ROLE&format=json
MapVersionDirectory

...

Returns a set of CodeSystemVersions.

Code Block
http://<base url>/codesystemversions?maxtoreturn=5&format=json

...

Returns a set of CodeSystemVersions based on a text match.

Code Block
http://<base url>/codesystemversions?matchvalue=nci_thesaurus&filtercomponent=resourceName&format=json

Output

Code Block
collapsetrue
{

    "CodeSystemVersionCatalogEntryDirectory": {
        "entry": [
            {
                "codeSystemVersionName": "NCI_Thesaurus-17.02d",
                "versionOf": {
                    "content": "NCI_Thesaurus",
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                },
                "documentURI": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.02d",
                "officialResourceVersionId": "17.02d",
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.02d",
                "formalName": "NCI Thesaurus",
                "resourceSynopsis": {
                    "value": "NCI Thesaurus"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.02d"
            },
            {
                "codeSystemVersionName": "NCI_Thesaurus-17.03d",
                "versionOf": {
                    "content": "NCI_Thesaurus",
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                },
                "documentURI": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.03d",
                "officialResourceVersionId": "17.03d",
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.03d",
                "formalName": "NCI Thesaurus",
                "resourceSynopsis": {
                    "value": "NCI Thesaurus"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.03d"
            },
            {
                "codeSystemVersionName": "NCI_Thesaurus-17.04d",
                "versionOf": {
                    "content": "NCI_Thesaurus",
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                },
                "documentURI": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.04d",
                "officialResourceVersionId": "17.04d",
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.04d",
                "formalName": "NCI Thesaurus",
                "resourceSynopsis": {
                    "value": "NCI Thesaurus"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.04d"
            },
            {
                "codeSystemVersionName": "NCI_Thesaurus-17.06d",
                "versionOf": {
                    "content": "NCI_Thesaurus",
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                },
                "documentURI": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.06d",
                "officialResourceVersionId": "17.06d",
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.06d",
                "formalName": "NCI Thesaurus",
                "resourceSynopsis": {
                    "value": "NCI Thesaurus"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
            }
        ],
        "complete": "COMPLETE",
        "numEntries": 4,
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystemversions",
            "parameter": [
                {
                    "arg": "matchvalue",
                    "val": "nci_thesaurus"
                },
                {
                    "arg": "filtercomponent",
                    "val": "resourceName"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T16:23:29.829-04:00"
        }
    }

}

...

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?maxtoreturn=250&format=json

Output

Code Block
collapsetrue
{

    "EntityDirectory": {
        "entry": [
            {
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C14722",
                "name": {
                    "namespace": "NCI_Thesaurus",
                    "name": "C14722"
                },
                "knownEntityDescription": [
                    {
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C14722",
                        "describingCodeSystemVersion": {
                            "version": {
                                "content": "NCI_Thesaurus-17.06d",
                                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                            },
                            "codeSystem": {
                                "content": "NCI_Thesaurus",
                                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                            }
                        },
                        "designation": "Other Inbred Strains"
                    }
                ]
            },
            {
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C422",
                "name": {
                    "namespace": "NCI_Thesaurus",
                    "name": "C422"
                },
                "knownEntityDescription": [
                    {
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C422",
                        "describingCodeSystemVersion": {
                            "version": {
                                "content": "NCI_Thesaurus-17.06d",
                                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                            },
                            "codeSystem": {
                                "content": "NCI_Thesaurus",
                                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                            }
                        },
                        "designation": "Dexamethasone"
                    }
                ]
            }
        ],
        "complete": "PARTIAL",
        "numEntries": 2,
        "next": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entities?page=1&format=json&maxtoreturn=2",
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystem/NCI_Thesaurus/version/17.06d/entities",
            "parameter": [
                {
                    "arg": "maxtoreturn",
                    "val": "2"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T16:32:47.760-04:00"
        }
    }

}

...

Output

Code Block
collapsetrue
{

    "EntityDescriptionMsg": {
        "entityDescription": {
            "namedEntity": {
                "entryState": "ACTIVE",
                "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C3399",
                "entityID": {
                    "namespace": "NCI_Thesaurus",
                    "name": "C3399"
                },
                "describingCodeSystemVersion": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                },
                "designation": [
                    {
                        "designationRole": "ALTERNATIVE",
                        "assertedInCodeSystemVersion": "NCI",
                        "value": "Swelling",
                        "language": {
                            "content": "en"
                        }
                    },
                    {
                        "designationRole": "ALTERNATIVE",
                        "assertedInCodeSystemVersion": "FDA",
                        "value": "Swelling",
                        "language": {
                            "content": "en"
                        }
                    },
                    {
                        "designationRole": "PREFERRED",
                        "value": "Swelling",
                        "language": {
                            "content": "en"
                        }
                    }
                ],
                "definition": [
                    {
                        "definitionRole": "NORMATIVE",
                        "value": "Enlargement; expansion in size; sign of inflammation"
                    }
                ],
                "property": [
                    {
                        "predicate": {
                            "uri": "http://lexgrid.org/definition-preferred",
                            "namespace": "NCI_Thesaurus",
                            "name": "DEFINITION"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Enlargement; expansion in size; sign of inflammation"
                                }
                            }
                        ],
                        "propertyQualifier": [
                            {
                                "predicate": {
                                    "uri": "http://lexgrid.org/property-source",
                                    "namespace": "lexgrid",
                                    "name": "property-source"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "NCI"
                                        }
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://lexgrid.org/presentation-alternate",
                            "namespace": "NCI_Thesaurus",
                            "name": "FULL_SYN"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Swelling"
                                }
                            }
                        ],
                        "propertyQualifier": [
                            {
                                "predicate": {
                                    "uri": "http://lexgrid.org/representational-form",
                                    "namespace": "lexgrid",
                                    "name": "representational-form"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "PT"
                                        }
                                    }
                                ]
                            },
                            {
                                "predicate": {
                                    "uri": "http://lexgrid.org/property-source",
                                    "namespace": "lexgrid",
                                    "name": "property-source"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "NCI"
                                        }
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://lexgrid.org/presentation-alternate",
                            "namespace": "NCI_Thesaurus",
                            "name": "FULL_SYN"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Swelling"
                                }
                            }
                        ],
                        "propertyQualifier": [
                            {
                                "predicate": {
                                    "uri": "http://lexgrid.org/representational-form",
                                    "namespace": "lexgrid",
                                    "name": "representational-form"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "PT"
                                        }
                                    }
                                ]
                            },
                            {
                                "predicate": {
                                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#source-code",
                                    "namespace": "NCI_Thesaurus",
                                    "name": "source-code"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "2091"
                                        }
                                    }
                                ]
                            },
                            {
                                "predicate": {
                                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#subsource-name",
                                    "namespace": "NCI_Thesaurus",
                                    "name": "subsource-name"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "CDRH"
                                        }
                                    }
                                ]
                            },
                            {
                                "predicate": {
                                    "uri": "http://lexgrid.org/property-source",
                                    "namespace": "lexgrid",
                                    "name": "property-source"
                                },
                                "value": [
                                    {
                                        "literal": {
                                            "value": "FDA"
                                        }
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://lexgrid.org/presentation-preferred",
                            "namespace": "NCI_Thesaurus",
                            "name": "Preferred_Name"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Swelling"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#Contributing_Source",
                            "namespace": "NCI_Thesaurus",
                            "name": "Contributing_Source"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "FDA"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#FDA_Table",
                            "namespace": "NCI_Thesaurus",
                            "name": "FDA_Table"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Patient Code (Appendix B)"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#Legacy_Concept_Name",
                            "namespace": "NCI_Thesaurus",
                            "name": "Legacy_Concept_Name"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Swelling"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#Semantic_Type",
                            "namespace": "NCI_Thesaurus",
                            "name": "Semantic_Type"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Sign or Symptom"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#UMLS_CUI",
                            "namespace": "NCI_Thesaurus",
                            "name": "UMLS_CUI"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "C0038999"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#code",
                            "namespace": "NCI_Thesaurus",
                            "name": "code"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "C3399"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#label",
                            "namespace": "NCI_Thesaurus",
                            "name": "label"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Swelling"
                                }
                            }
                        ]
                    }
                ],
                "subjectOf": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/subjectof",
                "targetOf": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof",
                "parent": [
                    {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C53458",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C53458",
                        "namespace": "NCI_Thesaurus",
                        "name": "C53458"
                    }
                ],
                "children": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/children",
                "entityType": [
                    {
                        "uri": "http://www.w3.org/2002/07/owl#Class",
                        "namespace": "owl",
                        "name": "Class"
                    }
                ]
            }
        },
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystem/NCI_Thesaurus/version/17.06d/entity/C3399",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T17:17:24.701-04:00"
        }
    }

}

...

Returns all the children of the designated Entityentity.

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/children?format=json

...

Returns all entities that are the target of this entity in an association.

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof?maxtoreturn=5&format=json

Output

Code Block
collapsetrue
{

    "AssociationDirectory": {
        "entry": [
            {
                "subject": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C3399",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399",
                    "namespace": "NCI_Thesaurus",
                    "name": "C3399"
                },
                "predicate": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#R108",
                    "name": "Disease_Has_Finding"
                },
                "target": {
                    "entity": {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#@75fee354830c997d4bc0e128e16aec09",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/@75fee354830c997d4bc0e128e16aec09",
                        "namespace": "NCI_Thesaurus",
                        "name": "@75fee354830c997d4bc0e128e16aec09"
                    }
                },
                "assertedBy": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            },
            {
                "subject": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#@75fee354830c997d4bc0e128e16aec09",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/@75fee354830c997d4bc0e128e16aec09",
                    "namespace": "NCI_Thesaurus",
                    "name": "@75fee354830c997d4bc0e128e16aec09"
                },
                "predicate": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#R108",
                    "name": "Disease_Has_Finding"
                },
                "target": {
                    "entity": {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C27477",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C27477",
                        "namespace": "NCI_Thesaurus",
                        "name": "C27477"
                    }
                },
                "assertedBy": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            },
            {
                "subject": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C27477",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C27477",
                    "namespace": "NCI_Thesaurus",
                    "name": "C27477"
                },
                "predicate": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#R108",
                    "name": "Disease_Has_Finding"
                },
                "target": {
                    "entity": {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#@75fee354830c997d4bc0e128e16aec09",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/@75fee354830c997d4bc0e128e16aec09",
                        "namespace": "NCI_Thesaurus",
                        "name": "@75fee354830c997d4bc0e128e16aec09"
                    }
                },
                "assertedBy": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            },
            {
                "subject": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#@75fee354830c997d4bc0e128e16aec09",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/@75fee354830c997d4bc0e128e16aec09",
                    "namespace": "NCI_Thesaurus",
                    "name": "@75fee354830c997d4bc0e128e16aec09"
                },
                "predicate": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#R108",
                    "name": "Disease_Has_Finding"
                },
                "target": {
                    "entity": {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C27374",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C27374",
                        "namespace": "NCI_Thesaurus",
                        "name": "C27374"
                    }
                },
                "assertedBy": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            },
            {
                "subject": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#C27374",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C27374",
                    "namespace": "NCI_Thesaurus",
                    "name": "C27374"
                },
                "predicate": {
                    "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#R108",
                    "name": "Disease_Has_Finding"
                },
                "target": {
                    "entity": {
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl#@75fee354830c997d4bc0e128e16aec09",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/@75fee354830c997d4bc0e128e16aec09",
                        "namespace": "NCI_Thesaurus",
                        "name": "@75fee354830c997d4bc0e128e16aec09"
                    }
                },
                "assertedBy": {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            }
        ],
        "complete": "PARTIAL",
        "numEntries": 5,
        "next": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof?page=1&format=json&maxtoreturn=5",
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof",
            "parameter": [
                {
                    "arg": "maxtoreturn",
                    "val": "5"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T17:21:47.508-04:00"
        }
    }

}

...

Returns a list of summaries of a all code system maps on page at a time (With the option of choosing page place and moving iteration to the next page).

Code Block
http://<base url>/mapversions?format=json

Output

Code Block
collapsetrue
{

    "MapVersionDirectory": {
        "entry": [
            {
                "mapVersionName": "MA_to_NCIt_Mapping-1.0",
                "versionOf": {
                    "content": "MA_to_NCIt_Mapping",
                    "uri": "MA_to_NCIt_Mapping",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping"
                },
                "documentURI": "MA_to_NCIt_Mapping",
                "about": "MA_to_NCIt_Mapping",
                "formalName": "MA_to_NCIt_Mapping",
                "resourceSynopsis": {
                    "value": "MA_to_NCIt_Mapping"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0"
            },
            {
                "mapVersionName": "GO_to_NCIt_Mapping-1.1",
                "versionOf": {
                    "content": "GO_to_NCIt_Mapping",
                    "uri": "GO_to_NCIt_Mapping",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/GO_to_NCIt_Mapping"
                },
                "documentURI": "GO_to_NCIt_Mapping",
                "about": "GO_to_NCIt_Mapping",
                "formalName": "GO_to_NCIt_Mapping",
                "resourceSynopsis": {
                    "value": "GO_to_NCIt_Mapping"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/GO_to_NCIt_Mapping/version/GO_to_NCIt_Mapping-1.1"
            },
            {
                "mapVersionName": "NCIt_to_ChEBI_Mapping-1.0",
                "versionOf": {
                    "content": "NCIt_to_ChEBI_Mapping",
                    "uri": "urn:oid:NCIt_to_ChEBI_Mapping",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/NCIt_to_ChEBI_Mapping"
                },
                "documentURI": "urn:oid:NCIt_to_ChEBI_Mapping",
                "about": "urn:oid:NCIt_to_ChEBI_Mapping",
                "formalName": "NCIt_to_ChEBI_Mapping",
                "resourceSynopsis": {
                    "value": "NCIt_to_ChEBI_Mapping"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/NCIt_to_ChEBI_Mapping/version/NCIt_to_ChEBI_Mapping-1.0"
            },
            {
                "mapVersionName": "PDQ_2016_07_31_TO_NCI_2016_10E-2016_07_31",
                "versionOf": {
                    "content": "PDQ_2016_07_31_TO_NCI_2016_10E",
                    "uri": "urn:oid:CL512803.PDQ.NCI",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/PDQ_2016_07_31_TO_NCI_2016_10E"
                },
                "documentURI": "urn:oid:CL512803.PDQ.NCI",
                "about": "urn:oid:CL512803.PDQ.NCI",
                "formalName": "PDQ_2016_07_31_TO_NCI_2016_10E",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/PDQ_2016_07_31_TO_NCI_2016_10E/version/PDQ_2016_07_31_TO_NCI_2016_10E-2016_07_31"
            },
            {
                "mapVersionName": "SNOMEDCT_US_2016_09_01_TO_ICD10_2010-20160901",
                "versionOf": {
                    "content": "SNOMEDCT_US_2016_09_01_TO_ICD10_2010",
                    "uri": "urn:oid:C3645687.SNOMEDCT_US.ICD10",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/SNOMEDCT_US_2016_09_01_TO_ICD10_2010"
                },
                "documentURI": "urn:oid:C3645687.SNOMEDCT_US.ICD10",
                "about": "urn:oid:C3645687.SNOMEDCT_US.ICD10",
                "formalName": "SNOMEDCT_US_2016_09_01_TO_ICD10_2010",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/SNOMEDCT_US_2016_09_01_TO_ICD10_2010/version/SNOMEDCT_US_2016_09_01_TO_ICD10_2010-20160901"
            },
            {
                "mapVersionName": "SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014-20160901",
                "versionOf": {
                    "content": "SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014",
                    "uri": "urn:oid:C3645705.SNOMEDCT_US.ICD10CM",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014"
                },
                "documentURI": "urn:oid:C3645705.SNOMEDCT_US.ICD10CM",
                "about": "urn:oid:C3645705.SNOMEDCT_US.ICD10CM",
                "formalName": "SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014/version/SNOMEDCT_US_2016_09_01_TO_ICD10CM_2014-20160901"
            },
            {
                "mapVersionName": "NCIt_to_HGNC_Mapping-1.0",
                "versionOf": {
                    "content": "NCIt_to_HGNC_Mapping",
                    "uri": "NCIt_to_HGNC_Mapping",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/NCIt_to_HGNC_Mapping"
                },
                "documentURI": "NCIt_to_HGNC_Mapping",
                "about": "NCIt_to_HGNC_Mapping",
                "formalName": "NCIt_to_HGNC_Mapping",
                "resourceSynopsis": {
                    "value": "NCIt_to_HGNC_Mapping"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/NCIt_to_HGNC_Mapping/version/NCIt_to_HGNC_Mapping-1.0"
            }
        ],
        "complete": "COMPLETE",
        "numEntries": 7,
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "mapversions",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T17:23:10.907-04:00"
        }
    }

}

...

Returns a specific map version for a given map version resource synopsis.

Code Block
http://<base url>/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0?format=json

Output

Code Block
collapsetrue
{

    "MapVersionMsg": {
        "mapVersion": {
            "mapVersionName": "MA_to_NCIt_Mapping-1.0",
            "versionOf": {
                "content": "MA_to_NCIt_Mapping",
                "uri": "MA_to_NCIt_Mapping",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping"
            },
            "fromCodeSystemVersion": {
                "version": {
                    "content": "ma-null",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/ma/version/null"
                },
                "codeSystem": {
                    "content": "ma"
                }
            },
            "toCodeSystemVersion": {
                "version": {
                    "content": "NCI_Thesaurus-null",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/null"
                },
                "codeSystem": {
                    "content": "NCI_Thesaurus"
                }
            },
            "documentURI": "MA_to_NCIt_Mapping",
            "state": "FINAL",
            "sourceAndNotation": {
                "sourceAndNotationDescription": "LexEVS"
            },
            "about": "MA_to_NCIt_Mapping",
            "formalName": "MA_to_NCIt_Mapping",
            "keyword": [
                "MA_to_NCIt_Mapping"
            ],
            "resourceSynopsis": {
                "value": "MA_to_NCIt_Mapping"
            },
            "entryState": "ACTIVE"
        },
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T17:25:58.902-04:00"
        }
    }

}

...

Output

Code Block
collapsetrue
{

    "MapEntryDirectory": {
        "entry": [
            {
                "assertedBy": {
                    "mapVersion": {
                        "content": "MA_to_NCIt_Mapping-1.0",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MA_to_NCIt_Mapping/version/1.0"
                    },
                    "map": {
                        "content": "MA_to_NCIt_Mapping",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping"
                    }
                },
                "mapFrom": {
                    "uri": "http://www.w3.org/ns/ma-ont#MA:0000002",
                    "namespace": "MA",
                    "name": "MA:0000002"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entry/MA:MA%253A0000002",
                "resourceName": "MA:MA%253A0000002"
            },
            {
                "assertedBy": {
                    "mapVersion": {
                        "content": "MA_to_NCIt_Mapping-1.0",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MA_to_NCIt_Mapping/version/1.0"
                    },
                    "map": {
                        "content": "MA_to_NCIt_Mapping",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping"
                    }
                },
                "mapFrom": {
                    "uri": "http://www.w3.org/ns/ma-ont#MA:0000003",
                    "namespace": "MA",
                    "name": "MA:0000003"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entry/MA:MA%253A0000003",
                "resourceName": "MA:MA%253A0000003"
            },
            {
                "assertedBy": {
                    "mapVersion": {
                        "content": "MA_to_NCIt_Mapping-1.0",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MA_to_NCIt_Mapping/version/1.0"
                    },
                    "map": {
                        "content": "MA_to_NCIt_Mapping",
                        "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping"
                    }
                },
                "mapFrom": {
                    "uri": "http://www.w3.org/ns/ma-ont#MA:0000004",
                    "namespace": "MA",
                    "name": "MA:0000004"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entry/MA:MA%253A0000004",
                "resourceName": "MA:MA%253A0000004"
            }
        ],
        "complete": "PARTIAL",
        "numEntries": 3,
        "next": "https://lexevscts2.nci.nih.gov/lexevscts2/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entries?page=1&format=json&maxtoreturn=3",
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entries",
            "parameter": [
                {
                    "arg": "maxtoreturn",
                    "val": "3"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T17:28:42.923-04:00"
        }
    }

}

...

Returns a range of Maps for a text match on the resourceSynopsis.

Code Block
http://<base url>/mapversions?matchvalue=ncit&filtercomponent=resourceSynopsis&format=json

...

Map to or from an entity or use MAP_FROM_BOTH.

Code Block
http://<base url>/mapversions?entity=22298006&entitiesmaprole=MAP_FROM_ROLE&format=json

...

Output

Code Block
collapsetrue
{

    "ResolvedValueSetDirectory": {
        "entry": [
            {
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC Questionnaire Terminology/definition/aa5e7b3f/resolution/1",
                "resolvedValueSetURI": "http://evs.nci.nih.gov/valueset/C100110",
                "resolvedHeader": {
                    "resolutionOf": {
                        "valueSetDefinition": {
                            "content": "aa5e7b3f",
                            "uri": "http://evs.nci.nih.gov/valueset/C100110",
                            "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC Questionnaire Terminology/definition/aa5e7b3f"
                        },
                        "valueSet": {
                            "content": "CDISC Questionnaire Terminology"
                        }
                    },
                    "resolvedUsingCodeSystem": [
                        {
                            "version": {
                                "content": "NCI_Thesaurus-17.06d"
                            },
                            "codeSystem": {
                                "content": "NCI_Thesaurus",
                                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                            }
                        }
                    ]
                }
            },
            {
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC Questionnaire Category Terminology/definition/f8af9058/resolution/1",
                "resolvedValueSetURI": "http://evs.nci.nih.gov/valueset/C100129",
                "resolvedHeader": {
                    "resolutionOf": {
                        "valueSetDefinition": {
                            "content": "f8af9058",
                            "uri": "http://evs.nci.nih.gov/valueset/C100129",
                            "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC Questionnaire Category Terminology/definition/f8af9058"
                        },
                        "valueSet": {
                            "content": "CDISC Questionnaire Category Terminology"
                        }
                    },
                    "resolvedUsingCodeSystem": [
                        {
                            "version": {
                                "content": "NCI_Thesaurus-17.06d"
                            },
                            "codeSystem": {
                                "content": "NCI_Thesaurus",
                                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                            }
                        }
                    ]
                }
            },
            {
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC SDTM Relationship to Subject Terminology/definition/986819bd/resolution/1",
                "resolvedValueSetURI": "http://evs.nci.nih.gov/valueset/C100130",
                "resolvedHeader": {
                    "resolutionOf": {
                        "valueSetDefinition": {
                            "content": "986819bd",
                            "uri": "http://evs.nci.nih.gov/valueset/C100130",
                            "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC SDTM Relationship to Subject Terminology/definition/986819bd"
                        },
                        "valueSet": {
                            "content": "CDISC SDTM Relationship to Subject Terminology"
                        }
                    },
                    "resolvedUsingCodeSystem": [
                        {
                            "version": {
                                "content": "NCI_Thesaurus-17.06d"
                            },
                            "codeSystem": {
                                "content": "NCI_Thesaurus",
                                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                            }
                        }
                    ]
                }
            }
        ],
        "complete": "PARTIAL",
        "numEntries": 3,
        "next": "https://lexevscts2.nci.nih.gov/lexevscts2/resolvedvaluesets?page=1&format=json&maxtoreturn=3",
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "resolvedvaluesets",
            "parameter": [
                {
                    "arg": "maxtoreturn",
                    "val": "3"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-07T11:32:07.923-04:00"
        }
    }

} 

...

Returns the entries from terminology values in this value set.

Code Block
http://<base url>/valueset/CDISC ADaM Date Imputation Flag Terminology/definition/2856f3ed/resolution/1?format=json

Output

Code Block
collapsetrue
{

    "IteratableResolvedValueSet": {
        "resolutionInfo": {
            "resolutionOf": {
                "valueSetDefinition": {
                    "content": "2856f3ed",
                    "uri": "http://evs.nci.nih.gov/valueset/C81223",
                    "href": "https://lexevscts2.nci.nih.gov/lexevscts2/valueset/CDISC ADaM Date Imputation Flag Terminology/definition/2856f3ed"
                },
                "valueSet": {
                    "content": "CDISC ADaM Date Imputation Flag Terminology"
                }
            },
            "resolvedUsingCodeSystem": [
                {
                    "version": {
                        "content": "NCI_Thesaurus-17.06d"
                    },
                    "codeSystem": {
                        "content": "NCI_Thesaurus",
                        "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
                    }
                }
            ]
        },
        "entry": [
            {
                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C81210",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/NCI_Thesaurus:C81210",
                "namespace": "NCI_Thesaurus",
                "name": "C81210",
                "designation": "Year Month Day Imputed"
            },
            {
                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C81211",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/NCI_Thesaurus:C81211",
                "namespace": "NCI_Thesaurus",
                "name": "C81211",
                "designation": "Month Day Imputed"
            },
            {
                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C81212",
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entity/NCI_Thesaurus:C81212",
                "namespace": "NCI_Thesaurus",
                "name": "C81212",
                "designation": "Day Imputed"
            }
        ],
        "complete": "COMPLETE",
        "numEntries": 3,
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "valueset/CDISC ADaM Date Imputation Flag Terminology/definition/2856f3ed/resolution/1",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-07T11:38:21.389-04:00"
        }
    }

}

CTS2 Bulk Term Download Extension

LexEVS 6.1 features a bulk download REST interface that is an extension to the LexEVS CTS2 service. It provides users with the ability to download entire term sets from a given coding scheme or map to a text file

Code Systems Bulk Download

Example

Map Bulk Download

Example

Parameters for Rest Call

URL:

  • /lexevscts2/exporter/codingscheme or
  • /lexevscts2/exporter/map

Parameters:

codingschemes or map - (Optional) CodingSchemes or map to include (comma-separated). Default: all

fields - (Optional) Content fields to output. Default: [code, namespace, description, codingschemename, codingschemeuri, codingschemeversion]

separator -(Optional) One character field separator. Default: |

filename - (Optional) Output file name. Default: terminology-bulk-download.txt

Scrollbar
iconsfalse