Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Entity Linking

Link entity

Links a single free-text medical entity to candidate codes from the requested ontology. The metadata field carries ontology-specific hints — it is strongly recommended for LOINC (a unit can change the linked code) and optional for medication. SNOMED CT and ICD-10-CM Comprehend do not use metadata.

post/med-link/nel/link

Request body

querystring required

Free-text medical entity to link.

ontologystring required

Ontology name. One of: snomed, loinc, medication, icd-10-cm.

versionstring required

Ontology version. Fetch valid values from GET /med-link/registry/.

top_kinteger

Number of candidate results to return.

metadataobject

Ontology-specific hints. Recommended for LOINC (unit, value, specimen, …) and optional for medication (form, generic_name, dose_unit, …). Ignored by SNOMED CT and ICD-10-CM Comprehend.

request_idstring nullable

Optional request ID. Generated automatically if omitted.

Example request

{
  "query": "chest pain",
  "ontology": "snomed",
  "version": "20250401_extended"
}

Response

Candidate codes for the query, ranked by relevance.

request_idstring required
querystring required
query_breakdownobject nullable

How the query was parsed. Present for LOINC, medication and ICD-10-CM Comprehend; null for SNOMED CT.

ontologystring required
versionstring required
index_namestring required

The index that served the request.

model_versionstring nullable

Example response

{
  "results": [
    {
      "term_id": "29857009",
      "term_name": "Chest pain"
    }
  ]
}