HealthCodesAPI

Search

One endpoint, ranked so that a code number never loses to prose that mentions it.

Examples
GET /v1/search?q=101076
GET /v1/search?q=raadpleging huisarts&language=nl
GET /v1/search?q=consultation au cabinet&language=fr

Parameters

ParameterDefaultNotes
qrequiredA code, or text in either language.
languagebothnl or fr to restrict.
activefalsetrue to exclude codes no longer in force.
limit50Maximum 200.

Ranking

Results carry match_type, which tells you why something matched and in what order results were ranked.

match_typeMeaning
exact_codeThe query is this code.
code_prefixThe code starts with the query.
exact_textA description equals the query.
text_prefixA description starts with the query.
relevanceFull-text match in the relevant language.
fuzzyApproximate match, accent- and typo-tolerant.

match_type is useful for interfaces: an exact_code hit can be navigated to directly, while a page of fuzzy hits should be presented as suggestions.