Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omophub.com/llms.txt

Use this file to discover all available pages before exploring further.

Search for concepts by text. The SDK normalises three possible server response shapes ({ concepts: [...] }, legacy { data: [...] }, bare Concept[]) into a stable SearchResult - data.concepts is always a Concept[]:
const { data, error } = await client.search.basic('diabetes mellitus', {
  pageSize: 20,
});
if (error) throw new Error(error.message);

for (const concept of data.concepts) {
  console.log(`${concept.concept_id}: ${concept.concept_name}`);
}

Parameters

ParameterTypeDefaultDescription
query (positional)stringrequiredSearch query string
vocabularyIdsstring[]-Filter by vocabulary IDs
domainIdsstring[]-Filter by domain IDs
conceptClassIdsstring[]-Filter by concept class IDs
standardConcept'S' | 'C' | 'N'-Filter by standard concept flag
includeSynonymsbooleanfalseSearch synonyms too
includeInvalidbooleanfalseInclude invalid concepts
minScorenumber-Minimum relevance score (0.0–1.0)
exactMatchbooleanfalseRequire exact match
pagenumber1Page number (1-based)
pageSizenumber20Results per page
sortBy'relevance' | 'name' | 'code' | 'date'-Sort field
sortOrder'asc' | 'desc'-Sort order

Filter Combinations

// By vocabulary
await client.search.basic('heart attack', {
  vocabularyIds: ['SNOMED', 'ICD10CM'],
});

// By domain
await client.search.basic('aspirin', {
  domainIds: ['Drug'],
  pageSize: 10,
});

// Standard concepts only
await client.search.basic('diabetes', {
  standardConcept: 'S',
  vocabularyIds: ['SNOMED'],
});

// Combined
await client.search.basic('myocardial infarction', {
  vocabularyIds: ['SNOMED'],
  domainIds: ['Condition'],
  standardConcept: 'S',
  includeSynonyms: true,
  minScore: 0.5,
  pageSize: 20,
});

Autocomplete

Get suggestions as the user types. The response is { query, suggestions: [...] } - each entry nests the concept under suggestion:
const { data } = await client.search.autocomplete('diab', { pageSize: 10 });
console.log(data?.query); // "diab" (echoed)

for (const entry of data?.suggestions ?? []) {
  console.log(entry.suggestion.concept_name);
  console.log(entry.match_score); // optional scoring field
}

Pagination

Manual Pagination

const first = await client.search.basic('diabetes', { page: 1, pageSize: 50 });

const pagination = first.meta?.pagination;
console.log(`Total: ${pagination?.total_items}`);
console.log(`Pages: ${pagination?.total_pages}`);
console.log(`Has next: ${pagination?.has_next}`);

if (pagination?.has_next) {
  const second = await client.search.basic('diabetes', { page: 2, pageSize: 50 });
}

Auto-Pagination Iterator

basicIter is an async generator that walks every page and yields one concept at a time:
let count = 0;
for await (const concept of client.search.basicIter('diabetes', { pageSize: 100 })) {
  console.log(concept.concept_name);
  count++;
  if (count >= 500) break;
}
Async iterators throw OMOPHubIteratorError on page failure (generators can’t gracefully yield discriminated errors). Use the eager basicAll(...) variant if you prefer accumulating errors as values. See Error Handling.

Eager Collect

const { data, errors, pagesFetched } = await client.search.basicAll('diabetes', {
  pageSize: 100,
  maxPages: 10,
});

console.log(`Collected ${data.length} concepts across ${pagesFetched} pages`);
if (errors.length > 0) console.warn('Partial result:', errors);
POST-based search with relationship filters:
const { data } = await client.search.advanced('diabetes', {
  vocabularyIds: ['SNOMED', 'ICD10CM'],
  domainIds: ['Condition'],
  standardConceptsOnly: true,
  pageSize: 50,
});

for (const concept of data?.concepts ?? []) {
  console.log(`${concept.concept_id}: ${concept.concept_name}`);
}

Advanced Search Parameters

ParameterTypeDefaultDescription
query (positional)stringrequiredSearch query string
vocabularyIdsstring[]-Filter by vocabulary IDs
domainIdsstring[]-Filter by domain IDs
conceptClassIdsstring[]-Filter by concept class IDs
standardConceptsOnlybooleanfalseOnly standard concepts
includeInvalidbooleanfalseInclude invalid concepts
relationshipFiltersRelationshipFilter[]-Relationship-based filters
pagenumber1Page number
pageSizenumber20Results per page

Relationship Filters

await client.search.advanced('diabetes', {
  relationshipFilters: [
    { relationshipId: 'Is a', targetConceptId: 4116142 },
  ],
  standardConceptsOnly: true,
});
Embedding-based natural-language search. The SDK normalises the response so data.results is always a populated array:
const { data } = await client.search.semantic('heart attack', { pageSize: 10 });

for (const concept of data?.results ?? []) {
  console.log(`${concept.concept_name}: ${concept.similarity_score.toFixed(2)}`);
}
With filters:
const filtered = await client.search.semantic('diabetes mellitus', {
  vocabularyIds: ['SNOMED'],
  domainIds: ['Condition'],
  threshold: 0.5,
  pageSize: 20,
});

Semantic Search Parameters

ParameterTypeDefaultDescription
query (positional)stringrequiredNatural language query
vocabularyIdsstring[]-Filter by vocabularies
domainIdsstring[]-Filter by domains
standardConcept'S' | 'C' | 'N'-Filter by standard flag
conceptClassIdstring-Filter by concept class
thresholdnumber0.5Minimum similarity (0–1)
pagenumber1Page number
pageSizenumber20Results per page (max 100)

Semantic Search Iterator

for await (const concept of client.search.semanticIter('diabetes', { pageSize: 50 })) {
  console.log(concept.concept_name);
}

// Collect with bounds
const { data } = await client.search.semanticAll('heart failure', {
  vocabularyIds: ['SNOMED'],
  threshold: 0.4,
  maxPages: 5,
});
Run up to 50 keyword searches in a single API call:
The per-search entries (BulkBasicSearchInput) use snake_case keys (search_id, vocabulary_ids, domain_ids, page_size) — they’re a direct pass-through of the API payload, not a camelCase options object. The outer defaults object follows the same convention. This is the only place in the SDK where snake_case appears at the TypeScript surface.
const { data } = await client.search.bulkBasic(
  [
    { search_id: 'q1', query: 'diabetes mellitus' },
    { search_id: 'q2', query: 'hypertension' },
    { search_id: 'q3', query: 'aspirin' },
  ],
  { defaults: { vocabulary_ids: ['SNOMED'], page_size: 5 } },
);

for (const item of data?.results ?? []) {
  console.log(`${item.search_id}: ${item.results.length} results (${item.status})`);
}

Bulk Basic Parameters

ParameterTypeDescription
searches (positional)BulkBasicSearchInput[]1–50 search inputs
searches[].search_idstringUnique correlation ID echoed in results
searches[].querystringSearch query
searches[].vocabulary_idsstring[]Per-search vocabulary filter
searches[].domain_idsstring[]Per-search domain filter
searches[].page_sizenumberPer-search result limit (1–100)
defaultsBulkSearchDefaultsShared defaults - per-search values override
Up to 25 semantic searches per call:
const { data } = await client.search.bulkSemantic(
  [
    { search_id: 's1', query: 'heart failure treatment options' },
    { search_id: 's2', query: 'type 2 diabetes medication' },
    { search_id: 's3', query: 'elevated blood pressure' },
  ],
  { defaults: { threshold: 0.5, page_size: 10 } },
);

for (const item of data?.results ?? []) {
  console.log(`${item.search_id}: ${item.results.length} results`);
  for (const concept of item.results) {
    console.log(`  ${concept.concept_name} (${concept.similarity_score.toFixed(2)})`);
  }
}

Find Similar Concepts

Find concepts similar to a reference. Provide exactly one of conceptId, conceptName, or query. The discriminated union enforces this at the type level; a runtime check defends against JS callers:
// By concept ID
const byId = await client.search.similar({ conceptId: 4329847 }); // MI

// By concept name
const byName = await client.search.similar({ conceptName: 'Type 2 diabetes mellitus' });

// By natural language query
const byQuery = await client.search.similar({ query: 'elevated blood sugar' });

// With all options
const { data } = await client.search.similar({
  conceptId: 4329847,
  algorithm: 'semantic',
  similarityThreshold: 0.7,
  pageSize: 50,
  vocabularyIds: ['SNOMED'],
  domainIds: ['Condition'],
  includeScores: true,
  includeExplanations: true,
});

for (const concept of data?.similar_concepts ?? []) {
  console.log(`${concept.concept_name}: ${concept.similarity_score.toFixed(2)}`);
}
similar() uses a two-arg signature similar(options, requestOptions?) - its query XOR variant would otherwise collide with PerCallOptions.query (the escape-hatch params record). Pass signal, headers, or idempotencyKey via the second argument.

Similar Concepts Parameters

ParameterTypeDefaultDescription
conceptIdnumber-Source concept ID (XOR with conceptName/query)
conceptNamestring-Source concept name
querystring-Natural-language query
algorithm'semantic' | 'lexical' | 'hybrid''hybrid'Matching algorithm
similarityThresholdnumber0.7Minimum similarity (0–1)
pageSizenumber20Max results (server caps at 1000)
vocabularyIdsstring[]-Filter by vocabulary
domainIdsstring[]-Filter by domain
standardConcept'S' | 'C' | 'N'-Standard concept filter
includeInvalidboolean-Include invalid/deprecated
includeScoresboolean-Include detailed scoring
includeExplanationsboolean-Include similarity explanations

Algorithm Comparison

AlgorithmBest ForSpeed
semanticMeaning-based similaritySlower
lexicalText/string similarityFaster
hybridBalanced approachMedium