WHO In Product API

https://id.who.int/swagger/v2/
Admin
This project provides the 'WHO In Product' API, an identity management service for the World Health...
Tokens:29,324
Snippets:76
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Search Foundation Component

Source: https://id.who.int/swagger/v2/swagger

This endpoint is for searching the foundation component of the ICD-11. The search can be customized using various parameters. It accepts both GET and POST requests, with POST recommended for large requests due to HTTP GET size limitations.

```APIDOC
## GET /icd/entity/search

### Description
Searches the foundation component of the ICD-11 with customizable parameters. Supports GET and POST methods.

### Method
GET

### Endpoint
/icd/entity/search

### Parameters
#### Query Parameters
- **q** (string) - Required - Text to be searched. A trailing '%' acts as a wildcard.
- **subtreesFilter** (string) - Optional - Comma-separated list of URIs to filter search to entities and their descendants.
- **chapterFilter** (string) - Optional - Comma or semicolon-separated list of chapter codes (e.g., '01;02;21') to filter search to specific chapters.
- **useFlexisearch** (boolean) - Optional - Enables flexible search mode (default: false). Recommended when regular search yields no results.
- **flatResults** (boolean) - Optional - If true, results are nested according to ICD-11 hierarchy; otherwise, results are a flat list (default: true).
- **propertiesToBeSearched** (string) - Optional - Specifies properties to search (e.g., "Title", "Synonym"). Comma-separated for multiple properties. Defaults to "Title", "Synonyms", and "FullySpecifiedName".
- **releaseId** (string) - Optional - Specifies the release ID for the search.

### Response
#### Success Response (200)
- **schema** (FoundationEntity) - The schema for the foundation entity.

#### Error Response (401)
- **description** - Unauthorized

#### Error Response (404)
- **description** - Not Found
```

--------------------------------

### ICD-11 Foundation - Search Entities (GET)

Source: https://id.who.int/swagger/v2/swagger/index

Searches the foundation component of ICD-11. Supports customization via parameters. Use GET for smaller requests.

```APIDOC
## GET /icd/entity/search

### Description
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 as HTTP GET has a size limit of 2K.

### Method
GET

### Endpoint
/icd/entity/search

### Parameters
#### Query Parameters
(Details on query parameters would typically be listed here based on the OpenAPI spec, but are not fully provided in the input text.)
```

--------------------------------

### GET /icd/release/11/{linearizationname}

Source: https://id.who.int/swagger/v2/swagger/index

Returns basic information on the linearization such as MMS together with the list of available releases.

```APIDOC
## GET /icd/release/11/{linearizationname}

### Description
Returns basic information on the linearization such as MMS together with the list of available releases.

### Method
GET

### Endpoint
/icd/release/11/{linearizationname}

### Parameters
#### Path Parameters
- **linearizationname** (string) - Required - The name of the linearization.
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}/search

Source: https://id.who.int/swagger/v2/swagger/index

Searches the linearization (such as MMS). The search can be customized using the parameters. Accepts both GET and POST requests. If the size of the request is too large, POST may be necessary due to GET's 2K size limit.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}/search

### Description
Searches the linearization (such as MMS). The search can be customized using the parameters. Accepts both GET and POST requests. If the size of the request is too large, POST may be necessary due to GET's 2K size limit.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/search

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
#### Query Parameters
- **searchQuery** (string) - Required - The text to search for.
```

--------------------------------

### POST /icd/release/11/{releaseId}/{linearizationname}/search

Source: https://id.who.int/swagger/v2/swagger/index

Searches the linearization (such as MMS). The search can be customized using the parameters. Accepts both GET and POST requests. If the size of the request is too large, POST may be necessary due to GET's 2K size limit.

```APIDOC
## POST /icd/release/11/{releaseId}/{linearizationname}/search

### Description
Searches the linearization (such as MMS). The search can be customized using the parameters. Accepts both GET and POST requests. If the size of the request is too large, POST may be necessary due to GET's 2K size limit.

### Method
POST

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/search

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
#### Request Body
- **searchQuery** (string) - Required - The text to search for.
```

--------------------------------

### Get Linearization Releases

Source: https://id.who.int/swagger/v2/swagger

Retrieves basic information about a linearization, such as MMS, along with a list of available releases. Supports versioning and multi-lingual responses.

```APIDOC
## GET /icd/release/11/{linearizationname}

### Description
This endpoint returns basic information on the linearization such as MMS together with the list of available releases.

### Method
GET

### Endpoint
/icd/release/11/{linearizationname}

### Parameters
#### Path Parameters
- **linearizationname** (string) - Required - Short name for the linearization. e.g. mms for ICD Mortality and Morbidity Statistics

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Response
#### Success Response (200)
- **schema** (MultiVersion) - Description: Success

#### Error Responses
- **401** - Unauthorized
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}

Source: https://id.who.int/swagger/v2/swagger/index

Returns basic information on the released linearization (such as MMS) together with the chapters in it.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}

### Description
Returns basic information on the released linearization (such as MMS) together with the chapters in it.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
```

--------------------------------

### GET /websites/id_who_int_swagger_v2

Source: https://id.who.int/swagger/v2/swagger

Provides information on a given code, URI, or combination thereof. Supports detailed postcoordinated code combinations and offers simplification and flexible mode options.

```APIDOC
## GET /websites/id_who_int_swagger_v2

### Description
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 they have. If the input is a code string such as 1A00&XN62R, it should be provided at the code parameter. If the input is a URI string such as http://id.who.int/icd/... then it should be provided at the uri parameter. The uri parameter accepts both foundation or linearization URIs. During the process, if the postcoordination combination has an equivalent precoordinated entity, the system will return the information on the precoordinated entity.

### Method
GET

### Endpoint
/websites/id_who_int_swagger_v2/{linearizationname}/{releaseId}

### Parameters
#### Path Parameters
- **linearizationname** (string) - Required - Short name for the linearization. e.g. mms for ICD Mortality and Morbidity Statistics
- **releaseId** (string) - Required - The id for the release. This is generally formatted like this: 2021-05. All releases are listed at https://icd.who.int/docs/icd-api/SupportedClassifications

#### Query Parameters
- **code** (string) - Optional - The code or code combination that will be looked up. (The & and / characters need to be URL encoded)
- **uri** (string) - Optional - Either foundation or linearization uri or uri combination that will be looked up. (The & and / characters need to be URL encoded)
- **simplify** (boolean) - Optional - If set to true the postcoordinated code set will be simplified. For example, if GC08&XN6P4 is provided (Urinary tract infection & Escherichia coli), with simplified option, the result will be one code (GC08.0 Urinary tract infection, site not specified, due to Escherichia coli). Defaults to false.
- **flexiblemode** (boolean) - Optional - Normally, codeInfo returns an error when the provided code combination includes codes that are not in the predefined suggested value sets of the entity. If the flexibleMode is set to true, it will return a result even when some of the postcoordination values are not in these defined value sets. In this case, the codes whose postcoordination axis cannot be detected ('/' postcoordination) will be placed under otherPostcoordination rubric. Defaults to false.
- **convertToTerminalCodes** (boolean) - Optional - By default it is false, if set to true, the codes and linearization URIs in the response will be changed to use the terminal codes (leaf nodes in the hierarchy). In most cases this is done by changing the code to the unspecified residual child. This does not affect the foundation URIs provided in the response. Defaults to false.

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Request Example
```json
{
  "params": {
    "linearizationname": "icd11",
    "releaseId": "2021-05",
    "code": "1A00&XN62R",
    "simplify": true,
    "flexiblemode": true,
    "convertToTerminalCodes": false
  },
  "headers": {
    "API-Version": "v2",
    "Accept-Language": "en"
  }
}
```

### Response
#### Success Response (200)
- **PostcoordinationSet** (object) - Contains detailed information about the postcoordinated code set.

#### Response Example
```json
{
  "foundationUri": "http://id.who.int/icd/Entity/123456789",
  "releaseId": "2021-05",
  "language": "en",
  "code": "GC08&XN6P4",
  "label": "Urinary tract infection due to Escherichia coli",
  "definition": "An infection of the urinary tract caused by the bacterium Escherichia coli.",
  "postcoordination": [
    {
      "axis": "Cause",
      "value": "Escherichia coli",
      "foundationUri": "http://id.who.int/icd/Entity/987654321"
    }
  ],
  "simplifiedCode": "GC08.0",
  "simplifiedLabel": "Urinary tract infection, site not specified, due to Escherichia coli",
  "simplifiedDefinition": "An infection of the urinary tract, not otherwise specified, caused by the bacterium Escherichia coli."
}
```
```

--------------------------------

### ICD-10 - Get Release Information

Source: https://id.who.int/swagger/v2/swagger/index

Retrieves basic information on a specific released version of ICD-10, including its chapters.

```APIDOC
## GET /icd/release/10/{releaseId}

### Description
This endpoint returns basic information on the released version of ICD-10 together with the chapters in it.

### Method
GET

### Endpoint
/icd/release/10/{releaseId}

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the ICD-10 release.
```

--------------------------------

### GET /icd/release/11/{linearizationname}/{id}

Source: https://id.who.int/swagger/v2/swagger/index

Returns lists the URIs of the entity in the available releases.

```APIDOC
## GET /icd/release/11/{linearizationname}/{id}

### Description
Returns lists the URIs of the entity in the available releases.

### Method
GET

### Endpoint
/icd/release/11/{linearizationname}/{id}

### Parameters
#### Path Parameters
- **linearizationname** (string) - Required - The name of the linearization.
- **id** (string) - Required - The ID of the entity.
```

--------------------------------

### ICD-11 Foundation - Get Latest Release Info

Source: https://id.who.int/swagger/v2/swagger/index

Retrieves basic information on the latest release of the ICD-11 Foundation and its top-level entities.

```APIDOC
## GET /icd/entity

### Description
This endpoint returns basic information on the latest release of the ICD-11 Foundation together with the top level Foundation entities.

### Method
GET

### Endpoint
/icd/entity
```

--------------------------------

### Get Code Information

Source: https://id.who.int/swagger/v2/swagger

Retrieves detailed information about a specific ICD code, including its properties and relationships.

```APIDOC
## GET /icd/v2/en-US/CodeInfo/{code}

### Description
This endpoint retrieves detailed information about a specific ICD code, including its stem code, simplification details, and associated characteristics.

### Method
GET

### Endpoint
/icd/v2/en-US/CodeInfo/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - The ICD code for which to retrieve information.

#### Query Parameters
None

#### Request Body
This endpoint does not accept a request body.

### Request Example
```
GET /icd/v2/en-US/CodeInfo/I21.9
```

### Response
#### Success Response (200)
- **code** (string, nullable) - The code as it was queried.
- **stemCode** (string, nullable) - The code of the stem (the first postcoordinated code).
- **stemId** (string, nullable) - The ID of the stem.
- **simplifiedCode** (string, nullable) - The code after simplification, if applicable.
- **simplifiedStemCode** (string, nullable) - The stem code after simplification, if applicable.
- **activityWhenInjured** (array of strings, nullable) - Activities associated with the injury.
- **alcoholUseInInjury** (array of strings, nullable) - Indicates alcohol use in the context of the injury.
- **aspectsOfArmedConflict** (array of strings, nullable) - Aspects related to armed conflict.
- **aspectsOfAssaultAndMaltreatment** (array of strings, nullable) - Aspects related to assault and maltreatment.
- **aspectsOfIntentionalSelfHarm** (array of strings, nullable) - Aspects related to intentional self-harm.
- **associatedWith** (array of strings, nullable) - Entities associated with this code.
- **causality** (array of strings, nullable) - Causal factors related to the condition.
- **chemicalAgent** (array of strings, nullable) - Chemical agents involved.
- **contextOfAssaultAndMaltreatment** (array of strings, nullable) - Context of assault and maltreatment.
- **counterpart** (array of strings, nullable) - Counterpart entities.
- **course** (array of strings, nullable) - The course of the condition.
- **diagnosisConfirmedBy** (array of strings, nullable) - Methods or results used to confirm the diagnosis.
- **distribution** (array of strings, nullable) - Distribution information.

#### Response Example
```json
{
  "code": "I21.9",
  "stemCode": "I21",
  "stemId": "http://id.who.int/icd/entity/1309673782",
  "simplifiedCode": "I21",
  "simplifiedStemCode": "I21",
  "activityWhenInjured": [
    "Physical exertion"
  ],
  "alcoholUseInInjury": [
    "Yes"
  ],
  "aspectsOfArmedConflict": [],
  "aspectsOfAssaultAndMaltreatment": [],
  "aspectsOfIntentionalSelfHarm": [],
  "associatedWith": [
    "Coronary atherosclerosis"
  ],
  "causality": [
    "Atherosclerosis"
  ],
  "chemicalAgent": [],
  "contextOfAssaultAndMaltreatment": [],
  "counterpart": [],
  "course": [
    "Acute"
  ],
  "diagnosisConfirmedBy": [
    "Electrocardiogram finding"
  ],
  "distribution": [
    "Myocardium"
  ]
}
```
```

--------------------------------

### ICD-11 Foundation - Search Entities (POST)

Source: https://id.who.int/swagger/v2/swagger/index

Searches the foundation component of ICD-11. Supports customization via parameters. Use POST for larger requests due to HTTP GET size limits.

```APIDOC
## POST /icd/entity/search

### Description
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 as HTTP GET has a size limit of 2K.

### Method
POST

### Endpoint
/icd/entity/search

### Parameters
#### Request Body
(Details on request body parameters would typically be listed here based on the OpenAPI spec, but are not fully provided in the input text.)
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}

Source: https://id.who.int/swagger/v2/swagger

Retrieves basic information about a released linearization, such as MMS, along with its chapters.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}

### Description
This endpoint returns basic information on the released linearization (such as MMS) together with the chapters in it.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}

### Parameters
#### Path Parameters
- **linearizationname** (string) - Required - Short name for the linearization. e.g. mms for ICD Mortality and Morbidity Statistics
- **releaseId** (string) - Required - The id for the release. This is generally formatted like this: 2019-04. All releases are listed at https://icd.who.int/docs/icd-api/SupportedClassifications

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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
#### Success Response (200)
- **content** (object) - Contains the linearization information.

#### Response Example
```json
{
  "content": {
    "title": "ICD Mortality and Morbidity Statistics",
    "description": "Mortality and Morbidity Statistics",
    "url": "http://id.who.int/icd/release/11/mms"
  }
}
```

#### Error Responses
- **401**: Unauthorized
- **404**: Not Found
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}/codeinfo/{code}

Source: https://id.who.int/swagger/v2/swagger/index

Allows looking up an entity from its code. For postcoordinated code combinations, it provides more information on the code combination such as which axes are used and what values do they have.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}/codeinfo/{code}

### Description
Allows looking up an entity from its code. For postcoordinated code combinations, it provides more information on the code combination such as which axes are used and what values do they have.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/codeinfo/{code}

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
- **code** (string) - Required - The code of the entity.
```

--------------------------------

### GET /icd/entity

Source: https://id.who.int/swagger/v2/swagger

Retrieves basic information on the latest release of the ICD-11 Foundation and its top-level entities. Supports filtering by release version and specifying language.

```APIDOC
## GET /icd/entity

### Description
This endpoint returns basic information on the latest release of the ICD-11 Foundation together with the top level Foundation entities.

### Method
GET

### Endpoint
/icd/entity

### Parameters
#### Query Parameters
- **releaseId** (string) - Optional - 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. All releases are listed at https://icd.who.int/docs/icd-api/SupportedClassifications

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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
#### Success Response (200)
- **Success** (object) - Description: Success

#### Error Response (401)
- **Unauthorized** (object) - Description: Unauthorized
```

--------------------------------

### Search Foundation API

Source: https://id.who.int/swagger/v2/swagger

This endpoint allows searching the foundation component of the ICD-11. Search can be customized using various query and header parameters. POST requests are recommended for large queries due to HTTP GET size limitations.

```APIDOC
## POST /foundation

### Description
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 as HTTP GET has a size limit of 2K.

### Method
POST

### Endpoint
/foundation

### Parameters
#### Query Parameters
- **q** (string) - Optional - Text to be searched. Having the character % at the end will be regarded as a wildcard for that word
- **subtreesFilter** (string) - Optional parameter. Comma separated list of URIs. If provided, the search will be performed on the entities provided and their descendants
- **chapterFilter** (string) - Optional, comma or semicolon separated list of chapter codes eg:01;02;21 When provided, the search will be performed only on these chapters
- **useFlexisearch** (boolean) - Optional. Changes the search mode to flexible search. Recommended to use 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
- **releaseId** (string) - Optional parameter. 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. Values are like 2019-04. All releases are listed at https://icd.who.int/docs/icd-api/SupportedClassifications
- **highlightingEnabled** (boolean) - Optional. Default is true, if set to false the search result highlighting is turned off and the results don't contain special tags for highlighting where the results are found within the text

#### Headers
- **API-Version** (string) - 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-Language** (string) - 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.

### Request Example
```json
{
  "q": "diabetes",
  "releaseId": "2023-01",
  "highlightingEnabled": false
}
```

### Response
#### Success Response (200)
- **ISearchResult** (object) - Contains the search results.

#### Response Example
```json
{
  "searchAffinity": 1,
  "searchRank": 1,
  "foundation": [
    {
      "title": {
        "@language": "en",
        "@value": "Diabetes mellitus"
      },
      "foundationId": "http://id.who.int/icd/entity/124646481",
      "chapterId": "http://id.who.int/icd/chapter/07",
      "leafId": "http://id.who.int/icd/entity/124646481",
      "inclusiveType": "fullyDefined",
      "supplement": null
    }
  ]
}
```

#### Error Response (401)
- **Unauthorized** - Indicates that the request lacks valid authentication credentials.
```

--------------------------------

### Get ICD-10 Release Information

Source: https://id.who.int/swagger/v2/swagger

Retrieves basic information about a specific ICD-10 release, including its chapters. Requires a release ID and supports API versioning and language negotiation.

```APIDOC
## GET /icd/release/10/{releaseId}

### Description
This endpoint returns basic information on the released version of ICD-10 together with the chapters in it.

### Method
GET

### Endpoint
/icd/release/10/{releaseId}

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The id for the release. For ICD-10, this is generally the year e.g. 2016

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Response
#### Success Response (200)
- **Success** - Description: Success. Schema references '#/components/schemas/TopLevel'

#### Error Response (401)
- **Unauthorized** - Description: Unauthorized
#### Error Response (404)
- **Not Found** - Description: Not Found
```

--------------------------------

### Get Available ICD-10 Releases for Entity

Source: https://id.who.int/swagger/v2/swagger

Lists the available ICD-10 releases for a specified category code. This endpoint supports API versioning and language preferences.

```APIDOC
## GET /icd/release/10/{code}

### Description
Lists the available ICD-10 releases for the requested category.

### Method
GET

### Endpoint
/icd/release/10/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - ICD-10 category code. For blocks the code range

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Response
#### Success Response (200)
- **Success** - Description: Success. Schema references '#/components/schemas/ICD10Availability'

#### Error Response (401)
- **Unauthorized** - Description: Unauthorized
#### Error Response (404)
- **Not Found** - Description: Not Found
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}/lookup

Source: https://id.who.int/swagger/v2/swagger/index

Allows looking up a foundation entity within a linearization and returns where that entity is coded in this linearization.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}/lookup

### Description
Allows looking up a foundation entity within a linearization and returns where that entity is coded in this linearization.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/lookup

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
#### Query Parameters
- **foundationEntityUri** (string) - Required - The URI of the foundation entity.
```

--------------------------------

### Get ICD-10 Releases

Source: https://id.who.int/swagger/v2/swagger

Retrieves a list of available ICD-10 releases. This endpoint allows filtering by API version and specifying the preferred language for the response.

```APIDOC
## GET /icd/release/10

### Description
Lists the available ICD-10 releases.

### Method
GET

### Endpoint
/icd/release/10

### Parameters
#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Response
#### Success Response (200)
- **Success** - Description: Success. Schema references '#/components/schemas/MultiVersion'

#### Error Response (401)
- **Unauthorized** - Description: Unauthorized
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}/autocode

Source: https://id.who.int/swagger/v2/swagger/index

Provides the best matching classification entity (its code, linearization URI, foundation URI and other related information) for the provided search text. See AutoCodingSearchResult schema for information on the response.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}/autocode

### Description
Provides the best matching classification entity (its code, linearization URI, foundation URI and other related information) for the provided search text. See AutoCodingSearchResult schema for information on the response.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/autocode

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
#### Query Parameters
- **searchText** (string) - Required - The text to find the best matching entity for.
```

--------------------------------

### Lookup Linearization

Source: https://id.who.int/swagger/v2/swagger

Retrieves details for a specific linearization (e.g., MMS) within a given release. This endpoint is useful for getting information about a specific classification system.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}

### Description
Retrieves specific linearization information for a given release and linearization name.

### Method
GET

### Endpoint
`/icd/release/11/{releaseId}/{linearizationname}`

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The id for the release. This is generally formatted like this: 2019-04. All releases are listed at https://icd.who.int/docs/icd-api/SupportedClassifications
- **linearizationname** (string) - Required - Short name for the linearization. e.g. mms for ICD Mortality and Morbidity Statistics

#### Query Parameters
- **foundationUri** (string) - Optional - The uri of the foundation entity that you'd like to map to this linearization

#### Header Parameters
- **API-Version** (string) - 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-Language** (string) - 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.

### Response
#### Success Response (200)
- **LinearizationEntity** (object) - The schema for the linearization entity.

#### Response Example
```json
{
  "id": "http://id.who.int/icd/release/11/2023-01/mms",
  "title": "ICD Mortality and Morbidity Statistics",
  "description": "Mortality and Morbidity Statistics (MMS) is a subset of ICD-11"
}
```
```

--------------------------------

### GET /icd/release/11/{releaseId}/{linearizationname}/describe

Source: https://id.who.int/swagger/v2/swagger/index

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. If the input is a code string such as 1A00&XN62R than it should be provided at the code paramter. If the input is a uri string such as http://id.who.int/icd/... then it should be provided at the uri parameter. The uri parameter accepts both foundation or linearization uris. During the process, if the postcoordination combination has an equivalent precoordinated entity, the system will return the information on the precoordinated entity.

```APIDOC
## GET /icd/release/11/{releaseId}/{linearizationname}/describe

### Description
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. If the input is a code string such as 1A00&XN62R than it should be provided at the code paramter. If the input is a uri string such as http://id.who.int/icd/... then it should be provided at the uri parameter. The uri parameter accepts both foundation or linearization uris. During the process, if the postcoordination combination has an equivalent precoordinated entity, the system will return the information on the precoordinated entity.

### Method
GET

### Endpoint
/icd/release/11/{releaseId}/{linearizationname}/describe

### Parameters
#### Path Parameters
- **releaseId** (string) - Required - The ID of the release.
- **linearizationname** (string) - Required - The name of the linearization.
#### Query Parameters
- **code** (string) - Optional - The code string (e.g., 1A00&XN62R).
- **uri** (string) - Optional - The URI string (e.g., http://id.who.int/icd/...).
```

--------------------------------

### ICD-10 - List Available Releases

Source: https://id.who.int/swagger/v2/swagger/index

Lists all the available releases for ICD-10.

```APIDOC
## GET /icd/release/10

### Description
Lists the available ICD-10 releases.

### Method
GET

### Endpoint
/icd/release/10
```

--------------------------------

### API Settings

Source: https://id.who.int/swagger/v2/swagger

Manages API settings, including language preferences for responses.

```APIDOC
## GET /api/v2/Swagger

### Description
This endpoint retrieves API specifications. It also allows for language preference via the Accept-Language header.

### Method
GET

### Endpoint
/api/v2/Swagger

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Header Parameters
- **Accept-Language** (string) - 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.

### Request Example
```json
{
  "example": "GET /api/v2/Swagger\nAccept-Language: en"
}
```

### Response
#### Success Response (200)
- **schema** (object) - The OpenAPI schema for the API.

#### Response Example
```json
{
  "example": "{ \"openapi\": \"3.0.0\", \"info\": { \"title\": \"ICD API\" } ... }"
}
```
#### Error Response (401)
- **description**: Unauthorized
```

--------------------------------

### GET /websites/id_who_int_swagger_v2

Source: https://id.who.int/swagger/v2/swagger

Retrieve medical records with various filtering options.

```APIDOC
## GET /websites/id_who_int_swagger_v2

### Description
This endpoint allows users to retrieve medical records by applying a comprehensive set of filters related to cause of death, surgical procedures, and specific details about fetal or infant deaths.

### Method
GET

### Endpoint
/websites/id_who_int_swagger_v2

### Parameters
#### Query Parameters
- **intervalA** (string) - Optional - Time interval from onset to death for Field A. Format same as IntervalA
- **intervalB** (string) - Optional - Time interval from onset to death for Field B. Format same as IntervalA
- **intervalC** (string) - Optional - Time interval from onset to death for Field C. Format same as IntervalA
- **intervalD** (string) - Optional - Time interval from onset to death for Field D. Format same as IntervalA
- **intervalE** (string) - Optional - Time interval from onset to death for Field E. Format same as IntervalA
- **surgeryWasPerformed** (integer) - Optional - 0: No, 1: Yes - 9: Unknown
- **surgeryDate** (string) - Optional - Surgery date using the format defined in the W3C (https://www.w3.org/TR/NOTE-datetime)
- **surgeryReason** (string) - Optional - Reason for surgery
- **autopsyWasRequested** (integer) - Optional - 0: No, 1: Yes, 9: Unknown
- **autopsyFindings** (integer) - Optional - 0: No, 1: Yes, 9: Unknown
- **mannerOfDeath** (integer) - Optional - 0: Disease, 1: Accident, 2: Intentional self harm, 3: Assault, 4: Legal intervention, 5: War, 6: Could not be determined, 7: Pending investigation, 9: Unknown
- **mannerOfDeathDateOfExternalCauseOrPoisoning** (string) - Optional - Date of external cause or poisoning using the format defined in the W3C (https://www.w3.org/TR/NOTE-datetime)
- **mannerOfDeathDescriptionExternalCause** (string) - Optional - Description external cause
- **mannerOfDeathPlaceOfOccuranceExternalCause** (integer) - Optional - 0: At home, 1: Residential institution, 2: School, other institution, public administration area, 3: Sports and athletics area, 4: Street and highway, 5: Trade and service area, 6: Industrial and construction area, 7: Farm, 8: Other place, 9: Unknown
- **fetalOrInfantDeathMultiplePregnancy** (integer) - Optional - 0: No, 1: Yes, 9: Unknown
- **fetalOrInfantDeathStillborn** (integer) - Optional - 0: No, 1: Yes, 9: Unknown
- **fetalOrInfantDeathDeathWithin24h** (integer) - Optional - If death within 24h specify number of hours survived.
- **fetalOrInfantDeathBirthWeight** (integer) - Optional - Birth weight (in grams).
- **fetalOrInfantDeathPregnancyWeeks** (integer) - Optional - Number of completed weeks of pregnancy.
- **fetalOrInfantDeathAgeMother** (integer) - Optional - Age of mother (years).
- **fetalOrInfantDeathPerinatalDescription** (string) - Optional - Perinatal description.

### Request Example
{}

### Response
#### Success Response (200)
- **data** (object) - Contains the medical records matching the query.
- **message** (string) - Confirmation message.

#### Response Example
{
  "data": [
    {
      "intervalA": "P7D",
      "intervalB": "P3D",
      "surgeryWasPerformed": 1,
      "surgeryDate": "2023-01-15T00:00:00Z",
      "mannerOfDeath": 0
    }
  ],
  "message": "Medical records retrieved successfully."
}
```
Tokens:
Raw