WS-Beschreibung - Terminologieserver Search ReturnConceptDetails
Aus Termserver-CTS2
Version vom 8. Juli 2013, 07:33 Uhr von Becker (Diskussion | Beiträge)
Inhaltsverzeichnis |
Funktionalität
Listet alle Eigenschaften eines bestimmten Konzeptes zurück. Für Details siehe Request/Response-Abschnitt.
Vorbedingungen
Request/Response
Request
| 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_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 | - | ||
| 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 |
Response
| 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..N | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | ||
| codeSystemEntityId | Long | - | ||
| effectiveDate | java.util.Date | 1..1 | Zeitpunkt der letzten Änderung | |
| insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann der Eintrag eingefügt worden ist | |
| isLeaf | Boolean | 1..1 | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
| majorRevision | Integer | 1..1 | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| minorRevision | Integer | 1..1 | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| previousVersionId | Long | 1..1 | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| versionId | Long | 1..1 | ||
| code_system_concept | 1..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | ||
| code | String | 100 | 1..1 | |
| codeSystemEntityVersionId | Long | - | ||
| isPreferred | Boolean | 1..1 | ||
| term | String | 65535 | 1..1 | |
| termAbbrevation | String | 50 | 1..1 | |
| code_system_concept_translation | 0..N | Übersetzung eines Begriffs. | ||
| codeSystemEntityVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| languageId | Long | 1..1 | ||
| term | String | 65535 | 1..1 | |
| termAbbrevation | String | 50 | 1..1 | |
| code_system_metadata_value | 0..N | Ausprägung von Metadaten | ||
| codeSystemEntityVersionId | Long | - | Gibt an, zu welchem Entity dieser Eintrag gehört | |
| id | Long | 1..1 | ||
| metadataParameterId | Long | - | Gibt an, auf welches Metadata sich der Wert bezieht | |
| parameterValue | String | 65535 | 1..1 | Werte von Metadaten |
| metadata_parameter | 1..1 | Umfasst Sammlung von Metadaten (Liste der verfügbaren Bezeichnungen) | ||
| id | Long | 1..1 | ||
| paramDatatype | String | 65535 | 1..1 | Datentyp des Wertes, der in code_system_metadata_value steht. |
| paramName | String | 65535 | 1..1 | Bezeichnung von Metadaten (z.B. Einheit) |
| property | 0..N | |||
| currentVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| name | String | 65535 | - | |
| property_version | 1..N | |||
| codeSystemEntityVersionId | Long | - | ||
| 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 | ||
| propertyId | Long | - | ||
| propertyKindId | Long | 1..1 | ||
| status | Integer | 1..1 | ||
| statusDate | java.util.Date | 1..1 | ||
| versionId | Long | 1..1 | ||
| code_system_version_entity_membership | 1..N | Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her. | ||
| codeSystemEntityId | Long | - | ||
| codeSystemVersionId | Long | 1..1 | ||
| isAxis | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist | |
| isMainClass | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist |
Anmerkungen
Besonderheiten
Hinweise
Die Ergebnismenge ist klein.
Beispiele
SOAP-Nachrichten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ReturnConceptDetails> <parameter> <codeSystemEntity> <id>2114</id> <codeSystemEntityVersions> <versionId>2114</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </sear:ReturnConceptDetails> </soapenv:Body> </soapenv:Envelope>
