Terminologieserver - Authoring - MaintainCodeSystemVersion
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Create a new code system version or edit an existing one.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. | |
| 1 | versioning | VersioningType | 1..1 | Versioning information | |
| 2 | createNewVersion | Boolean | 1..1 | true if a new version should be created | |
| 2 | majorUpdate | Boolean | 0..1 | true if major version should count up | |
| 2 | minorUpdate | Boolean | 0..1 | true if minor version should count up | |
| 1 | codeSystem | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | description | String | 65535 | 0..1 | Narrative description of Code System |
| 2 | id | Long | 0..1 | If the name of the Vokabulsars should be changed, the Id must be given. | |
| 2 | name | String | 100 | 0..1 | see Id |
| 2 | codeSystemVersion | code_system_version | - | Version of a Code System | |
| 3 | description | String | 65535 | 0..1 | Description of the Code System |
| 3 | expirationDate | java.util.Date | 0..1 | Point of time the Code System looses its validity. | |
| 3 | licenceHolder | String | 65535 | 0..1 | Owner of the licence. |
| 3 | name | String | 100 | 1..1 | It must not be listed, if an existing version is worked on. |
| 3 | oid | String | 100 | 0..1 | Official OID |
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Point of time, when this version starts to be valid. | |
| 3 | source | String | 65535 | 0..1 | Source of the Code System Version |
| 3 | underLicence | Boolean | 0..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| 3 | validityRange | String | 30 | 0..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| 3 | versionId | Long | 1..1 |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE |
Beispiele
SOAP
Simple sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:MaintainCodeSystemVersion> <parameter> <codeSystem> <codeSystemVersions> <versionId>1</versionId> <name>Name der neuen Version</name> </codeSystemVersions> <id>1</id> </codeSystem> <versioning> <createNewVersion>1</createNewVersion> </versioning> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:MaintainCodeSystemVersion> </soapenv:Body> </soapenv:Envelope>
