Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

World Health Organization (WHO) Foundation API

The Foundation API from World Health Organization (WHO) — 4 operation(s) for foundation.

World Health Organization (WHO) Foundation API is one of 3 APIs that World Health Organization (WHO) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Foundation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version v2.6.0.

Requests are made against the base URL https://ghoapi.azureedge.net/api.

5 operations 4 paths 14 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.6.0
Base URL
https://ghoapi.azureedge.net/api
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

World Health Organization (WHO) Foundation API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Foundation 5
GET
/icd/entity
This endpoint returns basic information on the latest release of the ICD-11 Foundation together with the top level Foundation entities.
GetFoundation 3 params → 200401
GET
/icd/entity/{id}
This endpoint provides you information on a specific ICD-11 foundation entity
GetFoundationEntity 5 params → 200401404
GET
/icd/entity/autocode
Provides the best matching classification entity (its code and URI) for the provided diagnostic text. see AutoCodingSearchResult schema for information on the response.
AutoCodeFoundation 6 params → 200401
GET
/icd/entity/search
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…
SearchFoundation 10 params → 200401
POST
/icd/entity/search
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…
SearchFoundation 10 params → 200401

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ISimpleEntity (20 properties), FoundationEntity (14 properties), TopLevelFoundation (11 properties), AutoCodingSearchResult (9 properties). Each schema is shown below with its type and property counts.

AutoCodingSearchResult
object
Response object for autocode endpoint
9 properties
ISimpleEntity
object
SimpleEntity class represents a single ICD Entity in a search result
20 properties
ISimplePropertyValue
object
Represents PropertyValues returned in the search result
6 properties
EntityTypeEnum
integer
(0) Real: real entity in the linearization / foundation (1) UnderShoreLineLogicallyDefined: Entity in the foundation that can be represented as a post-coordina…
TopLevelFoundation
object
Class representing top level for the foundation
11 properties
ISearchResult
object
Represents the search result. The search result is organized by ICD entities and in each entity we provide matching property values
8 properties
PropertyValueTypeEnum
integer
(0) Real: An index info from a linearization entity (1) UnderShoreLine: An index entity from an entity under the shoreline (2) UnderShoreLineLogicallyDefined:…
FoundationEntity
object
Class representing a foundation entity
14 properties
GuessTypeEnum
integer
Term
object
Class representing a term with language specific label and optional cross references
4 properties
MatchLevelEnum
integer
GuessWord
object
Represents a keyword returned as a as a word completion suggestion or as a next word suggestion
2 properties
LanguageSpecificText
object
Language specific text as used in JSON-LD
2 properties
PostcoordinationAvailabilityEnum
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

who-foundation-api-openapi.yml Raw ↑

Other APIs World Health Organization (WHO) publishes across the network.

World Health Organization (WHO) ICD10 API
World Health Organization (WHO) Linearization (classification endpoints) API