The Current State of CTS2
(Compared to the LexEVS API based on the Draft Standard for Trial Use)
The CTS2 REST API in LexEVS 6.1
The OMG CTS2 1.1 Specification is written as a REST based architecture. It can be implemented as a minimal set of modules as a result.
CodeSystemCatalogVersions Read
Returns a set of CodeSystemVersions
http://bmidev4:5555/cts2/codesystemversions
Output
Expand source
<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://bmidev4:5555/cts2/codesystemversions</core:resourceURI> <core:accessDate>2013-09-13T15:03:13.627-05:00</core:accessDate> </core:heading> <entry href="http://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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="urn:oid:2.16.840.1.113883.6.230">WHO</versionOf> </entry>
CodeSystemVersions Query
Returns a set of CodeSystemVersions based on a text match
http://bmidev4:5555/cts2/codesystemversions?matchvalue=nci_thesaurus&filtercomponent=resourceName
Output
Expand source
<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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/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>
CodeSystemVersion Read
Returns a specific code system version
http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e
Output
Expand source
<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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entities </entityDescriptions> </codeSystemVersionCatalogEntry> </CodeSystemVersionCatalogEntryMsg>
Enitity Read
Entity Query
http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.10a/entities?matchvalue=swelling
Output
Expand source
<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://bmidev4:5555/cts2/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://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entities </entityDescriptions> </codeSystemVersionCatalogEntry> </CodeSystemVersionCatalogEntryMsg>
Association Read
Association Query
Map Read
Map Query
ResolvedValueSet Read
ResolvedValueSet Query
ResolvedValueSetDefinition Read
ResolvedValueSetDefinition Query