CTS2-LE REST API: Read Entity Descriptions - Versionsgeschichte

Krebs am 5. April 2018 um 08:44 Uhr

2018-04-05T08:44:27Z

Krebs: /* Retrieve all top level concepts of a code system version */

2017-12-19T08:58:08Z

‎Retrieve all top level concepts of a code system version

Krebs: /* Get the entity with uri */

2017-06-15T07:56:44Z

‎Get the entity with uri

Krebs am 15. Juni 2017 um 07:55 Uhr

2017-06-15T07:55:51Z

Krebs: /* [non-public] Get associations in which the LOINC concept with code 1 appears as target */

2017-06-15T07:41:08Z

‎[non-public] Get associations in which the LOINC concept with code 1 appears as target

Krebs: /* [non-public] Get associations in which the LOINC concept with code 1 appears as target */

2017-06-15T07:40:47Z

‎[non-public] Get associations in which the LOINC concept with code 1 appears as target

Krebs: /* [non-public] Get associations in which the LOINC concept with code 1 appears as target */

2017-06-15T07:40:33Z

‎[non-public] Get associations in which the LOINC concept with code 1 appears as target

Änderungen zeigen

Krebs: /* Get associations in which the concept with code b02 defines in default csv with cs uri example:anotherTerminology appears as target */

2017-06-15T07:32:46Z

‎Get associations in which the concept with code b02 defines in default csv with cs uri example:anotherTerminology appears as target

Krebs: /* Get all associations in which the concept with code a02 defined in default csv with cs uri example:anotherTerminology appears as subject */

2017-06-15T07:32:06Z

‎Get all associations in which the concept with code a02 defined in default csv with cs uri example:anotherTerminology appears as subject

Krebs: /* Example Responses */

2017-06-15T07:31:00Z

‎Example Responses

@@ Zeile 195: / Zeile 195: @@
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
 ** the query parameter codesystemuri is given but is not a valid uri
-** there is no csv with the given uri and version id
+** there is no csv with the given uri and version id or resourceID
 * unspecified exception if the query parameter filtercomponent is not set to toplevel
@@ Zeile 205: / Zeile 204: @@
 * '''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
+:'''codesystemversionid''' if the query parameter codesystemuri is given, the value of this parameter defines the version ID (set to '_def' to request the default version); if the query parameter codesystemuri is NOT given, the value of this parameter refers to the unique resourceID of the code system 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
+:'''codesystemuri''' the URI that references the code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary; use this query parameter in conjunction with the path parameter codesystemversionid when the latter refers to the versionID of the requested code system version
 * '''returns: ''' entity:EntityDescriptionMsg; contains all designations for an entity description and definitions if given
@@ Zeile 299: / Zeile 298: @@
 * '''UnknownCodeSystemVersion''' if
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
-** the query parameter codesystemuri is not specified or is not an uri
+** the query parameter codesystemuri is given but is not a valid uri
-** there is no csv with the given uri and version id
+** there is no csv with the given uri and version id or resourceID
 * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
@@ Zeile 309: / Zeile 308: @@
 * '''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
+:'''codesystemversionid''' if the query parameter codesystemuri is given, the value of this parameter defines the version ID (set to '_def' to request the default version); if the query parameter codesystemuri is NOT given, the value of this parameter refers to the unique resourceID of the code system 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 <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 the code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary; use this query parameter in conjunction with the path parameter codesystemversionid when the latter refers to the versionID of the requested code system version
 * '''returns: ''' entity:EntityList
@@ Zeile 579: / Zeile 578: @@
 * '''UnknownCodeSystemVersion''' if
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
-** the query parameter codesystemuri is not specified or is not an uri
+** the query parameter codesystemuri is given but is not a valid uri
-** there is no csv with the given uri and version id
+** there is no csv with the given uri and version id or resourceID
 * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
@@ Zeile 589: / Zeile 588: @@
 * '''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
+:'''codesystemversionid''' if the query parameter codesystemuri is given, the value of this parameter defines the version ID (set to '_def' to request the default version); if the query parameter codesystemuri is NOT given, the value of this parameter refers to the unique resourceID of the code system version
 * '''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 the code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary; use this query parameter in conjunction with the path parameter codesystemversionid when the latter refers to the versionID of the requested code system version
 * '''returns: ''' association:AssociationList
@@ Zeile 772: / Zeile 771: @@
 * '''UnknownCodeSystemVersion''' if
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
-** the query parameter codesystemuri is not specified or is not an uri
+** the query parameter codesystemuri is given but is not a valid uri
-** there is no csv with the given uri and version id
+** there is no csv with the given uri and version id or resourceID
 * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
@@ Zeile 782: / Zeile 781: @@
 * '''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
+:'''codesystemversionid''' if the query parameter codesystemuri is given, the value of this parameter defines the version ID (set to '_def' to request the default version); if the query parameter codesystemuri is NOT given, the value of this parameter refers to the unique resourceID of the code system version
 * '''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 the code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary; use this query parameter in conjunction with the path parameter codesystemversionid when the latter refers to the versionID of the requested code system version
 * '''returns: ''' association:AssociationList
@@ Zeile 899: / Zeile 898: @@
 * '''UnknownCodeSystemVersion''' if
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
-** the query parameter codesystemuri is not specified or is not an uri
+** the query parameter codesystemuri is given but is not a valid uri
-** there is no csv with the given uri and version id
+** there is no csv with the given uri and version id or resourceID
 * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name

@@ Zeile 5: / Zeile 5: @@
 === 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 (csv) but only the top level concepts
+EntityDescriptionQueryService:resolve: Return an <i>EntityDirectory</i> that contains the set of <i>EntityReference</i>s identified by <i>directory</i>. <br>
 * '''Path:''' /codesystem/{codesystemid}/version/{codesystemversionid}/entities
 * '''Method:''' GET
 * '''Path Parameters:'''
-:'''codesytemid''' the Name of the Code System - will be ignored
+:'''codesytemid''' the Name of the Code System - needs to be set to an underscore '_'
-:'''codesystemversionid''' the Name (version ID) of the Code System Version, set to '_def' to request the default version
+:'''codesystemversionid''' if the query parameter codesystemuri is given, the value of this parameter defines the version ID (set to '_def' to request the default version); if the query parameter codesystemuri is NOT given, the value of this parameter refers to the unique resourceID of the code system version
 * '''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 the code system, e.g. http://www.nlm.nih.gov/mesh14 for the MeSH vocabulary; use this query parameter in conjunction with the path parameter codesystemversionid when the latter refers to the versionID of the requested code system version
 :'''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
@@ Zeile 191: / Zeile 194: @@
 * '''UnknownCodeSystemVersion''' if
 ** the name of the code system (path parameter codesystemid) is not set to an underscore
-** the query parameter codesystemuri is not specified or is not an uri
+** the query parameter codesystemuri is given but is not a valid uri
 ** there is no csv with the given uri and version id
 * unspecified exception if the query parameter filtercomponent is not set to toplevel

@@ Zeile 910: / Zeile 910: @@
 ===== Example Responses =====
-====== Get the entity with uri  ======
+====== Get the entity with uri urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69  ======
 '''Path''': /entitybyuri?uri=urn:negros:oid%2318e86ea0_3A15caa89b4ea_3A_2D7f69
 <code xml>
   <?xml version="1.0" encoding="UTF-8"?>

@@ Zeile 851: / Zeile 851: @@
              <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Choriogonadotropin Ag [Presence] in Tissue by Immune stain</core:designation>
          </subject>
-         <predicate uri="urn:negros:oid#x1193683">
+         <predicate uri="urn:negros:oid#x1193683"/>
          <target>
              <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
@@ Zeile 867: / Zeile 865: @@
              <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Sulfatide IgG Ab [Titer] in Serum</core:designation>
          </subject>
-         <predicate uri="urn:negros:oid#x1193683">
+         <predicate uri="urn:negros:oid#x1193683"/>
          <target>
              <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
@@ Zeile 883: / Zeile 879: @@
              <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Lu sup(ab) Ab [Presence] in Serum or Plasma</core:designation>
          </subject>
-         <predicate uri="urn:negros:oid#x1193683">
+         <predicate uri="urn:negros:oid#x1193683"/>
          <target>
              <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
@@ Zeile 904: / Zeile 898: @@
 ** there is no csv with the given uri and version id
 * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name

@@ Zeile 827: / Zeile 827: @@
 '''Complete Path''': http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/1/targetof?codesystemuri=urn:oid:2.16.840.1.113883.6.1
 <code xml>
-<?xml version="1.0" encoding="UTF-8"?>
+ <?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="PARTIAL" numEntries="100" next="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/1/targetof?codesystemuri=urn:oid:2.16.840.1.113883.6.1&amp;maxtoreturn=100&amp;page=1">
      <core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">

@@ Zeile 796: / Zeile 796: @@
          <core:parameter arg="Accept">
              <core:val>*/*</core:val>
          </core:parameter>
          <core:parameter arg="page">
@@ Zeile 809: / Zeile 806: @@
              <core:val>example:anotherTerminology</core:val>
          </core:parameter>
-         <core:accessDate>2016-07-05T14:34:59</core:accessDate>
+         <core:accessDate>2017-06-15T09:32:29</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">
+         <subject href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/a02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75">
              <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">a02</core:name>
          </subject>
-         <predicate uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7f9c">
+         <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" />
          <target>
-             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#_2D4e7ea6c8_3A155baac06e0_3A_2D7fa4" />
+             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f71" />
          </target>
          <assertedBy>
-             <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core:version>
+             <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version>
          </assertedBy>
      </entry>
   </AssociationList>
 </code>
 ====== [non-public] Get associations in which the LOINC concept with code 1 appears as target ======
 '''Complete Path''': http://10.147.147.61:8080/WebCts2LE/rest/codesystem/_/version/2.44/entity/1/targetof?codesystemuri=http://loinc.org

@@ Zeile 613: / Zeile 613: @@
              <core:val>example:anotherTerminology</core:val>
          </core:parameter>
-         <core:accessDate>2017-06-15T08:52:26</core:accessDate>
+         <core:accessDate>2017-06-15T09:31:50</core:accessDate>
      </core:heading>
      <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
-         <subject uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f75" />
+         <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
-         <predicate uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f69" />
+         <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" />
          <target>
-             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/b02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f71">
+             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/b02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f71">
                  <core:name>b02</core:name>
              </core:entity>
@@ Zeile 629: / Zeile 629: @@
      </entry>
      <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
-         <subject uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f75" />
+         <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
-         <predicate uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f69" />
+         <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" />
          <target>
-             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/c02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f6d">
+             <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/c02?codesystemuri=example:anotherTerminology" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f6d">
                  <core:name>c02</core:name>
              </core:entity>
@@ Zeile 642: / Zeile 642: @@
      </entry>
      <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
-         <subject uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f75" />
+         <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
-         <predicate uri="urn:negros:oid#191ea9fc_3A15be714698b_3A_2D7f66" />
+         <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f66" />
          <target>
              <core:literal xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">

@@ Zeile 318: / Zeile 318: @@
 '''Path''': /codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs
 <code xml>
   <?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">
@@ Zeile 325: / Zeile 326: @@
          <core:parameter arg="Accept">
              <core:val>*/*</core:val>
          </core:parameter>
          <core:parameter arg="page">
@@ Zeile 338: / Zeile 336: @@
              <core:val>http://test/vs</core:val>
          </core:parameter>
-         <core:accessDate>2016-07-05T14:24:46</core:accessDate>
+         <core:accessDate>2017-06-15T09:30:31</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">
+             <classDescription about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f95">
                  <entityID>
                      <core:namespace xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">no-namespace</core:namespace>
@@ Zeile 348: / Zeile 346: @@
                  </entityID>
                  <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">2016-04-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">
+                 <parent href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/2016-04-11/entity/11?codesystemuri=http://test/vs" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f98">
                      <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">11</core:name>
                  </parent>
                  <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
@@ Zeile 365: / Zeile 360: @@
      </entry>
   </EntityList>
 </code>