Release Notes for ICD API version 2.5

Compatibility

Version 2.5 is fully compatible with earlier 2.x versions. Your code written for version 2.x does not need to change

More language support

Kazakh, Slovak, Swedish and Latin1 translations are addded.

Deprecated Terms support

The classification contains deprecated terms in some entities. These terms are not shown in the browser or in any other tool. However, if a user searches using the ICD-API and other tools that are using the ICD-API such as the Coding Tool can find them. When an entity is requested using the API, the response contains all terms (title, sysnonyms, etc.). What is new in this release is that the deprecated terms now contain "deprecated": true flag in the response as in the example below

...

 "title": {
    "@language": "en",
    "@value": "Septicaemia"
  },
  "synonym": [
    {
      "label": {
        "@language": "en",
        "@value": "group d streptococcal septicaemia (deprecated)"
      },
      "deprecated": true
    },
...

Describe endpoint

This endpoint provides information on a given code, uri or combination of them. For postcoordinated code combinations, it provides more information on the code combination such as which axes are used and what values do they have. The uri parameter accepts both foundation or linearization URIs.

This endpoint is helpful mainly for the following use cases:

  • You have a code string and you'd like to understand which axes are provided with which values (see the example below)
  • You have foundation URI (e.g. coming from a mapping table) and you'd like to get an MMS code or code combination for the URI.

This endpoint has some similarities with the codeinfo and lookup endpoints but it is more powerfull than both. codeinfo as it can provide detailed information of the nested code strings. The URI support is much better than the lookup endpoint as it can handle URI combinations.

You may find below an example response for a request made with code string 1G40/1B10.0&XY9Q


{
  "code": "1G40/1B10.0&XY9Q",
  "linearizationUri": "http://id.who.int/icd/release/11/beta/mms/622600769 / http://id.who.int/icd/release/11/beta/mms/983550510 & http://id.who.int/icd/release/11/beta/mms/288778990",
  "foundationUri": "http://id.who.int/icd/entity/622600769 / http://id.who.int/icd/entity/983550510 & http://id.who.int/icd/entity/288778990",
  "label": "Sepsis without septic shock [Respiratory tuberculosis, confirmed] [Diagnosis confirmed by histology]",
  "stemCode": "1G40",
  "stemLinearizationUri": "http://id.who.int/icd/release/11/beta/mms/622600769",
  "stemFoundationUri": "http://id.who.int/icd/entity/622600769",
  "stemLabel": "Sepsis without septic shock",
  "postcoordinationValues": [
    {
      "axisName": "hasCausingCondition",
      "values": [
        {
          "code": "1B10.0&XY9Q",
          "linearizationUri": "http://id.who.int/icd/release/11/beta/mms/983550510 & http://id.who.int/icd/release/11/beta/mms/288778990",
          "foundationUri": "http://id.who.int/icd/entity/983550510 & http://id.who.int/icd/entity/288778990",
          "label": "Respiratory tuberculosis, confirmed [Diagnosis confirmed by histology]",
          "stemCode": "1B10.0",
          "stemLinearizationUri": "http://id.who.int/icd/release/11/beta/mms/983550510",
          "stemFoundationUri": "http://id.who.int/icd/entity/983550510",
          "stemLabel": "Respiratory tuberculosis, confirmed",
          "postcoordinationValues": [
            {
              "axisName": "diagnosisConfirmedBy",
              "values": [
                {
                  "code": "XY9Q",
                  "linearizationUri": "http://id.who.int/icd/release/11/beta/mms/288778990",
                  "foundationUri": "http://id.who.int/icd/entity/288778990",
                  "label": "Diagnosis confirmed by histology"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

DORIS (Underlying cause of death detection)

An updated version of the DORIS system is included in the API. This functionality is no longer a pre-release. More information on the DORIS support

FHIR support

ICD-API FHIR implementation adds FHIR support for those software that needs to access the classification using FHIR.

You may find more information at the ICD-API FHIR Support page

IMPORTANT: FHIR support is in pre-release state. There may be errors in the results and the API parameters and behaviour may change in the next releases


  1. Latin version only contains the titles in the classification