NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 32

changes.mady.by.user Bauer, Scott (NIH/NCI) [C]

Saved on

compared with

New Version 33

changes.mady.by.user Bauer, Scott (NIH/NCI) [C]

Saved on

Key

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

...

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.

CTS2 design document

Code System

Getting All CodeSystemCatalogVersions Summaries

...

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

Other Code System Queries

  • by ResourceName
     
  • http://<Rest Service base URL>/codesystemversions?matchvalue=LOINC&filtercomponent=resourceName
  • ResoruceName text match starts with
  • http://<Rest Service base URL>/codesystemversions?matchvalue=LO&filtercomponent=resourceName&matchalgorithm=startsWith
  • ResourceName text match contains
  • http://<Rest Service base URL>/codesystemversions?matchvalue=OmE&filtercomponent=resourceName&matchalgorithm=contains
  • ResourceName text is exact match
  • http://<Rest Service base URL>/codesystemversions?matchvalue=LOINC-232&filtercomponent=resourceName&matchalgorithm=exactMatch
  • about value text match contains
  • http://<Rest Service base URL>/codesystemversions?matchvalue=owl&filtercomponent=about&matchalgorithm=contains
  • Only active versions of this code system
  • http://<Rest Service base URL>/codesystemversions?active=ACTIVE_ONLY

CodeSystemVersion Read

Returns a specific code system version id

Code Block
http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e

...

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

Other Code System Read Queries

  • by URI
    http://<Rest Service base URL>/codesystemversionbyuri?uri=urn:oid:2.16.840.1.113883.6.1/232
  • by Name)
    http://<Rest Service base URL>/codesystem/LOINC/version/LOINC-232

Entities

 

Getting All Code System Entities Summaries

...

Code Block
collapsetrue
<IteratableResolvedValueSet xmlns="http://schema.omg.org/spec/CTS2/1.0/ValueSetDefinition" 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/ValueSetDefinition http://www.omg.org/spec/cts2/201206/valuesetdefinition/ValueSetDefinition.xsd" complete="PARTIAL" numEntries="50" next="http://bmidev4:5555/cts2/valueset/NICHD Newborn Screening Terminology/definition/4125c982/resolution/1?page=1&maxtoreturn=50">
<core:heading>
<core:resourceRoot>
valueset/NICHD Newborn Screening Terminology/definition/4125c982/resolution/1
</core:resourceRoot>


<core:resourceURI>
http://bmidev4:5555/cts2/valueset/NICHD Newborn Screening Terminology/definition/4125c982/resolution/1
</core:resourceURI>


<core:accessDate>2013-09-13T16:54:52.357-05:00</core:accessDate>

</core:heading>


<resolutionInfo>
<resolutionOf>
<core:valueSetDefinition uri="http://ncit:C89506" href="http://bmidev4:5555/cts2/valueset/NICHD Newborn Screening Terminology/definition/4125c982">4125c982</core:valueSetDefinition>
<core:valueSet>NICHD Newborn Screening Terminology</core:valueSet>

</resolutionOf>



</resolutionInfo>


<entry uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C16847" href="http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entity/NCI_Thesaurus:C16847">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C16847</core:name>
<core:designation>Technique</core:designation>

</entry>


<entry uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C34816" href="http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entity/NCI_Thesaurus:C34816">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C34816</core:name>
<core:designation>Congenital Metabolic Disorder</core:designation>

</entry>


<entry uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C81178" href="http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entity/NCI_Thesaurus:C81178">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C81178</core:name>
<core:designation>Newborn Screening</core:designation>

</entry>


<entry uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C50644" href="http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entity/NCI_Thesaurus:C50644">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C50644</core:name>
<core:designation>Lung Overinflation</core:designation>

</entry>


<entry uri="http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#C13235" href="http://bmidev4:5555/cts2/codesystem/NCI_Thesaurus/version/10.07e/entity/NCI_Thesaurus:C13235">
<core:namespace>NCI_Thesaurus</core:namespace>
<core:name>C13235</core:name>
<core:designation>Fetus</core:designation>

</entry>