NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 114

changes.mady.by.user Unknown User (endlecm)

Saved on

compared with

New Version 115

changes.mady.by.user Unknown User (endlecm)

Saved on

Key

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

...

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

Output

Code Block
collapsetrue
<CodeSystemVersionCatalogEntryDirectory xmlns="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion" xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion http://www.omg.org/spec/cts2/201206/codesystemversion/CodeSystemVersion.xsd" complete="COMPLETE" numEntries="25">
<core:heading>
<core:resourceRoot>codesystemversions</core:resourceRoot>
<core:resourceURI>http://<base url>/codesystemversions</core:resourceURI>
<core:accessDate>2013-09-13T15:03:13.627-05:00</core:accessDate>

</core:heading>


<entry href="http://<base url>/codesystem/chebi/version/January2012" about="urn:lsid:bioontology.org:ChEBI:January2012" formalName="ChEBI"documentURI="urn:lsid:bioontology.org:ChEBI:January2012" codeSystemVersionName="chebi-January2012">
<core:resourceSynopsis>
<core:value>Chemical Entities of Biological Interest</core:value>

</core:resourceSynopsis>


<core:officialResourceVersionId>January2012</core:officialResourceVersionId>
<versionOf uri="urn:lsid:bioontology.org:ChEBI">chebi</versionOf>

</entry>


<entry href="http://<base url>/codesystem/pizza.owl/version/version 1.2" about="http://www.co-ode.org/ontologies/pizza/2005/05/16/pizza.owl/version 1.2"formalName="pizza.owl" documentURI="http://www.co-ode.org/ontologies/pizza/2005/05/16/pizza.owl/version 1.2" codeSystemVersionName="pizza.owl-version 1.2">
<core:resourceSynopsis>
<core:value>pizza.owl</core:value>

</core:resourceSynopsis>


<core:officialResourceVersionId>version 1.2</core:officialResourceVersionId>
<versionOf uri="http://www.co-ode.org/ontologies/pizza/2005/05/16/pizza.owl">pizza.owl</versionOf>

</entry>


<entry href="http://<base url>/codesystem/HL7V3.0/version/2006_05" about="1.3.6.1.4.1.2114.108.1.9.137/2006_05" formalName="HL7 Vocabulary Version 3.0, 2006_05"documentURI="1.3.6.1.4.1.2114.108.1.9.137/2006_05" codeSystemVersionName="HL7V3.0-2006_05">
<core:resourceSynopsis>
<core:value>
Health Level Seven Vocabulary (HL7). Ann Arbor (MI): Health Level Seven, 1998-2006. Contact: Mark McDougall, Executive Director, Health Level Seven; 3300 Washtenaw Avenue, Suite 227, Ann Arbor, MI 48104-4250; Phone: (734)677-7777; Fax: (734)677-6622; Email: HQ@HL7.ORG ; Web site: www.HL7.ORG.
</core:value>



</core:resourceSynopsis>


<core:officialResourceVersionId>2006_05</core:officialResourceVersionId>
<versionOf uri="1.3.6.1.4.1.2114.108.1.9.137">HL7V3.0</versionOf>

</entry>


<entry href="http://<base url>/codesystem/WHO/version/1997" about="urn:oid:2.16.840.1.113883.6.230:1997" formalName="WHO Adverse Reaction Terminology, 1997"documentURI="urn:oid:2.16.840.1.113883.6.230:1997" codeSystemVersionName="WHO-1997">
<core:resourceSynopsis>
<core:value>
WHO Adverse Drug Reaction Terminology (WHOART). Uppsala (Sweden): WHO Collaborating Centre for International Drug Monitoring, 1997.
</core:value>



</core:resourceSynopsis>


<core:officialResourceVersionId>1997</core:officialResourceVersionId>
<versionOf uri={

    "CodeSystemVersionCatalogEntryDirectory": {
        "entry": [
            {
                "codeSystemVersionName": "MDR-13.0",
                "versionOf": {
                    "content": "MDR",
                    "uri": "urn:oid:2.16.840.1.113883.6.163"
                },
                "documentURI": "urn:oid:2.16.840.1.113883.6.163:13.0",
                "officialResourceVersionId": "13.0",
                "about": "urn:oid:2.16.840.1.113883.6.163:13.0",
                "formalName": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)",
                "resourceSynopsis": {
                    "value": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MDR/version/13.0"
            },
            {
                "codeSystemVersionName": "MDR-13.1",
                "versionOf": {
                    "content": "MDR",
                    "uri": "urn:oid:2.16.840.1.113883.6.230">WHO</versionOf>

</entry>

CodeSystemVersions Query

Returns a set of CodeSystemVersions based on a text match

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

Output

Code Block
collapsetrue
<CodeSystemVersionCatalogEntryDirectory xmlns="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion" xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion http://www.omg.org/spec/cts2/201206/codesystemversion/CodeSystemVersion.xsd" complete="COMPLETE" numEntries="3">
<core:heading>
<core:resourceRoot>codesystemversions</core:resourceRoot>
<core:resourceURI>http://<base url>/codesystemversions</core:resourceURI>
<core:parameter arg="filtercomponent">
<core:val>resourceName</core:val>

</core:parameter>


<core:parameter arg="matchvalue">
<core:val>nci_thesaurus</core:val>

</core:parameter>


<core:accessDate>2013-09-13T14:38:02.284-05:00</core:accessDate>

</core:heading>


<entry href="http://<base url>/codesystem/NCI_Thesaurus/version/10.07e" about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.07e" formalName="NCI Thesaurus"documentURI="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.07e" codeSystemVersionName="NCI_Thesaurus-10.07e">
<core:resourceSynopsis>
<core:value>NCI Thesaurus</core:value>

</core:resourceSynopsis>


<core:officialResourceVersionId>10.07e</core:officialResourceVersionId>
<versionOf uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</versionOf>

</entry>


<entry href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a" about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.10a" formalName="NCI Thesaurus"documentURI="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.10a" codeSystemVersionName="NCI_Thesaurus-10.10a">
<core:resourceSynopsis>
<core:value>NCI Thesaurus</core:value>

</core:resourceSynopsis>


<core:officialResourceVersionId>10.10a</core:officialResourceVersionId>
<versionOf uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</versionOf>

</entry>


<entry href="http://<base url>/codesystem/NCI_Thesaurus/version/11.09d" about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#11.09d" formalName="Thesaurus.owl"documentURI="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#11.09d" codeSystemVersionName="NCI_Thesaurus-11.09d">
<core:resourceSynopsis>
<core:value>Thesaurus.owl</core:value>

</core:resourceSynopsis>


<core:officialResourceVersionId>11.09d</core:officialResourceVersionId>
<versionOf uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</versionOf>

</entry>



</CodeSystemVersionCatalogEntryDirectory>

Other Code System Queries

  • by ResourceName
    • http:// <Rest Service base URL> /codesystemversions?matchvalue=HL7&filtercomponent=resourceName&format=json
  • ResoruceName text match starts with
    • http://<Rest Service base URL>/codesystemversions?matchvalue=HL&filtercomponent=resourceName&matchalgorithm=startsWith&format=json
  • ResourceName text match contains
    • http://<Rest Service base URL>/codesystemversions?matchvalue=OmE&filtercomponent=resourceName&matchalgorithm=contains&format=json
  • ResourceName text is exact match
    • http://<Rest Service base URL>/codesystemversions?matchvalue=HL7-V3 R2.36&filtercomponent=resourceName&format=json
  • About value text match contains
    • http://<Rest Service base URL>/codesystemversions?matchvalue=owl&filtercomponent=about&matchalgorithm=contains&format=json
  • Only active versions of this code system
    • http://<Rest Service base URL>/codesystemversions?active=ACTIVE_ONLY&format=json

CodeSystemVersion Read

Returns a specific code system version id

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/10.07e

Output

Code Block
collapsetrue
<CodeSystemVersionCatalogEntryMsg xmlns="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion" xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/CodeSystemVersion http://www.omg.org/spec/cts2/201206/codesystemversion/CodeSystemVersion.xsd">
<core:heading>
<core:resourceRoot>codesystem/NCI_Thesaurus/version/10.07e</core:resourceRoot>
<core:resourceURI>
http://<base url>/codesystem/NCI_Thesaurus/version/10.07e
</core:resourceURI>


<core:accessDate>2013-09-13T15:22:32.721-05:00</core:accessDate>

</core:heading>


<codeSystemVersionCatalogEntry entryState="ACTIVE" about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.07e" formalName="NCI Thesaurus"documentURI="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#10.07e" state="FINAL" codeSystemVersionName="NCI_Thesaurus-10.07e">
<core:keyword>ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl</core:keyword>
<core:keyword>Thesaurus.owl</core:keyword>
<core:keyword>NCI Thesaurus</core:keyword>
<core:keyword>NCI_Thesaurus</core:keyword>
<core:keyword>NCI</core:keyword>
<core:resourceSynopsis>
<core:value>NCI Thesaurus</core:value>

</core:resourceSynopsis>


<core:sourceAndNotation>
<core:sourceAndNotationDescription>LexEVS</core:sourceAndNotationDescription>

</core:sourceAndNotation>


<core:officialResourceVersionId>10.07e</core:officialResourceVersionId>
<versionOf uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</versionOf>
<entityDescriptions>
http://<base url>/codesystem/NCI_Thesaurus/version/10.07e/entities
</entityDescriptions>



</codeSystemVersionCatalogEntry>



</CodeSystemVersionCatalogEntryMsg>

Other Code System Read by Statements

...

163"
                },
                "documentURI": "urn:oid:2.16.840.1.113883.6.163:13.1",
                "officialResourceVersionId": "13.1",
                "about": "urn:oid:2.16.840.1.113883.6.163:13.1",
                "formalName": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)",
                "resourceSynopsis": {
                    "value": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MDR/version/13.1"
            },
            {
                "codeSystemVersionName": "MDR-15.0",
                "versionOf": {
                    "content": "MDR",
                    "uri": "urn:oid:2.16.840.1.113883.6.163"
                },
                "documentURI": "urn:oid:2.16.840.1.113883.6.163:15.0",
                "officialResourceVersionId": "15.0",
                "about": "urn:oid:2.16.840.1.113883.6.163:15.0",
                "formalName": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)",
                "resourceSynopsis": {
                    "value": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MDR/version/15.0"
            },
            {
                "codeSystemVersionName": "MDR-14.1",
                "versionOf": {
                    "content": "MDR",
                    "uri": "urn:oid:2.16.840.1.113883.6.163"
                },
                "documentURI": "urn:oid:2.16.840.1.113883.6.163:14.1",
                "officialResourceVersionId": "14.1",
                "about": "urn:oid:2.16.840.1.113883.6.163:14.1",
                "formalName": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)",
                "resourceSynopsis": {
                    "value": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MDR/version/14.1"
            },
            {
                "codeSystemVersionName": "MDR-15.1",
                "versionOf": {
                    "content": "MDR",
                    "uri": "urn:oid:2.16.840.1.113883.6.163"
                },
                "documentURI": "urn:oid:2.16.840.1.113883.6

...

.163:15.1",
                "officialResourceVersionId": "15.1",
                "about": "urn:oid:2.16.840.1.113883.6.163:15.1",
                "formalName": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)",
                "resourceSynopsis": {
                    "value": "MedDRA (Medical Dictionary for Regulatory Activities Terminology)"
                },
                "href": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/MDR/version/15.1"
            }
        ],
        "complete": "PARTIAL",
        "numEntries": 5,
        "next": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystemversions?page=1&format=json&maxtoreturn=5",
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystemversions",
            "parameter": [
                {
                    "arg": "maxtoreturn",
                    "val": "5"
                },
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T16:20:07.172-04:00"
        }
    }

}

CodeSystemVersions Query

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"
        }
    }

}

Other Code System Queries

  • by ResourceName
    • http:// <Rest Service base URL> /codesystemversions?matchvalue=HL7&filtercomponent=resourceName&format=json
  • ResoruceName text match starts with
    • http://<Rest Service base URL>/codesystemversions?matchvalue=HL&filtercomponent=resourceName&matchalgorithm=startsWith&format=json
  • ResourceName text match contains
    • http://<Rest Service base URL>/codesystemversions?matchvalue=OmE&filtercomponent=resourceName&matchalgorithm=contains&format=json
  • ResourceName text is exact match
    • http://<Rest Service base URL>/codesystemversions?matchvalue=HL7-V3 R2.36&filtercomponent=resourceName&format=json
  • About value text match contains
    • http://<Rest Service base URL>/codesystemversions?matchvalue=owl&filtercomponent=about&matchalgorithm=contains&format=json
  • Only active versions of this code system
    • http://<Rest Service base URL>/codesystemversions?active=ACTIVE_ONLY&format=json

CodeSystemVersion Read

Returns a specific code system version id

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

Output

Code Block
collapsetrue
{
    "CodeSystemVersionCatalogEntryMsg": {
        "codeSystemVersionCatalogEntry": {
            "codeSystemVersionName": "NCI_Thesaurus-17.06d",
            "versionOf": {
                "content": "NCI_Thesaurus",
                "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
            },
            "entityDescriptions": "https://lexevscts2.nci.nih.gov/lexevscts2/codesystem/NCI_Thesaurus/version/17.06d/entities",
            "documentURI": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.06d",
            "state": "FINAL",
            "sourceAndNotation": {
                "sourceAndNotationDescription": "LexEVS"
            },
            "officialResourceVersionId": "17.06d",
            "about": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#17.06d",
            "formalName": "NCI Thesaurus",
            "keyword": [
                "ncicb.nci.nih.gov/xml/owl/EVS/NCI_Thesaurus.owl",
                "NCI_Thesaurus.owl",
                "NCI_Thesaurus",
                "NCI Thesaurus",
                "NCI",
                "urn:oid:2.16.840.1.113883.3.26.1.1"
            ],
            "resourceSynopsis": {
                "value": "NCI Thesaurus"
            },
            "property": [
                {
                    "predicate": {
                        "uri": "ontologyFormat",
                        "name": "ontologyFormat"
                    },
                    "value": [
                        {
                            "literal": {
                                "value": "OWL"
                            }
                        }
                    ]
                }
            ],
            "entryState": "ACTIVE"
        },
        "heading": {
            "resourceRoot": "https://lexevscts2.nci.nih.gov/lexevscts2/",
            "resourceURI": "codesystem/NCI_Thesaurus/version/17.06d",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T16:25:00.529-04:00"
        }
    }

}

Other Code System Read by Statements

  • by URI
    http://<Rest Service base URL>/codesystemversionbyuri?uri=urn:oid:2.16.840.1.113883.6.163:17.1&format=json
  • by Name)
    http://<Rest Service base URL>/codesystem/MDR/version/17.1?format=json

Entities

Getting All Code System Entities Summaries

Returns all entities 50 at a time. (Page number and next attributes control place and iteration through the entire set of entities)

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?maxtoreturn=2&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"
        }
    }

}

Entity Read

Read the exact entity designated by this entity name attribute.

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

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":

...

  • by Name)
    http://<Rest Service base URL>/codesystem/LOINC/version/LOINC-232

Entities

Getting All Code System Entities Summaries

Returns all entities 50 at a time. (Page number and next attributes control place and iteration through the entire set of entities)

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entities

Output

Code Block
collapsetrue
<EntityDirectory xmlns="http://schema.omg.org/spec/CTS2/1.0/Entity" xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/Entity http://www.omg.org/spec/cts2/201206/entity/Entity.xsd" complete="PARTIAL" numEntries="50"next="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entities?page=1&maxtoreturn=50">
<core:heading>
<core:resourceRoot>codesystem/NCI_Thesaurus/version/10.10a/entities</core:resourceRoot>
<core:resourceURI>
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entities
</core:resourceURI>


<core:accessDate>2013-09-13T15:33:42.494-05:00</core:accessDate>

</core:heading>


<entry about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C33945owl#Semantic_Type">
<core:name>
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C33945</core:name>

</core:name>


<core:knownEntityDescription href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C33945">
<core:describingCodeSystemVersion>
<core:version href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a">NCI_Thesaurus-10.10a</core:version>
<core:codeSystem uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</core:codeSystem>

</core:describingCodeSystemVersion>


<core:designation>Protein AF-9</core:designation>

</core:knownEntityDescription>



</entry>


<entry about="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#R138">
<core:name>
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>R138</core:name>

</core:name>


<core:knownEntityDescription href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/R138">
<core:describingCodeSystemVersion>
<core:version href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a">NCI_Thesaurus-10.10a</core:version>
<core:codeSystem uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</core:codeSystem>

</core:describingCodeSystemVersion>



</core:knownEntityDescription>



</entry>


<entry about=,
                            "namespace": "NCI_Thesaurus",
                            "name": "Semantic_Type"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "Sign or Symptom"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C91509owl#UMLS_CUI">
<core:name>
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C91509</core:name>

</core:name>


<core:knownEntityDescription href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C91509">
<core:describingCodeSystemVersion>
<core:version href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a">NCI_Thesaurus-10.10a</core:version>
<core:codeSystem uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</core:codeSystem>

</core:describingCodeSystemVersion>


<core:designation>ABC Transporter Pathway</core:designation>

</core:knownEntityDescription>



</entry>

Entity Read

Read the exact entity designated by this entity name attribute.

Code Block
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C3399

Output

Code Block
collapsetrue
<EntityDescriptionMsg xmlns="http://schema.omg.org/spec/CTS2/1.0/Entity" xmlns:core="http://schema.omg.org/spec/CTS2/1.0/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.omg.org/spec/CTS2/1.0/Entity http://www.omg.org/spec/cts2/201206/entity/Entity.xsd">
<core:heading>
<core:resourceRoot>
codesystem/NCI_Thesaurus/version/10.10a/entity/C3399
</core:resourceRoot>


<core:resourceURI>
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C3399
</core:resourceURI>


<core:accessDate>2013-09-13T15:41:14.480-05:00</core:accessDate>

</core:heading>


<EntityDescription>
<namedEntity about=,
                            "namespace": "NCI_Thesaurus",
                            "name": "UMLS_CUI"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "C0038999"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C3399" entryState="ACTIVE">
<entityID>
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C3399</core:name>

</entityID>


<describingCodeSystemVersion>
<core:version href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a">NCI_Thesaurus-10.10a</core:version>
<core:codeSystem uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#">NCI_Thesaurus</core:codeSystem>

</describingCodeSystemVersion>


<designation designationRole="ALTERNATIVE">
<core:value>SWELLING</core:value>

</designation>


<designation designationRole="ALTERNATIVE">
<core:value>Swelling</core:value>

</designation>


<designation designationRole="ALTERNATIVE">
<core:value>Swelling</core:value>

</designation>


<designation designationRole="PREFERRED">
<core:value>Swelling</core:value>

</designation>


<definition definitionRole="NORMATIVE">
<core:value>
Enlargement; expansion in size; sign of inflammation
</core:value>



</definition>


<property>
<core:predicate uri=owl#code",
                            "namespace": "NCI_Thesaurus",
                            "name": "code"
                        },
                        "value": [
                            {
                                "literal": {
                                    "value": "C3399"
                                }
                            }
                        ]
                    },
                    {
                        "predicate": {
                            "uri": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#Contributing_Sourceowl#label">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>Contributing_Source</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>FDA</core:value>

</core:literal>



</core:value>



</property>


<property>
<core:predicate uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#FDA_Table">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>FDA_Table</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>Patient Code (Appendix B)</core:value>

</core:literal>



</core:value>



</property>


<property>
<core:predicate uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#Legacy_Concept_Name">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>Legacy_Concept_Name</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>Swelling</core:value>

</core:literal>



</core:value>



</property>


<property>
<core:predicate uri=,
                            "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#primitiveowl#C53458">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>primitive</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>true</core:value>

</core:literal>



</core:value>



</property>


<property>
<core:predicate uri="http://ncicb,
                        "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/xml/owl/EVS/Thesaurus.owl#Semantic_Type">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>Semantic_Type</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>Sign or Symptom</core:value>

</core:literal>



</core:value>



</property>


<property>
<core:predicate uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#UMLS_CUI">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>UMLS_CUI</core:name>

</core:predicate>


<core:value>
<core:literal>
<core:value>C0038999</core:value>

</core:literal>



</core:value>



</property>


<subjectOf>
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C3399/subjectof
</subjectOf>


<targetOf>
http://<base url>/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/1017.10a06d/entity/C3399/targetof
</targetOf>


<parent uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C4876" href="http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C4876">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C4876</core:name>

</parent>


<children>
http://<base url>/codesystem/NCI_Thesaurus/version/10.10a/entity/C3399/children
</children>


<entityType uri="http://www.w3.org/2002/07/owl#Class">
<core:namespace>owl</core:namespace>
<core:name>Class</core:name>

</entityType>



</namedEntity>



</EntityDescription>



</EntityDescriptionMsg>",
            "parameter": [
                {
                    "arg": "format",
                    "val": "json"
                }
            ],
            "accessDate": "2017-08-04T16:34:33.085-04:00"
        }
    }

}

Entity Read with Namespace

...