Terminologieserver - Administration - ImportValueSet

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 66: Zeile 66:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the current version of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 92: Zeile 99:
 
   <td>Name of the valueset.
 
   <td>Name of the valueset.
 
They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.</td>
 
They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 99: Zeile 120:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp of the insertion of the valueset version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 106: Zeile 134:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 115: Zeile 151:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the previous version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 122: Zeile 165:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Start date for the validity of the valueset version.</td>
 
   <td>Start date for the validity of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Version ID of the value set</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 177: Zeile 255:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 184: Zeile 277:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>ID of the valueset.</td>
 
   <td>ID of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 191: Zeile 306:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp of the insertion of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the previous version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Start date for the validity of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 30. September 2014, 12:19 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Imports a value set from existing concepts from code systems.

You must specify an existing value set. If a valueset version-id is given, this is used. Specify a version name to create a new valueset version.

Valueset-CSV-Felder:

  • code (code from given codesystem-version by oid or version-id)</li>
  • codesystem_oid (either oid or version-id must be given)</li>
  • codesystem_version_id (either oid or version-id must be given)</li>
  • value_override</li>
  • hints</li>
  • description</li>
  • meaning</li> italic fields are optional

    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 importInfos ImportType 1..1 Parameter for import
    2 filecontent byte[] 1..1 The file content as a blob. CSV files have to be encoded with ISO-8859-1.
    2 formatId Long 1..1 The content of the file.

    CSV: 1

    SVS: 2
    1 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
    2 currentVersionId Long - Points to the current version of the valueset.
    2 description String 65535 0..1 Description of the valueset. This field is only required if you create a new Value set.
    2 id Long 0..1 ID of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.
    2 name String 50 0..1 Name of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set.
    2 status Integer - Status of the current entry. Can be found in a domain.
    2 statusDate java.util.Date - Alteration time of the status.
    2 valueSetVersion value_set_version 1..1 Represents the version of an valueset.
    3 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
    3 name String 0..1
    3 oid String -
    3 preferredLanguageCd String 30 0..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
    3 previousVersionId Long - Points to the previous version.
    3 releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
    3 status Integer - The status of the current entry. Can be found in a domain.
    3 statusDate java.util.Date - Alteration time of the status.
    3 validityRange Long - Validity range (German: Gültigkeitsbereich)
    3 valueSetId Long - Foreign key to the ID of the valueset.
    3 versionId Long - 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
    1 valueSet value_set 0..1 A subset of terms.Every valueset has at least one valueset-version.
    2 currentVersionId Long - Points to the current version of the valueset.
    2 description String 65535 - Description of the valueset.
    2 id Long 1..1 ID of the valueset.
    2 name String 50 - Name of the valueset.
    2 status Integer - Status of the current entry. Can be found in a domain.
    2 statusDate java.util.Date - Alteration time of the status.
    2 valueSetVersion value_set_version 1..1 Represents the version of an valueset.
    3 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
    3 name String -
    3 oid String -
    3 preferredLanguageCd String 30 - Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
    3 previousVersionId Long - Points to the previous version.
    3 releaseDate java.util.Date - Start date for the validity of the valueset version.
    3 status Integer - The status of the current entry. Can be found in a domain.
    3 statusDate java.util.Date - Alteration time of the status.
    3 validityRange Long - Validity range (German: Gültigkeitsbereich)
    3 valueSetId Long - Foreign key to the ID of the valueset.
    3 versionId Long 1..1 Version ID of the value set



    zurück zur Webservice-Übersicht

    Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_Administration_-_ImportValueSet“
    • Meine Werkzeuge
    Namensräume
    Varianten
    Aktionen
    Navigation
    Werkzeuge