WS-Beschreibung - Terminologieserver Search ListValueSetContents

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Specifics)
 
(4 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 2: Zeile 2:
 
Lists all concepts that are linked to the given value set version.
 
Lists all concepts that are linked to the given value set version.
  
=Prerequisites=
+
=Preconditions=
  
 
=Request/Response=
 
=Request/Response=
Zeile 18: Zeile 18:
 
   <td>LoginType</td>
 
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Login-Informationen</td>
+
   <td>Login information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 25: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 31: Zeile 31:
 
   <td>value_set</td>
 
   <td>value_set</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td>
+
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 37: Zeile 37:
 
   <td>value_set_version</td>
 
   <td>value_set_version</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Stellt die Version eines Valuesets dar.</td>
+
   <td>Represents  the version of an valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 43: Zeile 43:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Datum, ab dem die Valueset-Version gültig ist</td>
+
   <td>Start date for the validity of the valueset version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 49: Zeile 49:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Versions-ID des Valuesets</td>
+
   <td>Version ID of the value set</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 55: Zeile 55:
 
   <td>SortingType</td>
 
   <td>SortingType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Legt Sortierung fest. Falls nicht angegeben, werden die Konzepte aufsteigend nach dem Code sortiert.</td>
+
   <td>Determines the assortment. If not given, the concepts are sorted asscending according to the code.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 62: Zeile 62:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
   <td>Mögliche Werte: CODE, TERM
+
   <td>possible values: CODE, TERM
  
Standardwert: CODE</td>
+
default value: CODE</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 71: Zeile 71:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
   <td>Mögliche Werte: ASCENDING, DESCENDING
+
   <td>possible values: ASCENDING, DESCENDING
  
Standardwert: ASCENDING</td>
+
default value: ASCENDING</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 80: Zeile 80:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
   <td>Mögliche Werte: ALPHABETICALLY, ORDER_NR
+
   <td>possible values: ALPHABETICALLY, ORDER_NR
  
Standardwert: ALPHABETICALLY</td>
+
default value: ALPHABETICALLY</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 98: Zeile 98:
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Enthält Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 104: Zeile 104:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Anzahl der Ergebnisse</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 111: Zeile 111:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 129: Zeile 129:
 
   <td>code_system_entity</td>
 
   <td>code_system_entity</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
   <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
+
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 135: Zeile 135:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Die aktuelle ID der code_system_entity_version</td>
+
   <td>Current ID of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 147: Zeile 147:
 
   <td>code_system_entity_version</td>
 
   <td>code_system_entity_version</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
   <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 153: Zeile 153:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Zeitpunkt der letzten Änderung</td>
+
   <td>Point in time of the last change.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 159: Zeile 159:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
   <td>Point in time, when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 165: Zeile 165:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td>
+
   <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 171: Zeile 171:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 177: Zeile 177:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 183: Zeile 183:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
   <td>Refers to the prior version, if there are more than one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 189: Zeile 189:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 195: Zeile 195:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 201: Zeile 201:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Versions-ID der Entity-Version</td>
+
   <td>Version-ID of Entity-Version</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 207: Zeile 207:
 
   <td>association_type</td>
 
   <td>association_type</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.</td>
+
   <td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 214: Zeile 214:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Name der Beziehung in normaler Leserichtung (ID 1->2)</td>
+
   <td>Name of association in normal reading direction (ID 1->2)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 221: Zeile 221:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Name der Beziehung in umgekehrter Leserichtung (ID 2->1)</td>
+
   <td>Name of association in reversed reading direction (ID 2->1)</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 227: Zeile 227:
 
   <td>code_system_concept</td>
 
   <td>code_system_concept</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td>
+
   <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 234: Zeile 234:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Der Code zu einem Begriff bzw. Konzepts</td>
+
   <td>Code of a concept or term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of a term or concept</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 240: Zeile 247:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
+
   <td>Specifies, if a term or concept is preferred or not.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 247: Zeile 254:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Der Begriff selbst</td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 254: Zeile 261:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Abkürzung des Begriffs</td>
+
   <td>The abbrevation of the term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 260: Zeile 267:
 
   <td>code_system_concept_translation</td>
 
   <td>code_system_concept_translation</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
   <td>Übersetzung eines Begriffs.</td>
+
   <td>Translation of a term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
   <td id="param_level5">codeSystemEntityVersionId</td>
 
   <td id="param_level5">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the translated term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">id</td>
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 272: Zeile 292:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes)</td>
+
   <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 279: Zeile 299:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Übersetzter Begriff</td>
+
   <td>Translated term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 286: Zeile 306:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Abkürzung des übersetzten Begriffs</td>
+
   <td>Abbreviation of the translated term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 398: Zeile 418:
 
   <td>code_system_version_entity_membership</td>
 
   <td>code_system_version_entity_membership</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
+
   <td>Connects the version of a Code System to the entities.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 416: Zeile 436:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is an axis of the code system</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 422: Zeile 442:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
 
=Annotations=
 
=Annotations=
==Noteworthiness==
+
==Specifics==
 +
Use the statusDate from "conceptValueSetMemberships" to obtain all inserted or changed values since the given date. Use it for synchronize with your own system. Please see the SOAP messages for an example.
 +
 
 
==Hints==
 
==Hints==
  
Zeile 448: Zeile 470:
 
   </soapenv:Body>
 
   </soapenv:Body>
 
</soapenv:Envelope>
 
</soapenv:Envelope>
 +
</source>
 +
===with search date===
 +
The given statusDate represents a start date. All inserted or changed concepts after this date will be returned.
 +
<source lang="xml">
 +
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
      <sear:ListValueSetContents>
 +
        <parameter>           
 +
            <valueSet>
 +
              <valueSetVersions>
 +
                <versionId>4</versionId>
 +
                <conceptValueSetMemberships>
 +
                  <statusDate>2013-01-01T00:00:00+01:00</statusDate>
 +
                </conceptValueSetMemberships>
 +
              </valueSetVersions>
 +
            </valueSet>
 +
            <readMetadataLevel>true</readMetadataLevel>
 +
        </parameter>
 +
      </sear:ListValueSetContents>
 +
  </soapenv:Body>
 +
  </soapenv:Envelope>
 
</source>
 
</source>
  

Aktuelle Version vom 2. Dezember 2013, 08:09 Uhr

Inhaltsverzeichnis

Functionality

Lists all concepts that are linked to the given value set version.

Preconditions

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
value_set value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
value_set_version value_set_version 0..1 Represents the version of an valueset.
releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
versionId Long 1..1 Version ID of the value set
SortingType SortingType 0..1 Determines the assortment. If not given, the concepts are sorted asscending according to the code.
sortBy String 0..1 possible values: CODE, TERM default value: CODE
sortDirection String 0..1 possible values: ASCENDING, DESCENDING default value: ASCENDING
sortType String 0..1 possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
count Integer 1..1 number of results
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system_entity code_system_entity 0..N Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
currentVersionId Long 1..1 Current ID of code_system_entity_version.
id Long 1..1
code_system_entity_version code_system_entity_version 1..N code_system_entity_version is the superclass of every Concept and Association.
effectiveDate java.util.Date 1..1 Point in time of the last change.
insertTimestamp java.util.Date 1..1 Point in time, when entry was inserted.
isLeaf Boolean 1..1 Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only.
majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
versionId Long 1..1 Version-ID of Entity-Version
association_type association_type 0..1 Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version
forwardName String 50 1..1 Name of association in normal reading direction (ID 1->2)
reverseName String 50 1..1 Name of association in reversed reading direction (ID 2->1)
code_system_concept code_system_concept 0..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
description String 1..1 Description of a term or concept
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 1..1 The abbrevation of the term.
code_system_concept_translation code_system_concept_translation 0..N Translation of a term
codeSystemEntityVersionId Long 1..1
description String 1..1 Description of the translated term.
id Long 1..1
languageId Long 1..1 Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
term String 65535 1..1 Translated term
termAbbrevation String 50 1..1 Abbreviation of the translated term.
property property 0..N
currentVersionId Long 1..1
id Long 1..1
property_version property_version 1..N
content byte[] 1..1
contentMimetype String 50 1..1
contentName String 255 1..1
contentSize Integer 1..1
description String 65535 1..1
insertTimestamp java.util.Date 1..1
languageId Long 1..1
name String 65535 1..1
previousVersionId Long 1..1
propertyKindId Long 1..1
status Integer 1..1
statusDate java.util.Date 1..1
versionId Long 1..1
code_system_version_entity_membership code_system_version_entity_membership 1..1 Connects the version of a Code System to the entities.
codeSystemEntityId Long 1..1
codeSystemVersionId Long 1..1
isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.

Annotations

Specifics

Use the statusDate from "conceptValueSetMemberships" to obtain all inserted or changed values since the given date. Use it for synchronize with your own system. Please see the SOAP messages for an example.

Hints

Examples

SOAP messages

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListValueSetContents>
         <parameter>            
            <valueSet>
               <id>1</id>
               <valueSetVersions>
                 <versionId>1</versionId>
               </valueSetVersions>
            </valueSet>
         </parameter>
      </sear:ListValueSetContents>
   </soapenv:Body>
</soapenv:Envelope>

with search date

The given statusDate represents a start date. All inserted or changed concepts after this date will be returned.

  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListValueSetContents>
         <parameter>            
            <valueSet>
               <valueSetVersions>
                 <versionId>4</versionId>
                 <conceptValueSetMemberships>
                   <statusDate>2013-01-01T00:00:00+01:00</statusDate>
                 </conceptValueSetMemberships>
               </valueSetVersions>
            </valueSet>
            <readMetadataLevel>true</readMetadataLevel>
         </parameter>
      </sear:ListValueSetContents>
   </soapenv:Body>
  </soapenv:Envelope>

Code examples

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge