Qodex.ai

This endpoint is for searching the foundation component of the ICD-11. The search can be customized using the parameters as described. Search endpoint accepts both GET and POST requests. If the size of the request is too large, you may need to use POST

a

POST {{baseUrl}}/icd/entity/search?q=sed velit minim dolore&subtreesFilter=eu&chapterFilter=veniam laboris&useFlexisearch=false&flatResults=true&propertiesToBeSearched=aliqua deserunt ad sint Lorem&releaseId=ut amet aliquip nostrud

Request Params

KeyDatatypeRequiredDescription
qstringText to be searched. Having the character % at the end will be regarded as a wild card for that word
subtreesFilterstringOptional parameter. Comma separated list of URIs. If provided, the search will be performed on the entities provided and their descendants
chapterFilterstringOptional, comma or semicolon separated list of chapter codes eg:01;02;21 When provided, the search will be performed only on these chapters
useFlexisearchbooleanChanges the search mode to flexible search.
        - In the regular search mode, the Coding Tool will only give you results that contain all of the words that you've used in your search. It accepts different variants or 
        synonyms of the words but essentially it searches for a result that contains all components of your search. Whereas in flexible search mode, the results do not have to 
        contain all of the words that are typed. It would still try to find the best matching phrase but there may be words in your search that are not matched at all
        - It is recommended to use flexible search only when regular search does not provide a result |

| flatResults | boolean | | Optional parameter. Default value false. If set to true the search result entities are provided in a nested data structure representing the ICD-11 hierarchy. Otherwise they are listed as flat list of matches | | propertiesToBeSearched | string | | Optional. When not provided, the search is performed on the title, synonym and narrowerTerm properties of the entity. | | releaseId | string | | This is an optional parameter and if ignored, the API will return values from the latest released version of the Foundation. If provided, the API will respond using that particular release. The values are like 2019-04 |

HEADERS

KeyDatatypeRequiredDescription
API-Versionstring(Required) Version of the API. Values are like v1,v2.
For example, if you provide value v2, the API will respond in the format of the version 2 of the API
Accept-Languagestring(Required) ICD-API is multi-lingual. By changing this header, you may make the API respond in different languages
Languages will be available as the translations of ICD-11 completes.
The values are language codes such as en, es, zh, etc.

RESPONSES

status: OK

{"destinationEntities":[{"id":"http://id.who.int/icd/entity/279489890","title":"Sequelae of \u003cem class='found'\u003erespiratory\u003c/em\u003e or unspecified \u003cem class='found'\u003etuberculosis\u003c/em\u003e","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":0.011675735,"titleIsASearchResult":true,"titleIsTopScore":true,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/279489890","isLeaf":true,"matchingPVs":[{"propertyId":"Synonym","label":"Late effect of \u003cem class='found'\u003erespiratory\u003c/em\u003e or unspecified \u003cem class='found'\u003etuberculosis\u003c/em\u003e","score":9.121668e-05,"important":false}]},{"id":"http://id.who.int/icd/entity/882244568","title":"\u003cem class='found'\u003eTuberculosis\u003c/em\u003e of the \u003cem class='found'\u003erespiratory\u003c/em\u003e system","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":0.46675602,"titleIsASearchResult":true,"titleIsTopScore":false,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/882244568","isLeaf":false,"matchingPVs":[{"propertyId":"Synonym","label":"\u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e","score":0.46675602,"important":true},{"propertyId":"Synonym","label":"\u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e NOS","score":0.46675602,"important":false},{"propertyId":"Synonym","label":"\u003cem class='found'\u003etuberculosis\u003c/em\u003e of \u003cem class='found'\u003erespiratory\u003c/em\u003e tract","score":0.011675735,"important":false}]},{"id":"http://id.who.int/icd/entity/1311939281","title":"\u003cem class='found'\u003eRespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e, not confirmed","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":9.121668e-05,"titleIsASearchResult":true,"titleIsTopScore":true,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/1311939281","isLeaf":false,"matchingPVs":[]},{"id":"http://id.who.int/icd/entity/60063379","title":"Primary \u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e without mention of bacteriological or histological confirmation","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":0.011675735,"titleIsASearchResult":true,"titleIsTopScore":false,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/60063379","isLeaf":false,"matchingPVs":[{"propertyId":"Synonym","label":"primary \u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e","score":0.011675735,"important":false},{"propertyId":"Synonym","label":"Primary \u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e NOS","score":0.011675735,"important":false}]},{"id":"http://id.who.int/icd/entity/983550510","title":"\u003cem class='found'\u003eRespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e, confirmed","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":0.011675735,"titleIsASearchResult":true,"titleIsTopScore":true,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/983550510","isLeaf":false,"matchingPVs":[{"propertyId":"Synonym","label":"\u003cem class='found'\u003eRespiratory\u003c/em\u003e TB - [\u003cem class='found'\u003etuberculosis\u003c/em\u003e]","score":9.121668e-05,"important":false},{"propertyId":"Synonym","label":"\u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e, with bacteriological and histological confirmation","score":1.5595305e-07,"important":false}]},{"id":"http://id.who.int/icd/entity/34856621","title":"Primary \u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculosis\u003c/em\u003e, confirmed bacteriologically or histologically","propertiesTruncated":false,"isResidualOther":false,"isResidualUnspecified":false,"chapter":"01","theCode":null,"score":6.53069e-11,"titleIsASearchResult":true,"titleIsTopScore":true,"entityType":0,"important":false,"descendants":[],"stemId":"http://id.who.int/icd/entity/34856621","isLeaf":false,"matchingPVs":[{"propertyId":"Synonym","label":"primary \u003cem class='found'\u003erespiratory\u003c/em\u003e \u003cem class='found'\u003etuberculous\u003c/em\u003e with bacteriological and histological confirmation","score":6.53069e-11,"important":false}]}],"error":false,"errorMessage":null,"resultChopped":false,"wordSuggestionsChopped":false,"guessType":1,"uniqueSearchId":"fed465f5-6df2-4723-be8a-9a54b5b08e17","words":null}