Skip to main content
POST
Link entities (batch)

About this endpoint

POST /med-link/nel/link/batch links up to 5 free-text entities in a single call. Every query in the batch shares the same ontology, version, top_k and metadata. The response results[] array contains one block per query, in request order — each block has the same shape as a single Link Entity response.

When to use it

  • Coding several entities from the same document (e.g. all symptoms in a note).
  • Reducing round-trips when the ontology and metadata are identical.
Because metadata is shared across the whole batch, group queries that need different hints — especially LOINC tests with different units or specimens — into separate batches, or use the single Link Entity endpoint.

Limits

Authorizations

Authorization
string
header
required

Bearer access token issued by the Eka authorization flow. See Authorization.

Body

application/json
queries
string[]
required

List of free-text entities to link (1–5).

Required array length: 1 - 5 elements
ontology
string
required

Ontology name applied to every query in the batch.

Example:

"snomed"

version
string
required

Ontology version applied to every query in the batch.

Example:

"20250401_extended"

top_k
integer
default:5

Number of candidate results to return per query.

Required range: 1 <= x <= 10
metadata
object

Ontology-specific hints applied to every query in the batch.

request_id
string | null

Optional request ID. Generated automatically if omitted.

Response

One result block per query, in request order.

results
object[]
required

One NELResponse per query, in request order.