Um diesen Webservice zu nutzen, müssen Sie sich zunächst am Terminologieserver anmelden (Login).
Parameter |
Typ |
Länge |
Kardinalität |
Beschreibung |
LoginType |
|
| 0..1 |
Login-Informationen |
ip |
String |
|
- |
Die IP-Adresse des Benutzers (wird intern vergeben) |
password |
String |
|
- |
Passwort des Benutzers (als MD5-Wert) |
sessionID |
String |
|
1..1 |
Die Session-ID des Benutzers |
username |
String |
|
- |
Benutzername |
code_system |
|
| 0..1 |
Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. |
currentVersionId |
Long |
| - |
Die aktuelle Versions-ID |
description |
String |
65535 |
- |
Beschreibung eines Codesystems |
id |
Long |
| 1..1 |
|
insertTimestamp |
java.util.Date |
| - |
Zeitstempel, wann das Codesystem eingefügt worden ist |
name |
String |
100 |
- |
Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
code_system_version |
|
| 1..1 |
Version eines Codesystems |
codeSystemId |
Long |
| - |
|
description |
String |
65535 |
- |
Beschreibung des Codesystems |
expirationDate |
java.util.Date |
| - |
Datum, bis wann die Version gültig ist |
insertTimestamp |
java.util.Date |
| - |
Zeitstempel, wann die Codesystem-Version eingefügt worden ist |
licenceHolder |
String |
65535 |
- |
Besitzer der Lizenz |
name |
String |
100 |
- |
Vollständiger Name des Codesystems |
oid |
String |
100 |
- |
Offizielle OID |
preferredLanguageId |
Long |
| - |
Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen) |
previousVersionID |
Long |
| - |
Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. |
releaseDate |
java.util.Date |
| - |
Datum, ab wann die Version gültig ist |
source |
String |
65535 |
- |
Herausgeber der Codesystem-Version |
status |
Integer |
| - |
Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. |
statusDate |
java.util.Date |
| - |
Änderungszeitpunkt des Status |
underLicence |
Boolean |
| - |
true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar) |
versionId |
Long |
| 1..1 |
|
code_system_entity |
|
| 1..1 |
Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. |
currentVersionId |
Long |
| - |
Die aktuelle ID der code_system_entity_version |
id |
Long |
| 1..1 |
|
code_system_entity_version |
|
| 1..1 |
Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. |
codeSystemEntityId |
Long |
| - |
|
effectiveDate |
java.util.Date |
| - |
Zeitpunkt der letzten Änderung |
insertTimestamp |
java.util.Date |
| - |
Zeitstempel, wann der Eintrag eingefügt worden ist |
isLeaf |
Boolean |
| - |
Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. |
majorRevision |
Integer |
| 0..1 |
Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) |
minorRevision |
Integer |
| 0..1 |
Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) |
previousVersionId |
Long |
| - |
Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. |
status |
Integer |
| - |
Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. |
statusDate |
java.util.Date |
| - |
Änderungszeitpunkt des Status |
versionId |
Long |
| - |
|
association_type |
|
| 1..1 |
Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version. |
codeSystemEntityVersionId |
Long |
| - |
Entspricht der versionId von code_system_entity_version |
forwardName |
String |
50 |
1..1 |
Name der Beziehung in normaler Leserichtung (ID 1->2) |
reverseName |
String |
50 |
1..1 |
Name der Beziehung in umgekehrter Leserichtung (ID 2->1) |
property |
|
| 0..N |
|
currentVersionId |
Long |
| - |
|
id |
Long |
| - |
|
name |
String |
65535 |
0..1 |
|
property_version |
|
| 1..N |
|
codeSystemEntityVersionId |
Long |
| - |
|
content |
byte[] |
| 0..1 |
|
contentMimetype |
String |
50 |
0..1 |
|
contentName |
String |
255 |
0..1 |
|
contentSize |
Integer |
| 0..1 |
|
description |
String |
65535 |
0..1 |
|
insertTimestamp |
java.util.Date |
| - |
|
languageId |
Long |
| 0..1 |
|
name |
String |
65535 |
1..1 |
|
previousVersionId |
Long |
| - |
|
propertyId |
Long |
| - |
|
propertyKindId |
Long |
| 0..1 |
|
status |
Integer |
| 0..1 |
|
statusDate |
java.util.Date |
| - |
|
versionId |
Long |
| - |
|
Parameter |
Typ |
Länge |
Kardinalität |
Beschreibung |
ReturnType |
|
| 1..1 |
Entählt Informationen über die Antwort. |
count |
Integer |
| - |
Anzahl der Ergebnisse |
message |
String |
|
1..1 |
Status- oder Fehlermeldung |
overallErrorCategory |
|
| 1..1 |
INFO, WARN, ERROR |
status |
|
| 1..1 |
OK, FAILURE |
code_system_entity |
|
| 1..1 |
Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. |
currentVersionId |
Long |
| 1..1 |
Die aktuelle ID der code_system_entity_version |
id |
Long |
| 1..1 |
|
code_system_entity_version |
|
| 1..1 |
Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. |
codeSystemEntityId |
Long |
| - |
|
effectiveDate |
java.util.Date |
| - |
Zeitpunkt der letzten Änderung |
insertTimestamp |
java.util.Date |
| - |
Zeitstempel, wann der Eintrag eingefügt worden ist |
isLeaf |
Boolean |
| - |
Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. |
majorRevision |
Integer |
| - |
Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) |
minorRevision |
Integer |
| - |
Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) |
previousVersionId |
Long |
| - |
Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. |
status |
Integer |
| - |
Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. |
statusDate |
java.util.Date |
| - |
Änderungszeitpunkt des Status |
versionId |
Long |
| 1..1 |
|