Terminologieserver - Authoring - RemoveTerminologyOrConcept
Aus Termserver-CTS2
Version vom 30. September 2014, 12:20 Uhr von Muetzner (Diskussion | Beiträge)
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Removes a terminology, value set or a single concept.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | deleteInfo | DeleteInfo | 1..1 | Specifies the object which should be deleted. | |
| 2 | type | 1..1 | { CODE_SYSTEM, CODE_SYSTEM_VERSION, VALUE_SET, VALUE_SET_VERSION, CODE_SYSTEM_ENTITY_VERSION} | ||
| 2 | codeSystem | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 3 | codeSystemType | String | 30 | - | Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6 |
| 3 | currentVersionId | Long | - | Version of the Code System | |
| 3 | description | String | 65535 | - | Narrative description of Code System |
| 3 | descriptionEng | String | 65535 | - | English description of code system |
| 3 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| 3 | insertTimestamp | java.util.Date | - | Timestamp, when the Code System was inserted | |
| 3 | name | String | 100 | - | Name of the Code System. The precise name should be specified in the Code System Version. |
| 3 | website | String | 65535 | - | url to the code system if available |
| 3 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
| 4 | codeSystemId | Long | - | ||
| 4 | description | String | 65535 | - | Description of the Code System |
| 4 | expirationDate | java.util.Date | - | Point of time the Code System looses its validity. | |
| 4 | insertTimestamp | java.util.Date | - | Point of time when the Code System Version was inserted. | |
| 4 | lastChangeDate | java.util.Date | - | Date the code system was last changed. | |
| 4 | licenceHolder | String | 65535 | - | Owner of the licence. |
| 4 | name | String | 100 | - | Complete Name of the Code System. |
| 4 | oid | String | 100 | - | Official OID |
| 4 | preferredLanguageCd | String | 30 | - | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 4 | previousVersionID | Long | - | Refers to the prior version, if there are more than one. | |
| 4 | releaseDate | java.util.Date | - | Point of time, when this version starts to be valid. | |
| 4 | source | String | 65535 | - | Source of the Code System Version |
| 4 | status | Integer | - | Status of the current entry. Can be taken from a domain. | |
| 4 | statusDate | java.util.Date | - | Point of time of the last change of the status | |
| 4 | underLicence | Boolean | - | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| 4 | validityRange | String | 30 | - | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| 4 | versionId | Long | 1..1 | ||
| 2 | codeSystemEntityVersion | code_system_entity_version | 0..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | codeSystemEntityId | Long | - | Foreign key to code system entities ID | |
| 3 | effectiveDate | java.util.Date | - | Last change date of the entity version. | |
| 3 | insertTimestamp | java.util.Date | - | Point in time when entry was inserted. | |
| 3 | isLeaf | Boolean | - | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
| 3 | majorRevision | Integer | - | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| 3 | minorRevision | Integer | - | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| 3 | previousVersionId | Long | - | Refers to the prior version, if there are more than one version. | |
| 3 | statusDeactivated | Integer | - | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
| 3 | statusDeactivatedDate | java.util.Date | - | Date when statusDeactivated changed | |
| 3 | statusVisibility | Integer | - | Status of the current entry. Can be taken from a domain. | |
| 3 | statusVisibilityDate | java.util.Date | - | Point of time of the last change of the status. | |
| 3 | statusWorkflow | Integer | - | A workflow status, can be unique for each codesystem. | |
| 3 | statusWorkflowDate | java.util.Date | - | Date when statusWorkflow changed | |
| 3 | versionId | Long | 1..1 | The ID of this entry. | |
| 2 | valueSet | value_set | 0..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 3 | currentVersionId | Long | - | Points to the current version of the valueset. | |
| 3 | description | String | 65535 | - | Description of the valueset. |
| 3 | descriptionEng | String | 65535 | - | |
| 3 | id | Long | 1..1 | ID of the valueset. | |
| 3 | name | String | 50 | - | Name of the valueset. |
| 3 | status | Integer | - | Status of the current entry. Can be found in a domain. | |
| 3 | statusDate | java.util.Date | - | Alteration time of the status. | |
| 3 | website | String | 65535 | - | |
| 3 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 4 | insertTimestamp | java.util.Date | - | Timestamp of the insertion of the valueset version. | |
| 4 | lastChangeDate | java.util.Date | - | ||
| 4 | name | String | - | ||
| 4 | oid | String | - | ||
| 4 | preferredLanguageCd | String | 30 | - | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 4 | previousVersionId | Long | - | Points to the previous version. | |
| 4 | releaseDate | java.util.Date | - | Start date for the validity of the valueset version. | |
| 4 | status | Integer | - | The status of the current entry. Can be found in a domain. | |
| 4 | statusDate | java.util.Date | - | Alteration time of the status. | |
| 4 | validityRange | Long | - | Validity range (German: Gültigkeitsbereich) | |
| 4 | valueSetId | Long | - | Foreign key to the ID of the valueset. | |
| 4 | versionId | Long | 1..1 | Version ID of the value set | |
| 1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | count | Integer | 1..1 | number of results | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE |
Beispiele
SOAP
Delete a complete codesystem with all versions
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:RemoveTerminologyOrConcept> <parameter> <deleteInfo> <codeSystem> <id>139</id> </codeSystem> <type>CODE_SYSTEM</type> </deleteInfo> <loginToken>97a9b711-91f7-4c0b-adab-f8d7f7a32e2c</loginToken> </parameter> </aut:RemoveTerminologyOrConcept> </soapenv:Body> </soapenv:Envelope>
Delete a value set with all versions
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:RemoveTerminologyOrConcept> <parameter> <deleteInfo> <type>VALUE_SET</type> <valueSet> <id>5</id> </valueSet> </deleteInfo> <loginToken>583c602b-780d-4bc6-896d-fdce493e6317</loginToken> </parameter> </aut:RemoveTerminologyOrConcept> </soapenv:Body> </soapenv:Envelope>
