CTS2-LE REST API: Read Entity Descriptions: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
K (→‎Retrieve associations in which a given entity is the target)
K
Zeile 13: Zeile 13:
 
:'''codesystemuri''' the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
 
:'''codesystemuri''' the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
 
:'''filtercomponent'''  the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification. This service supports the following filter components: 'toplevel' returns only the top level entities (entities that have no parents and are ranked first in a hierarchy). At the moment, this is the only filtercomponent value and it has to be present in any call.
 
:'''filtercomponent'''  the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification. This service supports the following filter components: 'toplevel' returns only the top level entities (entities that have no parents and are ranked first in a hierarchy). At the moment, this is the only filtercomponent value and it has to be present in any call.
−
* '''returns: ''' entity:EntityList
+
* '''returns: ''' entity:EntityList; contains only the preferred term of each entity description and no alternative designation, definitions are not included
  
 
===== Example Structure for call /codesystem/_/version/_def/entities?codesystemuri=http://test/vs&filtercomponent=toplevel =====
 
===== Example Structure for call /codesystem/_/version/_def/entities?codesystemuri=http://test/vs&filtercomponent=toplevel =====
Zeile 107: Zeile 107:
 
:'''entityid''' the Scoped Entity Name of the EntityDescription Resource. This service implementation only accepts the name of the requested EntityDescription. There should not be a namespace identifier.
 
:'''entityid''' the Scoped Entity Name of the EntityDescription Resource. This service implementation only accepts the name of the requested EntityDescription. There should not be a namespace identifier.
 
* '''Query Parameters:'''   
 
* '''Query Parameters:'''   
−
:'''page''' the 0-based page number used for paging result sets. Default is 0.
 
−
:'''maxtoreturn''' the maximum number of <i>entries</i> that may be present in a return <i>Directory</i>. If <i>maxToReturn</i> is not supplied, a block size of 100 is used.
 
 
:'''codesystemuri''' the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
 
:'''codesystemuri''' the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
−
* '''returns: ''' entity:EntityDescriptionMsg
+
* '''returns: ''' entity:EntityDescriptionMsg; contains all designations for an entity description and definitions if given
  
−
===== Example Structure for call /codesystem/_/version/_def/entity/11?codesystemuri=http://test/vs =====
+
 
 +
===== Example Structure for call /WebCts2LE/rest/codesystem/_/version/_def/entity/c02?codesystemuri=example:anotherTerminology =====
 
<code xml>
 
<code xml>
 
  <?xml version="1.0" encoding="UTF-8"?>
 
  <?xml version="1.0" encoding="UTF-8"?>
−
  <EntityDescriptionMsg xmlns="http://www.omg.org/spec/CTS2/1.1/Entity" xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" xmlns:xsi="http://www.w3.org /2001/XMLSchema-instance">
+
  <EntityDescriptionMsg xmlns="http://www.omg.org/spec/CTS2/1.1/Entity" xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
     <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
 
     <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
 
         <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
 
         <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
−
         <core:resourceURI>codesystem/_/version/_def/entity/11</core:resourceURI>
+
         <core:resourceURI>codesystem/_/version/_def/entity/c02</core:resourceURI>
 
         <core:parameter arg="Accept">
 
         <core:parameter arg="Accept">
 
             <core:val>*/*</core:val>
 
             <core:val>*/*</core:val>
Zeile 126: Zeile 125:
 
         </core:parameter>
 
         </core:parameter>
 
         <core:parameter arg="codesystemuri">
 
         <core:parameter arg="codesystemuri">
−
             <core:val>http://test/vs</core:val>
+
             <core:val>example:anotherTerminology</core:val>
 
         </core:parameter>
 
         </core:parameter>
−
         <core:accessDate>2016-07-05T14:19:37</core:accessDate>
+
         <core:accessDate>2016-07-06T09:24:23</core:accessDate>
 
     </core:heading>
 
     </core:heading>
 
     <EntityDescription xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
 
     <EntityDescription xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
−
         <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fc8">
+
         <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa0">
 
             <entityID>
 
             <entityID>
 
                 <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
 
                 <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
−
                 <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">11</core:name>
+
                 <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">c02</core:name>
 
             </entityID>
 
             </entityID>
 
             <describingCodeSystemVersion>
 
             <describingCodeSystemVersion>
−
                 <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core:version>
+
                 <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
 
             </describingCodeSystemVersion>
 
             </describingCodeSystemVersion>
 
             <designation designationRole="PREFERRED">
 
             <designation designationRole="PREFERRED">
−
                 <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-1</core:value>
+
                 <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">cPrefTerm</core:value>
 +
                <core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
 
             </designation>
 
             </designation>
 
             <designation designationRole="ALTERNATIVE">
 
             <designation designationRole="ALTERNATIVE">
−
                 <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-1-syn-2</core:value>
+
                 <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">cSynonym_üöä</core:value>
 +
                <core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
 
             </designation>
 
             </designation>
−
             <children>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs</children>
+
             <definition definitionRole="INFORMATIVE">
 +
                <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">def for c</core:value>
 +
            </definition>
 +
            <targetOf>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/_def/entity/c02/targetof?codesystemuri=example:anotherTerminology</targetOf>
 
             <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
 
             <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
 
         </classDescription>
 
         </classDescription>

Version vom 6. Juli 2016, 09:26 Uhr

Root-URL: /WebCts2LE/rest/

Retrieve all top level concepts of a code system version

  • this service is a restricted version of the standard REST call with uri /codesystem/{codesystemid}/version/{codesystemversionid}/entities; it cannot be used to retrieve all entities of a code system version but only the top level concepts
  • Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entities
  • Method: GET
  • Path Parameters:
codesytemid the Name of the Code System - will be ignored
codesystemversionid the Name (version ID) of the Code System Version, set to '_def' to request the default version
  • Query Parameters:
page the 0-based page number used for paging result sets. Default is 0.
maxtoreturn the maximum number of entries that may be present in a return Directory. If maxToReturn is not supplied, a block size of 100 is used.
codesystemuri the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
filtercomponent the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification. This service supports the following filter components: 'toplevel' returns only the top level entities (entities that have no parents and are ranked first in a hierarchy). At the moment, this is the only filtercomponent value and it has to be present in any call.
  • returns: entity:EntityList; contains only the preferred term of each entity description and no alternative designation, definitions are not included
Example Structure for call /codesystem/_/version/_def/entities?codesystemuri=http://test/vs&filtercomponent=toplevel

<?xml version="1.0" encoding="UTF-8"?>
<EntityList xmlns="http://www.omg.org/spec/CTS2/1.1/Entity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" complete="COMPLETE" numEntries="3">
   <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
       <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
       <core:resourceURI>codesystem/_/version/_def/entities</core:resourceURI>
       <core:parameter arg="filtercomponent">
           <core:val>toplevel</core:val>
       </core:parameter>
       <core:parameter arg="Accept">
           <core:val>*/*</core:val>
       </core:parameter>
       <core:parameter arg="Accept-Language">
           <core:val>de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4</core:val>
       </core:parameter>
       <core:parameter arg="page">
           <core:val>0</core:val>
       </core:parameter>
       <core:parameter arg="maxtoreturn">
           <core:val>100</core:val>
       </core:parameter>
       <core:parameter arg="codesystemuri">
           <core:val>http://test/vs</core:val>
       </core:parameter>
       <core:accessDate>2016-07-05T13:05:22</core:accessDate>
   </core:heading>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
       <entry>
           <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fbf">
               <entityID>
                   <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
                   <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">3</core:name>
               </entityID>
               <describingCodeSystemVersion>
                   <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core:version>
               </describingCodeSystemVersion>
               <designation designationRole="PREFERRED">
                   <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">3</core:value>
               </designation>
               <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
           </classDescription>
       </entry>
   </entry>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
       <entry>
           <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fc8">
               <entityID>
                   <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
                   <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">11</core:name>
               </entityID>
               <describingCodeSystemVersion>
                   <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core:version>
               </describingCodeSystemVersion>
               <designation designationRole="PREFERRED">
                   <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-1</core:value>
               </designation>
               <children>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs</children>
               <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
           </classDescription>
       </entry>
   </entry>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
       <entry>
           <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fc1">
               <entityID>
                   <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
                   <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2</core:name>
               </entityID>
               <describingCodeSystemVersion>
                   <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core:version>
               </describingCodeSystemVersion>
               <designation designationRole="PREFERRED">
                   <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-2</core:value>
               </designation>
               <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
           </classDescription>
       </entry>
   </entry>
</EntityList>

Retrieve an entity description from a specified code system version

  • EntityDescriptionReadService:read: retrieve an entity description from a specified code system version
    Please consider the instructions on how to identify a code system version!
  • Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}
  • Method: GET
  • Path Parameters:
codesytemid the Name of the Code System - will be ignored
codesystemversionid the Name (version ID) of the Code System Version, set to '_def' to request the default version
entityid the Scoped Entity Name of the EntityDescription Resource. This service implementation only accepts the name of the requested EntityDescription. There should not be a namespace identifier.
  • Query Parameters:
codesystemuri the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
  • returns: entity:EntityDescriptionMsg; contains all designations for an entity description and definitions if given


Example Structure for call /WebCts2LE/rest/codesystem/_/version/_def/entity/c02?codesystemuri=example:anotherTerminology

<?xml version="1.0" encoding="UTF-8"?>
<EntityDescriptionMsg xmlns="http://www.omg.org/spec/CTS2/1.1/Entity" xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
       <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
       <core:resourceURI>codesystem/_/version/_def/entity/c02</core:resourceURI>
       <core:parameter arg="Accept">
           <core:val>*/*</core:val>
       </core:parameter>
       <core:parameter arg="Accept-Language">
           <core:val>de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4</core:val>
       </core:parameter>
       <core:parameter arg="codesystemuri">
           <core:val>example:anotherTerminology</core:val>
       </core:parameter>
       <core:accessDate>2016-07-06T09:24:23</core:accessDate>
   </core:heading>
   <EntityDescription xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
       <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa0">
           <entityID>
               <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
               <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">c02</core:name>
           </entityID>
           <describingCodeSystemVersion>
               <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
           </describingCodeSystemVersion>
           <designation designationRole="PREFERRED">
               <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">cPrefTerm</core:value>
               <core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
           </designation>
           <designation designationRole="ALTERNATIVE">
               <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">cSynonym_üöä</core:value>
               <core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
           </designation>
           <definition definitionRole="INFORMATIVE">
               <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">def for c</core:value>
           </definition>
           <targetOf>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/_def/entity/c02/targetof?codesystemuri=example:anotherTerminology</targetOf>
           <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
       </classDescription>
   </EntityDescription>
</EntityDescriptionMsg>

Retrieve a list of child entities

  • Resolve a list of child entities. EntityDescriptionQueryService:resolve: Return an EntityDirectory that contains the set of EntityReferences identified by directory.
    Please consider the instructions on how to identify a code system version!
  • Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/children
  • Method: GET
  • Path Parameters:
codesytemid the Name of the Code System - will be ignored
codesystemversionid the Name (version ID) of the Code System Version, set to '_def' to request the default version
entityid the Scoped Entity Name of the EntityDescription Resource. This service implementation only accepts the name of the requested EntityDescription. There should not be a namespace identifier.
  • Query Parameters:
page the 0-based page number used for paging result sets. Default is 0.
maxtoreturn the maximum number of entries that may be present in a return Directory. If maxToReturn is not supplied, a block size of 100 is used.
codesystemuri the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
  • returns: entity:EntityList


Example Structure for call /codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs

<?xml version="1.0" encoding="UTF-8"?>
<EntityList xmlns="http://www.omg.org/spec/CTS2/1.1/Entity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" complete="COMPLETE" numEntries="1">
   <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
       <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
       <core:resourceURI>codesystem/_/version/_def/entity/11/children</core:resourceURI>
       <core:parameter arg="Accept">
           <core:val>*/*</core:val>
       </core:parameter>
       <core:parameter arg="Accept-Language">
           <core:val>de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4</core:val>
       </core:parameter>
       <core:parameter arg="page">
           <core:val>0</core:val>
       </core:parameter>
       <core:parameter arg="maxtoreturn">
           <core:val>100</core:val>
       </core:parameter>
       <core:parameter arg="codesystemuri">
           <core:val>http://test/vs</core:val>
       </core:parameter>
       <core:accessDate>2016-07-05T14:24:46</core:accessDate>
   </core:heading>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
       <entry>
           <classDescription about="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fc5">
               <entityID>
                   <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
                   <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.1</core:name>
               </entityID>
               <describingCodeSystemVersion>
                   <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core:version>
               </describingCodeSystemVersion>
               <designation designationRole="PREFERRED">
                   <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-11-b</core:value>
               </designation>
               <definition definitionRole="NORMATIVE">
                   <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">def1.1.b</core:value>
               </definition>
               <parent href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/_def/entity/11?codesystemuri=http://test/vs" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fc8">
                   <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">11</core:name>
                   <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-1</core:designation>
               </parent>
               <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
           </classDescription>
       </entry>
   </entry>
</EntityList>

Retrieve associations in which a given entity is the subject

  • AssociationQueryService:resolve: Return a directory that summarizes the resolution of the supplied association directory URI.
  • Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/subjectof
  • Method: GET
  • Path Parameters:
codesytemid the Name of the Code System - will be ignored
codesystemversionid the Name (version ID) of the Code System Version, set to '_def' to request the default version
  • Query Parameters:
page the 0-based page number used for paging result sets. Default is 0.
maxtoreturn the maximum number of entries that may be present in a return Directory. If maxToReturn is not supplied, a block size of 100 is used.
codesystemuri the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
  • returns: association:AssociationList
Example Structure for call /codesystem/_/version/_def/entity/a02/subjectof?codesystemuri=example:anotherTerminology

<?xml version="1.0" encoding="UTF-8"?>
<AssociationList xmlns="http://www.omg.org/spec/CTS2/1.1/Association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" complete="COMPLETE" numEntries="2">
   <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
       <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
       <core:resourceURI>codesystem/_/version/_def/entity/a02/subjectof</core:resourceURI>
       <core:parameter arg="Accept">
           <core:val>*/*</core:val>
       </core:parameter>
       <core:parameter arg="Accept-Language">
           <core:val>de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4</core:val>
       </core:parameter>
       <core:parameter arg="page">
           <core:val>0</core:val>
       </core:parameter>
       <core:parameter arg="maxtoreturn">
           <core:val>100</core:val>
       </core:parameter>
       <core:parameter arg="codesystemuri">
           <core:val>example:anotherTerminology</core:val>
       </core:parameter>
       <core:accessDate>2016-07-05T14:32:05</core:accessDate>
   </core:heading>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
       <subject uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa8" />
       <predicate uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7f9c">
           <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">seeAlso</core:designation>
       </predicate>
       <target>
           <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="WebCts2LE/rest/codesystem/_/version/1.0/entity/b02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa4">
               <core:name>b02</core:name>
               <core:designation>bPrefTerm</core:designation>
           </core:entity>
       </target>
       <assertedBy>
           <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
       </assertedBy>
   </entry>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
       <subject uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa8" />
       <predicate uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7f9c">
           <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">seeAlso</core:designation>
       </predicate>
       <target>
           <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="WebCts2LE/rest/codesystem/_/version/1.0/entity/c02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa0">
               <core:name>c02</core:name>
               <core:designation>cPrefTerm</core:designation>
           </core:entity>
       </target>
       <assertedBy>
           <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
       </assertedBy>
   </entry>
</AssociationList>

Retrieve associations in which a given entity is the target

  • A Directory of Associations that are the 'targetof' the given entity. 'targetof' means that the given entity must participate as the 'target' or 'object' of the association. This URL Path represents: a DirectoryURI that references a set of Associations. AssociationQueryService:resolve: Return a directory that summarizes the resolution of the supplied association directory URI.
  • Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/targetof
  • Method: GET
  • Path Parameters:
codesytemid the Name of the Code System - will be ignored
codesystemversionid the Name (version ID) of the Code System Version, set to '_def' to request the default version
  • Query Parameters:
page the 0-based page number used for paging result sets. Default is 0.
maxtoreturn the maximum number of entries that may be present in a return Directory. If maxToReturn is not supplied, a block size of 100 is used.
codesystemuri the URI that references a code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary
  • returns: association:AssociationList
Example Structure for call /codesystem/_/version/_def/entity/b02/targetof?codesystemuri=example:anotherTerminology

<?xml version="1.0" encoding="UTF-8"?>
<AssociationList xmlns="http://www.omg.org/spec/CTS2/1.1/Association" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" complete="COMPLETE" numEntries="1">
   <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
       <core:resourceRoot>http://localhost:8080/WebCts2LE/rest/</core:resourceRoot>
       <core:resourceURI>codesystem/_/version/_def/entity/b02/targetof</core:resourceURI>
       <core:parameter arg="Accept">
           <core:val>*/*</core:val>
       </core:parameter>
       <core:parameter arg="Accept-Language">
           <core:val>de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4</core:val>
       </core:parameter>
       <core:parameter arg="page">
           <core:val>0</core:val>
       </core:parameter>
       <core:parameter arg="maxtoreturn">
           <core:val>100</core:val>
       </core:parameter>
       <core:parameter arg="codesystemuri">
           <core:val>example:anotherTerminology</core:val>
       </core:parameter>
       <core:accessDate>2016-07-05T14:34:59</core:accessDate>
   </core:heading>
   <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
       <subject href="WebCts2LE/rest/codesystem/_/version/1.0/entity/a02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa8">
           <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">a02</core:name>
           <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">aPrefTerm</core:designation>
       </subject>
       <predicate uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7f9c">
           <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">seeAlso</core:designation>
       </predicate>
       <target>
           <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa4" />
       </target>
       <assertedBy>
           <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
       </assertedBy>
   </entry>
</AssociationList>

Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=CTS2-LE_REST_API:_Read_Entity_Descriptions&oldid=432“