Version vom 8. August 2013, 09:19 Uhr

Funktionality

Imports a whole code system. There are two import formats available: ClaML and CSV.
You have to specify a code system for each import. All new concepts will be added to that code system.

Prerequisites

Requires Login.

Request/Response

Request

Response

Examples

SOAP messages

Simple domain

Complex domain

Code example

Java

Annotations

Noteworthiness

CSV-Import
The comma separated file has to be build in this pattern:

• Syntax
  • Coding: ISO-8859-1
  • Fields will be separated by a ";"
  • Strings has to be encapsulated with " ", if there are any special or delimiter symbols
  • First row contains informations about columns
• Fields
  • legal values
    • code (either code or term are required)
    • term (either code or term are required)
    • term_abbrevation
    • description
    • is_axis (1/0 or true/false, standard: 0)
    • is_mainclass (1/0 or true/false, standard: 0)
    • is_preferred (1/0 or true/false, standard: 1)
    • relation (Code, a association will be build up to)
      • association_kind (1=ontological, 2=taxonomic, 3=cross mapping; standard: 2)
      • association_type (Association description, string, e.g. 'is subclass of', required if 'relation' is set)
      • association_type_reverse (Association description reversed, string, e.g. 'is upper class of', required if 'relation' is set)
    • translation_XX (XX represents the ID of the language, that can be determined by the domains)
    • metadata_XX (XX represents the names of metadata, that will be created automatically)

*italic Entries are optional If no code is given, term will be used as code (cut to a maximum length of 100 characters)

Hints

Examples

Files

The following file shows a example of a csv import of a small code system with associations:CSV-Import_Beispiel

Example file (CSV) with some translations can be found here: Geschlechtercodes CSV

SOAP messages

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <adm:ImportCodeSystem>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>Administrative sex (HL7)</name>
                  <underLicence>0</underLicence>
               </codeSystemVersions>
               <name>Administrative sex (HL7)</name>
            </codeSystem>
            <importInfos>
            <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in Soap-UI (context menu) -->
               <formatId>194</formatId>
            </importInfos>
            <login>
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- insert Session-ID from login -->
            </login>
         </parameter>
      </adm:ImportCodeSystem>
   </soapenv:Body>
 </soapenv:Envelope>