Terminologieserver - Search - ListGloballySearchedConcepts
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Search for codes in all codesystems and valuesets.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 0..1 | Login-Token that ensures the user is logged in. | |
| 1 | codeSystemConcept | code_system_concept | 1..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
| 2 | code | String | 100 | 0..1 | Code of a concept or term. |
| 2 | isPreferred | Boolean | 0..1 | Specifies, if a term or concept is preferred or not. | |
| 2 | term | String | 65535 | 0..1 | The term itself |
| 2 | termAbbrevation | String | 50 | 0..1 | The abbrevation of the term. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | pagingInfos | PagingResultType | 0..1 | Will be returned automatically if result set is bigger than the limiting system value. Results will be cut to the limit size. | |
| 2 | maxPageSize | Integer | 1..1 | system limit for maximum number of entries per page | |
| 2 | pageIndex | Integer | 1..1 | current page (starts with 0) | |
| 2 | pageSize | Integer | 1..1 | number of results per page | |
| 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 | codeSystemEntity | code_system_entity | 0..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
| 2 | id | Long | 1..1 | ||
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | codeSystemEntityId | Long | 1..1 | Foreign key to code system entities ID | |
| 3 | effectiveDate | java.util.Date | 1..1 | Last change date of the entity version. | |
| 3 | insertTimestamp | java.util.Date | 1..1 | Point in time when entry was inserted. | |
| 3 | isLeaf | Boolean | 1..1 | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
| 3 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| 3 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| 3 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
| 3 | statusDeactivated | Integer | 1..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
| 3 | statusDeactivatedDate | java.util.Date | 1..1 | Date when statusDeactivated changed | |
| 3 | statusVisibility | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusVisibilityDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
| 3 | statusWorkflow | Integer | 1..1 | A workflow status, can be unique for each codesystem. | |
| 3 | statusWorkflowDate | java.util.Date | 1..1 | Date when statusWorkflow changed | |
| 3 | versionId | Long | 1..1 | The ID of this entry. | |
| 3 | codeSystemConcept | code_system_concept | 1..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
| 4 | code | String | 100 | 1..1 | Code of a concept or term. |
| 4 | codeSystemEntityVersionId | Long | 1..1 | ||
| 4 | description | String | 1..1 | Description of a term or concept | |
| 4 | isPreferred | Boolean | 1..1 | Specifies, if a term or concept is preferred or not. | |
| 4 | term | String | 65535 | 1..1 | The term itself |
| 4 | termAbbrevation | String | 50 | 1..1 | The abbrevation of the term. |
| 3 | conceptValueSetMembership | concept_value_set_membership | 0..N | Connects a valueset to an entity. | |
| 4 | description | String | 65535 | 1..1 | |
| 4 | hints | String | 65535 | 1..1 | |
| 4 | isStructureEntry | Boolean | 1..1 | ||
| 4 | meaning | String | 65535 | 1..1 | |
| 4 | orderNr | Long | 1..1 | ||
| 4 | status | Integer | 1..1 | ||
| 4 | statusDate | java.util.Date | 1..1 | ||
| 4 | valueOverride | String | 100 | 1..1 | If stated this value overrides the 'code' from code_system_concept of the belonging entity. |
| 4 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 5 | insertTimestamp | java.util.Date | 1..1 | Timestamp of the insertion of the valueset version. | |
| 5 | lastChangeDate | java.util.Date | 1..1 | ||
| 5 | name | String | 1..1 | ||
| 5 | oid | String | 1..1 | ||
| 5 | preferredLanguageCd | String | 30 | 1..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 5 | previousVersionId | Long | 1..1 | Points to the previous version. | |
| 5 | releaseDate | java.util.Date | 1..1 | Start date for the validity of the valueset version. | |
| 5 | status | Integer | 1..1 | The status of the current entry. Can be found in a domain. | |
| 5 | statusDate | java.util.Date | 1..1 | Alteration time of the status. | |
| 5 | validityRange | Long | 1..1 | Validity range (German: Gültigkeitsbereich) | |
| 5 | valueSetId | Long | 1..1 | Foreign key to the ID of the valueset. | |
| 5 | versionId | Long | 1..1 | Version ID of the value set | |
| 2 | codeSystemVersionEntityMembership | code_system_version_entity_membership | 1..1 | Connects the version of a Code System to the entities. | |
| 3 | codeSystemVersionId | Long | 1..1 | ||
| 3 | isAxis | Boolean | 1..1 | true, if the belonging entity of the entry is an axis of the code system | |
| 3 | isMainClass | Boolean | 1..1 | true, if the belonging entity of the entry is a root element of the code system. | |
| 3 | orderNr | Long | 1..1 | If used, concepts are ordered by the given numbers. |
Beispiele
SOAP
List concepts globally by term and code
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListGloballySearchedConcepts> <parameter> <codeSystemConcept> <term>Blut</term> <code>A0</code> </codeSystemConcept> </parameter> </sear:ListGloballySearchedConcepts> </soapenv:Body> </soapenv:Envelope>
