# ICD-11 Code Reference (`josrade/icd-11-code-reference`) Actor Lookup, search, and translate WHO ICD-11 disease codes through the official WHO ICD-11 API. Writes one normalized ICD-11 entity per input to the Apify dataset. - **URL**: https://apify.com/josrade/icd-11-code-reference.md - **Developed by:** [jts](https://apify.com/josrade) (community) - **Categories:** Developer tools, Business - **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ### What this Actor does Lookup, search, and translate WHO ICD-11 disease codes through the official WHO ICD-11 API. Writes one normalized ICD-11 entity per input to the Apify dataset. ### Input example ```json { "mode": "search", "query": "type 2 diabetes", "code": "5A11", "linearization": "mms", "language": "en" } ```` ### Input fields Provide an operating mode plus a query, an ICD-11 code, or an ICD-10 code. The Actor calls the WHO ICD-11 API and writes one response per input. - `mode` (string, user input): Which WHO ICD-11 operation to run. 'search' performs a flexible search by query, 'lookup' fetches an entity by ICD-11 code, and 'icd10-to-icd11' translates an ICD-10 code via the WHO codeinfo endpoint. - `query` (string, user input): Free-text disease, symptom, or condition for mode=search (e.g. 'type 2 diabetes', 'asthma'). - `code` (string, user input): ICD-11 code for mode=lookup or ICD-10 code for mode=icd10-to-icd11. - `linearization` (string, user input): WHO ICD-11 linearization. 'mms' is the Mortality and Morbidity Statistics linearization, 'icf' is the International Classification of Functioning. - `language` (string, user input): Two-letter language code sent as Accept-Language header (e.g. en, fr, es, ar, zh). - `clientId` (string, user input): OAuth2 client ID issued at https://icd.who.int. Stored as an Apify secret. - `clientSecret` (string, user input): OAuth2 client secret issued at https://icd.who.int. Stored as an Apify secret. ### Output dataset Each successful upstream response is written to the default dataset. - `input`: Original input value submitted to the upstream API. - `result`: Full upstream API response. ### Developer notes Set `ICD_11_CODE_REFERENCE_API_KEY` as an Apify secret environment variable. The Actor forwards it as `X-API-Key` to the upstream API. Use `apiBaseUrl` only for local or staging QA. Production runs default to the deployed API base URL from service.json. For advanced testing, a `requests` array can call explicit API paths; normal users should use the service-specific fields above. ### Run locally ```bash apify run ``` ### Deploy ```bash apify push ``` # Actor input Schema ## `mode` (type: `string`): Which WHO ICD-11 operation to run. 'search' performs a flexible search by query, 'lookup' fetches an entity by ICD-11 code, and 'icd10-to-icd11' translates an ICD-10 code via the WHO codeinfo endpoint. ## `query` (type: `string`): Free-text disease, symptom, or condition for mode=search (e.g. 'type 2 diabetes', 'asthma'). ## `code` (type: `string`): ICD-11 code for mode=lookup or ICD-10 code for mode=icd10-to-icd11. ## `linearization` (type: `string`): WHO ICD-11 linearization. 'mms' is the Mortality and Morbidity Statistics linearization, 'icf' is the International Classification of Functioning. ## `language` (type: `string`): Two-letter language code sent as Accept-Language header (e.g. en, fr, es, ar, zh). ## `clientId` (type: `string`): OAuth2 client ID issued at https://icd.who.int. Stored as an Apify secret. ## `clientSecret` (type: `string`): OAuth2 client secret issued at https://icd.who.int. Stored as an Apify secret. ## Actor input object example ```json { "mode": "search", "query": "type 2 diabetes", "code": "5A11", "linearization": "mms", "language": "en" } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "search", "query": "type 2 diabetes", "code": "5A11", "linearization": "mms", "language": "en" }; // Run the Actor and wait for it to finish const run = await client.actor("josrade/icd-11-code-reference").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "search", "query": "type 2 diabetes", "code": "5A11", "linearization": "mms", "language": "en", } # Run the Actor and wait for it to finish run = client.actor("josrade/icd-11-code-reference").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "search", "query": "type 2 diabetes", "code": "5A11", "linearization": "mms", "language": "en" }' | apify call josrade/icd-11-code-reference --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=josrade/icd-11-code-reference", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "ICD-11 Code Reference", "description": "Lookup, search, and translate WHO ICD-11 disease codes through the official WHO ICD-11 API. Writes one normalized ICD-11 entity per input to the Apify dataset.", "version": "0.1", "x-build-id": "YbgFQfLJep7uH4je2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/josrade~icd-11-code-reference/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-josrade-icd-11-code-reference", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/josrade~icd-11-code-reference/runs": { "post": { "operationId": "runs-sync-josrade-icd-11-code-reference", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/josrade~icd-11-code-reference/run-sync": { "post": { "operationId": "run-sync-josrade-icd-11-code-reference", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode", "query", "code", "linearization", "language", "clientId", "clientSecret" ], "properties": { "mode": { "title": "Operation mode", "enum": [ "search", "lookup", "icd10-to-icd11" ], "type": "string", "description": "Which WHO ICD-11 operation to run. 'search' performs a flexible search by query, 'lookup' fetches an entity by ICD-11 code, and 'icd10-to-icd11' translates an ICD-10 code via the WHO codeinfo endpoint.", "default": "search" }, "query": { "title": "Search query", "type": "string", "description": "Free-text disease, symptom, or condition for mode=search (e.g. 'type 2 diabetes', 'asthma')." }, "code": { "title": "ICD code", "type": "string", "description": "ICD-11 code for mode=lookup or ICD-10 code for mode=icd10-to-icd11." }, "linearization": { "title": "Linearization", "enum": [ "mms", "icf" ], "type": "string", "description": "WHO ICD-11 linearization. 'mms' is the Mortality and Morbidity Statistics linearization, 'icf' is the International Classification of Functioning.", "default": "mms" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code sent as Accept-Language header (e.g. en, fr, es, ar, zh).", "default": "en" }, "clientId": { "title": "WHO ICD-11 client ID", "type": "string", "description": "OAuth2 client ID issued at https://icd.who.int. Stored as an Apify secret." }, "clientSecret": { "title": "WHO ICD-11 client secret", "type": "string", "description": "OAuth2 client secret issued at https://icd.who.int. Stored as an Apify secret." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```