Access the World Health Organization’s (WHO) International Classification of Diseases (ICD) API. This allows you to use ICD-10 and ICD-11 codes, encode text directly into ICD-11, search for diseases in ICD-10, and detect underlying causes of death using the DORIS system.
You can install the development version of WHOicd using the remotes
package:
#install.packages("remotes")
remotes::install_github("RodrigoZepeda/WHOicd")For the examples we’ll assume you already have a CLIENT_ID and
CLIENT_SECRET for the WHO API as obtained in the Generaring your
token article.
To interact with the API you’ll need to continuously create a token
using the get_token function:
library(WHOicd)
#Substitute CLIENT_ID and CLIENT_SECRET by your credentials
token <- get_token(CLIENT_ID, CLIENT_SECRET)Note These tokens last for 1 hour and once the hour passes you’ll need to generate a new token. The package will try to auto-generate one for you.
There are three main objectives for this package:
- Use of the DORIS system to obtain underlying cause of death from death certificate information.
- Use of ICD-11 to codify causes of death.
- Use of ICD-10 to search for causes of death.
The Digital Open Rule Integrated Cause of Death
Selection, DORIS, provides a framework
for obtaining the underlying cause of death from a death certificate.
DORIS functionality has been implemented in the doris() function.
The following example considers a 60 year old female whose primary cause
of death was 2D42: Malignant neoplasms of ill-defined sites due to
2E03: Malignant neoplasm metastasis in bone or bone marrow due to
CB41.0Z: Acute respiratory failure, unspecified.
doris(token, sex = "Female", age = iso_8601(years = 60), cause_of_death_code_a = "2D42",
cause_of_death_code_b = "2E03", cause_of_death_code_c = "CB41.0Z")
#> $`Underlying cause of death (UCOD)`
#> [1] "2D42"
#>
#> $`UCOD URI`
#> [1] "http://id.who.int/icd/entity/2023965817"
#>
#> $`UCOD with postcoordinated information (if available)`
#> [1] "2D42"
#>
#> $`UCOD postcoordinated URI`
#> [1] "http://id.who.int/icd/release/11/mms/2023965817"
#>
#> $`Detailed explanation (report)`
#> [1] "SP4: 2E03 is the starting point of the first-mentioned sequence (2D42 due to 2E03), which is selected as the tentative starting point (TSP).\nM1: There is a special instruction on 2E03 reported with mention of 2D42.\nM1: 2D42 is selected as the TUC.\nM3: The tentative underlying cause is not the same as the starting point selected in Steps SP1 to SP8. Repeat steps SP6, M1 and M2.\n\n\nFull report:\nSP1: is not applicable.\nSP2: is not applicable.\nSP3: is not applicable.\nSP4: 2E03 is the starting point of the first-mentioned sequence (2D42 due to 2E03), which is selected as the tentative starting point (TSP).\nSP6: is not applicable.\nSP7: is not applicable.\nSP8: is not applicable.\nM1: There is a special instruction on 2E03 reported with mention of 2D42.\nM1: 2D42 is selected as the TUC.\nM1: There is no special instruction applicable with TUC 2D42.\nM2: is not applicable.\nM3: The tentative underlying cause is not the same as the starting point selected in Steps SP1 to SP8. Repeat steps SP6, M1 and M2.\nSP6: is not applicable.\nSP7: is not applicable.\nSP8: is not applicable.\nM1: There is no special instruction applicable with TUC 2D42.\nM2: is not applicable.\n"
#>
#> $reject
#> [1] FALSE
#>
#> $error
#> NULL
#>
#> $warning
#> NULLAll of the options are available in the function’s help page
doris().
The main functions relating to ICD-11 are icd11_search() and
icd11_autocode(). The first one allows you to search for a specific
diagnosis using keywords inside ICD-11 either in the Mortality and
Morbidity Statistics (MMS) or in the International Classification of
Functioning, Disability and Health (ICF).
The following example searches for any coding related to Dementia related to HIV stage 4
#Look for Dementia and HIV stage 4
search_results <- icd11_search(token, "Dementia HIV stage 4")
#Recover all of the titles matched
search_results |> retrieve("title")
#> [1] "Dementia due to human immunodeficiency virus [HIV disease clinical stage 4 associated with tuberculosis, unspecified]"
#> [2] "Dementia due to human immunodeficiency virus [Other specified HIV disease clinical stage 4 associated with tuberculosis]"
#> [3] "Dementia due to human immunodeficiency virus [HIV disease clinical stage 4 associated with malaria, unspecified]"
#> [4] "Dementia due to human immunodeficiency virus [Other specified HIV disease clinical stage 4 associated with malaria]"
#> [5] "Dementia due to human immunodeficiency virus [HIV disease clinical stage 4 without mention of tuberculosis or malaria, unspecified]"
#> [6] "Dementia due to human immunodeficiency virus [Other specified HIV disease clinical stage 4 without mention of tuberculosis or malaria]"Another function of importance is autocode which reads plain-text
diagnostic text and returns the best matching code either in MMS or
ICF
#Auto code a diagnostic text such as `cerebrovascular accident`
code_results <- icd11_autocode(token, "Patient with cerebrovascular accident")
#Recover the code that matched
code_results |> retrieve("theCode")
#> [1] "8B20"Additional information on ICD-11 can be found in the ICD-11 article
The main function relating to ICD-10 is icd10_search() which searches
for the titles and parents of codes, blocks of chapters. As an example,
we can search for the following vector and obtain a data.frame:
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_search(token, codes)#> # A tibble: 3 × 7
#> searched code code_title block block_title chapter chapter_title
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 D60 D60 Acquired pure red cell… D60-… Aplastic a… III Diseases of …
#> 2 IX <NA> <NA> <NA> <NA> IX Diseases of …
#> 3 I10-I15 <NA> <NA> I10-… Hypertensi… IX Diseases of …
If you only want to get the title of the current code/chapter/block you
can use icd10_title which is faster as it requires less requests to
the API:
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_title(token, codes)#> # A tibble: 3 × 2
#> searched title
#> <chr> <chr>
#> 1 D60 Acquired pure red cell aplasia [erythroblastopenia]
#> 2 IX Diseases of the circulatory system
#> 3 I10-I15 Hypertensive diseases
Additional information on ICD-10 can be found in the ICD-10 article
This is not an official product of the WHO. However we are happy to provide support if you raise an issue.