WS-Beschreibung - Terminologieserver Search ListCodeSystems

Aus Termserver-CTS2
Wechseln zu: Navigation, Suche

Inhaltsverzeichnis

Functionality

Lists all code systems and their versions that match the given criteria. For details about criteria see request section.

Prerequisites

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system code_system 0..1 If a code system is listed, the information is used as a filter
description String 65535 0..1 Narrative description of Code System
insertTimestamp java.util.Date 0..1 Timestamp, wenn the Code System was inserted
name String 100 0..1 Name of the Code System. The precise name should be specified in the Code System Version.
code_system_version code_system_version 0..1 Version of a Code System
description String 65535 0..1 Description of the Code System
expirationDate java.util.Date 0..1 Point of time the Code System looses its validity.
insertTimestamp java.util.Date 0..1 Point of time when the Code System Version was inserted.
licenceHolder String 65535 0..1 Owner of the licence.
name String 100 0..1 Complete Name of the Code System.
oid String 100 0..1 Official OID
preferredLanguageId Long 0..1 Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)
releaseDate java.util.Date 0..1 Point of time, when this version starts to be valid.
source String 65535 0..1 Source of the Code System Version
status Integer 0..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 0..1 Point of time of the last change of the status
underLicence Boolean 0..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
validityRange String 30 0..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
count Integer 1..1 number of results
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system code_system 0..N Name of codesystem. Each codesystem requires at least one version.
currentVersionId Long 1..1 Version of the Code System
id Long 1..1 Internal ID = Primary Key of Code System
insertTimestamp java.util.Date 1..1 Timestamp, wenn the Code System was inserted
name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.
code_system_version code_system_version 1..1 Version of a Code System
insertTimestamp java.util.Date 1..1 Point of time when the Code System Version was inserted.
name String 100 1..1 Complete Name of the Code System.
previousVersionID Long 1..1 Refers to the prior version, if there are more than one.
underLicence Boolean 1..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
validityRange String 30 1..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
versionId Long 1..1

Annotations

Noteworthiness

Hints

Examples

SOAP messages

Simple Search w/o filters

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Search for code systems with specific properties (here: code system versions name has to contain ICD)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>ICD</name>
               </codeSystemVersions>
            </codeSystem>
         </parameter>
      </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Code example

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge