Terminologieserver - Authoring - CreateValueSetContent
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Links one or more existing concepts with the specified value set version.
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 | codeSystemEntity | code_system_entity | 1..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | versionId | Long | 1..1 | The ID of this entry. | |
| 3 | conceptValueSetMembership | concept_value_set_membership | 0..1 | Connects a valueset to an entity. | |
| 4 | description | String | 65535 | 0..1 | |
| 4 | hints | String | 65535 | 0..1 | |
| 4 | isStructureEntry | Boolean | 0..1 | ||
| 4 | meaning | String | 65535 | 0..1 | |
| 4 | orderNr | Long | 0..1 | ||
| 4 | valueOverride | String | 100 | 0..1 | If stated this value overrides the 'code' from code_system_concept of the belonging entity. |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
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
Create value set content with given entity version ids
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateValueSetContent> <parameter> <codeSystemEntity> <id>17</id> <codeSystemEntityVersions> <versionId>17</versionId> </codeSystemEntityVersions> </codeSystemEntity> <valueSet> <id>1</id> <valueSetVersions> <versionId>1</versionId> </valueSetVersions> </valueSet> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:CreateValueSetContent> </soapenv:Body> </soapenv:Envelope>
