CTS2-LE REST API: Read Entity Descriptions: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Krebs (Diskussion | Beiträge) K (→Get top level concepts of the default csv with cs uri http://test/vs) |
Krebs (Diskussion | Beiträge) K |
||
| (10 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 5: | Zeile 5: | ||
=== Retrieve all top level concepts of a code system version=== | === Retrieve all top level concepts of a code system version=== | ||
| − | + | EntityDescriptionQueryService:resolve: Return an <i>EntityDirectory</i> that contains the set of <i>EntityReference</i>s identified by <i>directory</i>. <br> | |
| + | '''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.''' <br> | ||
| + | Please check [[CTS2-LE REST API: Read Code Systems and Code System Versions]] for instructions on how to identify a code system version. | ||
| + | |||
* '''Path:''' /codesystem/{codesystemid}/version/{codesystemversionid}/entities | * '''Path:''' /codesystem/{codesystemid}/version/{codesystemversionid}/entities | ||
* '''Method:''' GET | * '''Method:''' GET | ||
* '''Path Parameters:''' | * '''Path Parameters:''' | ||
| − | :'''codesytemid''' the Name of the Code System - | + | :'''codesytemid''' the Name of the Code System - needs to be set to an underscore '_' |
| − | :'''codesystemversionid''' the | + | :'''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:''' | * '''Query Parameters:''' | ||
:'''page''' the 0-based page number used for paging result sets. Default is 0. | :'''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. | :'''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 | + | :'''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. | :'''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 | * '''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 | * '''UnknownCodeSystemVersion''' if | ||
** the name of the code system (path parameter codesystemid) is not set to an underscore | ** the name of the code system (path parameter codesystemid) is not set to an underscore | ||
| − | ** the query parameter codesystemuri is | + | ** 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 | * unspecified exception if the query parameter filtercomponent is not set to toplevel | ||
| Zeile 201: | Zeile 204: | ||
* '''Path Parameters:''' | * '''Path Parameters:''' | ||
:'''codesytemid''' the Name of the Code System - will be ignored | :'''codesytemid''' the Name of the Code System - will be ignored | ||
| − | :'''codesystemversionid''' the | + | :'''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. | :'''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:''' | ||
| − | :'''codesystemuri''' the URI that references | + | :'''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 | * '''returns: ''' entity:EntityDescriptionMsg; contains all designations for an entity description and definitions if given | ||
| Zeile 219: | Zeile 222: | ||
<core:parameter arg="Accept"> | <core:parameter arg="Accept"> | ||
<core:val>*/*</core:val> | <core:val>*/*</core:val> | ||
| − | |||
| − | |||
| − | |||
</core:parameter> | </core:parameter> | ||
<core:parameter arg="codesystemuri"> | <core:parameter arg="codesystemuri"> | ||
<core:val>example:anotherTerminology</core:val> | <core:val>example:anotherTerminology</core:val> | ||
</core:parameter> | </core:parameter> | ||
| − | <core:accessDate> | + | <core:accessDate>2017-06-15T09:29:11</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# | + | <classDescription about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f6d"> |
<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> | ||
| Zeile 235: | Zeile 235: | ||
</entityID> | </entityID> | ||
<describingCodeSystemVersion> | <describingCodeSystemVersion> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core: | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version> |
| + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem> | ||
</describingCodeSystemVersion> | </describingCodeSystemVersion> | ||
<designation designationRole="PREFERRED"> | <designation designationRole="PREFERRED"> | ||
| Zeile 247: | Zeile 248: | ||
<definition definitionRole="INFORMATIVE"> | <definition definitionRole="INFORMATIVE"> | ||
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">def for c</core:value> | <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">def for c</core:value> | ||
| + | <core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language> | ||
</definition> | </definition> | ||
| − | <targetOf>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/ | + | <targetOf>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/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> | ||
| Zeile 296: | Zeile 298: | ||
* '''UnknownCodeSystemVersion''' if | * '''UnknownCodeSystemVersion''' if | ||
** the name of the code system (path parameter codesystemid) is not set to an underscore | ** the name of the code system (path parameter codesystemid) is not set to an underscore | ||
| − | ** the query parameter codesystemuri is | + | ** 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 | * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name | ||
| Zeile 306: | Zeile 308: | ||
* '''Path Parameters:''' | * '''Path Parameters:''' | ||
:'''codesytemid''' the Name of the Code System - will be ignored | :'''codesytemid''' the Name of the Code System - will be ignored | ||
| − | :'''codesystemversionid''' the | + | :'''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. | :'''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. | :'''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. | :'''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 | + | :'''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 | * '''returns: ''' entity:EntityList | ||
| Zeile 319: | Zeile 321: | ||
'''Path''': /codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs | '''Path''': /codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs | ||
<code xml> | <code xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?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"> | <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 326: | Zeile 329: | ||
<core:parameter arg="Accept"> | <core:parameter arg="Accept"> | ||
<core:val>*/*</core:val> | <core:val>*/*</core:val> | ||
| − | |||
| − | |||
| − | |||
</core:parameter> | </core:parameter> | ||
<core:parameter arg="page"> | <core:parameter arg="page"> | ||
| Zeile 339: | Zeile 339: | ||
<core:val>http://test/vs</core:val> | <core:val>http://test/vs</core:val> | ||
</core:parameter> | </core:parameter> | ||
| − | <core:accessDate> | + | <core:accessDate>2017-06-15T09:30:31</core:accessDate> |
</core:heading> | </core:heading> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity"> | ||
<entry> | <entry> | ||
| − | <classDescription about="urn:negros:oid# | + | <classDescription about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f95"> |
<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> | ||
| Zeile 349: | Zeile 349: | ||
</entityID> | </entityID> | ||
<describingCodeSystemVersion> | <describingCodeSystemVersion> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">code-system-88-4-11</core: | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2016-04-11</core:version> |
| + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="http://test/vs">code-system-88-4-11</core:codeSystem> | ||
</describingCodeSystemVersion> | </describingCodeSystemVersion> | ||
<designation designationRole="PREFERRED"> | <designation designationRole="PREFERRED"> | ||
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-11-b</core:value> | <core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-11-b</core:value> | ||
</designation> | </designation> | ||
| − | + | <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"> | |
| − | |||
| − | |||
| − | <parent href="http://localhost:8080/WebCts2LE/rest/codesystem/_/version/ | ||
<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">11</core:name> | ||
| − | |||
</parent> | </parent> | ||
<entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" /> | <entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" /> | ||
| Zeile 366: | Zeile 363: | ||
</entry> | </entry> | ||
</EntityList> | </EntityList> | ||
| − | |||
</code> | </code> | ||
| Zeile 582: | Zeile 578: | ||
* '''UnknownCodeSystemVersion''' if | * '''UnknownCodeSystemVersion''' if | ||
** the name of the code system (path parameter codesystemid) is not set to an underscore | ** the name of the code system (path parameter codesystemid) is not set to an underscore | ||
| − | ** the query parameter codesystemuri is | + | ** 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 | * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name | ||
| Zeile 592: | Zeile 588: | ||
* '''Path Parameters:''' | * '''Path Parameters:''' | ||
:'''codesytemid''' the Name of the Code System - will be ignored | :'''codesytemid''' the Name of the Code System - will be ignored | ||
| − | :'''codesystemversionid''' the | + | :'''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:''' | * '''Query Parameters:''' | ||
:'''page''' the 0-based page number used for paging result sets. Default is 0. | :'''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. | :'''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 | + | :'''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 | * '''returns: ''' association:AssociationList | ||
| Zeile 620: | Zeile 616: | ||
<core:val>example:anotherTerminology</core:val> | <core:val>example:anotherTerminology</core:val> | ||
</core:parameter> | </core:parameter> | ||
| − | <core:accessDate>2017-06- | + | <core:accessDate>2017-06-15T09:31:50</core:accessDate> |
</core:heading> | </core:heading> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject uri="urn:negros:oid# | + | <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" /> |
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" /> |
<target> | <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# | + | <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:name>b02</core:name> | ||
</core:entity> | </core:entity> | ||
| Zeile 636: | Zeile 632: | ||
</entry> | </entry> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject uri="urn:negros:oid# | + | <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" /> |
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" /> |
<target> | <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# | + | <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:name>c02</core:name> | ||
</core:entity> | </core:entity> | ||
| Zeile 649: | Zeile 645: | ||
</entry> | </entry> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject uri="urn:negros:oid# | + | <subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" /> |
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f66" /> |
<target> | <target> | ||
<core:literal xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | <core:literal xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | ||
| Zeile 775: | Zeile 771: | ||
* '''UnknownCodeSystemVersion''' if | * '''UnknownCodeSystemVersion''' if | ||
** the name of the code system (path parameter codesystemid) is not set to an underscore | ** the name of the code system (path parameter codesystemid) is not set to an underscore | ||
| − | ** the query parameter codesystemuri is | + | ** 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 | * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name | ||
| Zeile 785: | Zeile 781: | ||
* '''Path Parameters:''' | * '''Path Parameters:''' | ||
:'''codesytemid''' the Name of the Code System - will be ignored | :'''codesytemid''' the Name of the Code System - will be ignored | ||
| − | :'''codesystemversionid''' the | + | :'''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:''' | * '''Query Parameters:''' | ||
:'''page''' the 0-based page number used for paging result sets. Default is 0. | :'''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. | :'''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 | + | :'''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 | * '''returns: ''' association:AssociationList | ||
| Zeile 803: | Zeile 799: | ||
<core:parameter arg="Accept"> | <core:parameter arg="Accept"> | ||
<core:val>*/*</core:val> | <core:val>*/*</core:val> | ||
| − | |||
| − | |||
| − | |||
</core:parameter> | </core:parameter> | ||
<core:parameter arg="page"> | <core:parameter arg="page"> | ||
| Zeile 816: | Zeile 809: | ||
<core:val>example:anotherTerminology</core:val> | <core:val>example:anotherTerminology</core:val> | ||
</core:parameter> | </core:parameter> | ||
| − | <core:accessDate> | + | <core:accessDate>2017-06-15T09:32:29</core:accessDate> |
</core:heading> | </core:heading> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <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# | + | <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> | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">a02</core:name> | ||
| − | |||
</subject> | </subject> | ||
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69" /> |
| − | |||
| − | |||
<target> | <target> | ||
| − | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid# | + | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f71" /> |
</target> | </target> | ||
<assertedBy> | <assertedBy> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">ExampleCS2016</core: | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version> |
| + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem> | ||
</assertedBy> | </assertedBy> | ||
</entry> | </entry> | ||
</AssociationList> | </AssociationList> | ||
</code> | </code> | ||
| + | |||
====== [non-public] Get associations in which the LOINC concept with code 1 appears as target ====== | ====== [non-public] Get associations in which the LOINC concept with code 1 appears as target ====== | ||
| − | '''Complete Path''': http://10.147.147.61: | + | '''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> | <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: | + | <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&maxtoreturn=100&page=1"> |
<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://10.147.147.61: | + | <core:resourceRoot>http://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot> |
<core:resourceURI>codesystem/_/version/2.44/entity/1/targetof</core:resourceURI> | <core:resourceURI>codesystem/_/version/2.44/entity/1/targetof</core:resourceURI> | ||
<core:parameter arg="Accept"> | <core:parameter arg="Accept"> | ||
<core:val>*/*</core:val> | <core:val>*/*</core:val> | ||
| − | |||
| − | |||
| − | |||
</core:parameter> | </core:parameter> | ||
<core:parameter arg="page"> | <core:parameter arg="page"> | ||
| Zeile 856: | Zeile 845: | ||
</core:parameter> | </core:parameter> | ||
<core:parameter arg="codesystemuri"> | <core:parameter arg="codesystemuri"> | ||
| − | <core:val> | + | <core:val>urn:oid:2.16.840.1.113883.6.1</core:val> |
</core:parameter> | </core:parameter> | ||
| − | <core:accessDate> | + | <core:accessDate>2017-06-15T09:39:54</core:accessDate> |
</core:heading> | </core:heading> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject href="WebCts2LE/rest/codesystem/_/version/2.44/entity/10470-3?codesystemuri= | + | <subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/10470-3?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1246298"> |
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">10470-3</core:name> | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">10470-3</core:name> | ||
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Choriogonadotropin Ag [Presence] in Tissue by Immune stain</core:designation> | <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Choriogonadotropin Ag [Presence] in Tissue by Immune stain</core:designation> | ||
</subject> | </subject> | ||
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#x1193683"/> |
| − | |||
| − | |||
<target> | <target> | ||
| − | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid# | + | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" /> |
</target> | </target> | ||
<assertedBy> | <assertedBy> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Loinc2.44</core: | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version> |
| + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem> | ||
</assertedBy> | </assertedBy> | ||
</entry> | </entry> | ||
| − | |||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject href="WebCts2LE/rest/codesystem/_/version/2.44/entity/ | + | <subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/10866-2?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1465186"> |
| − | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | + | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">10866-2</core:name> |
| − | <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | + | <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Sulfatide IgG Ab [Titer] in Serum</core:designation> |
</subject> | </subject> | ||
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#x1193683"/> |
| − | |||
| − | |||
<target> | <target> | ||
| − | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid# | + | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" /> |
</target> | </target> | ||
<assertedBy> | <assertedBy> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version> |
| − | + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem> | |
| − | |||
| − | |||
| − | |||
| − | <core: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</assertedBy> | </assertedBy> | ||
</entry> | </entry> | ||
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | <entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association"> | ||
| − | <subject href="WebCts2LE/rest/codesystem/_/version/2.44/entity/ | + | <subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/1141-1?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1508757"> |
| − | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | + | <core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1141-1</core:name> |
| − | <core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core"> | + | <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> | </subject> | ||
| − | <predicate uri="urn:negros:oid# | + | <predicate uri="urn:negros:oid#x1193683"/> |
| − | |||
| − | |||
<target> | <target> | ||
| − | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid# | + | <core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" /> |
</target> | </target> | ||
<assertedBy> | <assertedBy> | ||
| − | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Loinc2.44</core: | + | <core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version> |
| + | <core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem> | ||
</assertedBy> | </assertedBy> | ||
</entry> | </entry> | ||
| − | + | ... | |
| − | + | </AssociationList> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
</code> | </code> | ||
| Zeile 942: | Zeile 898: | ||
* '''UnknownCodeSystemVersion''' if | * '''UnknownCodeSystemVersion''' if | ||
** the name of the code system (path parameter codesystemid) is not set to an underscore | ** the name of the code system (path parameter codesystemid) is not set to an underscore | ||
| − | ** the query parameter codesystemuri is | + | ** 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 | * '''UnknownEntity''' if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name | ||
| + | |||
| + | |||
| + | === Retrieve an entity by its uri === | ||
| + | * EntityDescriptionReadService:availableDescriptions: Return the available <i>EntityDescriptions</i> for the referenced entity. This returns a list of the latest versions of all of the code systems that make assertions about the referenced entity. | ||
| + | * '''Path:''' /entitybyuri | ||
| + | * '''Method:''' GET | ||
| + | * '''Path Parameters:''' - | ||
| + | * '''Query Parameters:''' | ||
| + | :'''uri''' the URI of the requested resource | ||
| + | * '''returns: ''' core:EntityReference | ||
| + | |||
| + | ===== Example Responses ===== | ||
| + | ====== 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"?> | ||
| + | <EntityReferenceMsg 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>entitybyuri</core:resourceURI> | ||
| + | <core:parameter arg="Accept"> | ||
| + | <core:val>*/*</core:val> | ||
| + | </core:parameter> | ||
| + | <core:parameter arg="uri"> | ||
| + | <core:val>urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69</core:val> | ||
| + | </core:parameter> | ||
| + | <core:accessDate>2017-06-15T09:54:25</core:accessDate> | ||
| + | </core:heading> | ||
| + | <core:entityReference xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69"> | ||
| + | <core:name> | ||
| + | <core:name>seeAlso</core:name> | ||
| + | <core:namespace>no-namespace</core:namespace> | ||
| + | </core:name> | ||
| + | <core:knownEntityDescription> | ||
| + | <core:describingCodeSystemVersion> | ||
| + | <core:version>1.0</core:version> | ||
| + | <core:codeSystem uri="example:anotherTerminology">ExampleCS2016</core:codeSystem> | ||
| + | </core:describingCodeSystemVersion> | ||
| + | <core:designation>seeAlso</core:designation> | ||
| + | </core:knownEntityDescription> | ||
| + | </core:entityReference> | ||
| + | </EntityReferenceMsg> | ||
| + | </code> | ||
Aktuelle Version vom 5. April 2018, 10:44 Uhr
A general note: Response format and language may be controlled either by a Query Parameter: ?referencelanguage={language} or ?format={format} OR by the HTTP 'Accept' and 'Accept-Language' Header Parameters. Query OR Header parameters will both the accepted as valid, however, the Query parameters will ALWAYS take precedence over the Header parameters, if both are present. Currently, we only support application/xml as format. The language attribute will be ignored.
Root-URL: /WebCts2LE/rest/
Inhaltsverzeichnis
- 1 Retrieve all top level concepts of a code system version
- 2 Retrieve an entity description from a specified code system version
- 3 Retrieve a list of child entities
- 4 Retrieve associations in which a given entity is the subject
- 5 Retrieve associations in which a given entity is the target
- 6 Retrieve an entity by its uri
Retrieve all top level concepts of a code system version
EntityDescriptionQueryService:resolve: Return an EntityDirectory that contains the set of EntityReferences identified by directory.
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.
Please check CTS2-LE REST API: Read Code Systems and Code System Versions for instructions on how to identify a code system version.
- Path: /codesystem/{codesystemid}/version/{codesystemversionid}/entities
- Method: GET
- Path Parameters:
- codesytemid the Name of the Code System - needs to be set to an underscore '_'
- 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 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 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
Example Responses
Get top level concepts of the default csv with cs uri http://test/vs
Path: /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="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>2017-06-15T09:28:12</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
<entry>
<classDescription about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f8f">
<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">_def</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="http://test/vs">code-system-88-4-11</core:codeSystem>
</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#18e86ea0_3A15caa89b4ea_3A_2D7f98">
<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">_def</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="http://test/vs">code-system-88-4-11</core:codeSystem>
</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#18e86ea0_3A15caa89b4ea_3A_2D7f91">
<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">_def</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="http://test/vs">code-system-88-4-11</core:codeSystem>
</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>
[non-public] Get LOINC top level concepts
<?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="24">
<core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
<core:resourceRoot>http://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot>
<core:resourceURI>codesystem/_/version/2.44/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="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>urn:oid:2.16.840.1.113883.6.1</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:22:00</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
<entry>
<classDescription about="urn:negros:oid#x1245500">
<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">LP31625-4</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:value>
</designation>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1285638">
<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">LP7755-4</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Antibiotic Susceptibilities</core:value>
</designation>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP7755-4/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1200789">
<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">LP32651-9</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Blood Bank</core:value>
</designation>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP32651-9/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</children>
<entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
</classDescription>
</entry>
</entry>
....
</EntityList>
Exceptions
- UnknownCodeSystemVersion if
- 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 or resourceID
- unspecified exception if the query parameter filtercomponent is not set to toplevel
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 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 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
Example Responses
Get concept with code c02 contained in default csv with cs uri example:anotherTerminology
Path: /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="codesystemuri">
<core:val>example:anotherTerminology</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:29:11</core:accessDate>
</core:heading>
<EntityDescription xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
<classDescription about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f6d">
<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">1.0</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</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>
<core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
</definition>
<targetOf>http://localhost:8080/WebCts2LE/rest/codesystem/_/version/1.0/entity/c02/targetof?codesystemuri=example:anotherTerminology</targetOf>
<entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
</classDescription>
</EntityDescription>
</EntityDescriptionMsg>
[non-public] Get LOINC concept with code LP31625-4
Complete Path: http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1
<?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://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot>
<core:resourceURI>codesystem/_/version/2.44/entity/LP31625-4</core:resourceURI>
<core:parameter arg="Accept">
<core:val>*/*</core:val>
</core:parameter>
<core:parameter arg="codesystemuri">
<core:val>urn:oid:2.16.840.1.113883.6.1</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:24:07</core:accessDate>
</core:heading>
<EntityDescription xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
<classDescription about="urn:negros:oid#x1245500">
<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">LP31625-4</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:value>
<core:language xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">en</core:language>
</designation>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</children>
<entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
</classDescription>
</EntityDescription>
</EntityDescriptionMsg>
Exceptions
- UnknownCodeSystemVersion if
- 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 or resourceID
- UnknownEntity if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
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 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 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 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
Example Responses
Get children of concept with code 11 contained in default csv with cs uri http://test/vs
Path: /codesystem/_/version/_def/entity/11/children?codesystemuri=http://test/vs
<?xml version="1.0" encoding="UTF-8"?>
<?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="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>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#18e86ea0_3A15caa89b4ea_3A_2D7f95">
<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">2016-04-11</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="http://test/vs">code-system-88-4-11</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">designation-11-b</core:value>
</designation>
<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" />
</classDescription>
</entry>
</entry>
</EntityList>
[non-public] Get children of LOINC concept with code LP31625-4
<?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="8">
<core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
<core:resourceRoot>http://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot>
<core:resourceURI>codesystem/_/version/2.44/entity/LP31625-4/children</core:resourceURI>
<core:parameter arg="Accept">
<core:val>*/*</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>urn:oid:2.16.840.1.113883.6.1</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:25:16</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Entity">
<entry>
<classDescription about="urn:negros:oid#x1468836">
<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">LP16999-2</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">House dust</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP16999-2/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1384505">
<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">LP30672-7</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Molds and Other Microorganisms</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP30672-7/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1470811">
<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">LP30681-8</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Miscellaneous allergens</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP30681-8/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1365436">
<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">LP30682-6</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Drug allergens</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP30682-6/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1440577">
<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">LP30689-1</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Occupational allergens</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP30689-1/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1454213">
<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">LP31627-0</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Animal</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31627-0/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1530472">
<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">LP31628-8</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Plant</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31628-8/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</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#x1457450">
<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">LP32758-2</core:name>
</entityID>
<describingCodeSystemVersion>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</describingCodeSystemVersion>
<designation designationRole="PREFERRED">
<core:value xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Others</core:value>
</designation>
<parent href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP31625-4?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1245500">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">LP31625-4</core:name>
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">Allergy</core:designation>
</parent>
<children>http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP32758-2/children?codesystemuri=urn:oid:2.16.840.1.113883.6.1</children>
<entityType uri="http://fokus.fraunhofer.de/eHealth/cts2infoModel/signatures#ClassDescription" />
</classDescription>
</entry>
</entry>
</EntityList>
Exceptions
- UnknownCodeSystemVersion if
- 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 or resourceID
- UnknownEntity if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
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 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 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 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
Example Responses
Get all associations in which the concept with code a02 defined in default csv with cs uri example:anotherTerminology appears as subject
Path: /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="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>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#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
<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#18e86ea0_3A15caa89b4ea_3A_2D7f71">
<core:name>b02</core:name>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
<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#18e86ea0_3A15caa89b4ea_3A_2D7f6d">
<core:name>c02</core:name>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f75" />
<predicate uri="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f66" />
<target>
<core:literal xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
<core:value>literal<<<target /></core:value>
<core:language>en</core:language>
</core:literal>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1.0</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</assertedBy>
</entry>
</AssociationList>
[non-public] Get all associations in which the LOINC concept with code 17420-1 appears as subject
Complete Path: http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/17420-1/subjectof?codesystemuri=urn:oid:2.16.840.1.113883.6.1
<?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="5">
<core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
<core:resourceRoot>http://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot>
<core:resourceURI>codesystem/_/version/2.44/entity/17420-1/subjectof</core:resourceURI>
<core:parameter arg="Accept">
<core:val>*/*</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>urn:oid:2.16.840.1.113883.6.1</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:20:39</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#x1352887" />
<predicate uri="urn:negros:oid#x1193683">
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">CLASSTYPE</core:designation>
</predicate>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/1?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1414827">
<core:name>1</core:name>
<core:designation>Laboratory Class</core:designation>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#x1352887" />
<predicate uri="urn:negros:oid#x1193675">
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">COMPONENT</core:designation>
</predicate>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/LP39308-9?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1326004">
<core:name>LP39308-9</core:name>
<core:designation>Parrot droppings Ab</core:designation>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#x1352887" />
<predicate uri="urn:negros:oid#x1193679">
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">PROPERTY</core:designation>
</predicate>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/Prop8?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1403856">
<core:name>Prop8</core:name>
<core:designation>ACnc</core:designation>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#x1352887" />
<predicate uri="urn:negros:oid#x1193681">
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">SCALE_TYPE</core:designation>
</predicate>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/Sc1?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1263752">
<core:name>Sc1</core:name>
<core:designation>Qn</core:designation>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject uri="urn:negros:oid#x1352887" />
<predicate uri="urn:negros:oid#x1193673">
<core:designation xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">SYSTEM</core:designation>
</predicate>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/Sys9?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1238074">
<core:name>Sys9</core:name>
<core:designation>Ser</core:designation>
</core:entity>
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
</AssociationList>
Exceptions
- UnknownCodeSystemVersion if
- 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 or resourceID
- UnknownEntity if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
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 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 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 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
Example Responses
Get associations in which the concept with code b02 defines in default csv with cs uri example:anotherTerminology appears as target
Path: /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="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>2017-06-15T09:32:29</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<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#18e86ea0_3A15caa89b4ea_3A_2D7f69" />
<target>
<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">1.0</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</assertedBy>
</entry>
</AssociationList>
[non-public] Get associations in which the LOINC concept with code 1 appears as target
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
<?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&maxtoreturn=100&page=1">
<core:heading xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">
<core:resourceRoot>http://10.147.147.61:8082/WebCts2LE/rest/</core:resourceRoot>
<core:resourceURI>codesystem/_/version/2.44/entity/1/targetof</core:resourceURI>
<core:parameter arg="Accept">
<core:val>*/*</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>urn:oid:2.16.840.1.113883.6.1</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:39:54</core:accessDate>
</core:heading>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/10470-3?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1246298">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">10470-3</core:name>
<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"/>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/10866-2?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1465186">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">10866-2</core:name>
<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"/>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
<entry xmlns="http://www.omg.org/spec/CTS2/1.1/Association">
<subject href="http://10.147.147.61:8082/WebCts2LE/rest/codesystem/_/version/2.44/entity/1141-1?codesystemuri=urn:oid:2.16.840.1.113883.6.1" uri="urn:negros:oid#x1508757">
<core:name xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">1141-1</core:name>
<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"/>
<target>
<core:entity xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:negros:oid#x1414827" />
</target>
<assertedBy>
<core:version xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core">2.44</core:version>
<core:codeSystem xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" uri="urn:oid:2.16.840.1.113883.6.1">Loinc2.44</core:codeSystem>
</assertedBy>
</entry>
...
</AssociationList>
Exceptions
- UnknownCodeSystemVersion if
- 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 or resourceID
- UnknownEntity if there is no entity in the referenced csv with the given entityid as ScopedEntityName:name
Retrieve an entity by its uri
- EntityDescriptionReadService:availableDescriptions: Return the available EntityDescriptions for the referenced entity. This returns a list of the latest versions of all of the code systems that make assertions about the referenced entity.
- Path: /entitybyuri
- Method: GET
- Path Parameters: -
- Query Parameters:
- uri the URI of the requested resource
- returns: core:EntityReference
Example Responses
Get the entity with uri urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69
Path: /entitybyuri?uri=urn:negros:oid%2318e86ea0_3A15caa89b4ea_3A_2D7f69
<?xml version="1.0" encoding="UTF-8"?>
<EntityReferenceMsg 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>entitybyuri</core:resourceURI>
<core:parameter arg="Accept">
<core:val>*/*</core:val>
</core:parameter>
<core:parameter arg="uri">
<core:val>urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69</core:val>
</core:parameter>
<core:accessDate>2017-06-15T09:54:25</core:accessDate>
</core:heading>
<core:entityReference xmlns:core="http://www.omg.org/spec/CTS2/1.1/Core" about="urn:negros:oid#18e86ea0_3A15caa89b4ea_3A_2D7f69">
<core:name>
<core:name>seeAlso</core:name>
<core:namespace>no-namespace</core:namespace>
</core:name>
<core:knownEntityDescription>
<core:describingCodeSystemVersion>
<core:version>1.0</core:version>
<core:codeSystem uri="example:anotherTerminology">ExampleCS2016</core:codeSystem>
</core:describingCodeSystemVersion>
<core:designation>seeAlso</core:designation>
</core:knownEntityDescription>
</core:entityReference>
</EntityReferenceMsg>
