Skip to main content

Overview

Get intelligent concept suggestions for autocomplete functionality, based on partial text input. Candidate evidence includes exact published synonyms, concept-name prefixes and substrings, and source-code prefixes.

Ordering

Clinical utility is the outer ordering tier, using the API’s default ranking policy documented under Relevance Scoring in Basic Search. Questionnaire answer-list entries, survey values and LOINC structural parts rank last by default, and Standard concepts outrank non-standard ones. Within one utility tier, exact primary names and exact source codes lead, followed by exact published synonyms, name prefixes, code prefixes, and name substrings. Core clinical domains are preferred next, followed by shorter completion text, vocabulary authority, alphabetical name, and concept_id. The final ID tie-break makes pagination deterministic. This endpoint and /v1/search/suggest share one implementation and therefore one ordering.
Synonym evidence is deliberately exact-only on this typeahead endpoint. Use /v1/search/concepts for token, phrase, and fuzzy synonym retrieval.

Query Parameters

string
required
Partial text input for suggestions (minimum 2 characters, maximum 100 characters)
integer
default:"1"
Page number for pagination (1-based)
integer
default:"10"
Number of suggestions per page (max: 100)
string
Comma-separated list of vocabulary IDs to filter suggestions (e.g., “SNOMED,ICD10CM”)
string
Comma-separated list of domain IDs to filter suggestions (e.g., “Condition,Drug”)
string
Comma-separated concept classes. Explicit requests for Answer, Survey, Value, or another normally demoted class disable the default non-clinical demotion for that filtered result set.
string
Vocabulary release version to query (e.g., “2025.1”). Defaults to latest release.

Response Fields

boolean
Whether suggestion generation succeeded.
array
Suggested concept records.
integer
OMOP concept identifier.
string
Primary concept name.
string
Source vocabulary code.
string
Vocabulary identifier.
string
OMOP domain.
string
Concept class.
string | null
S, C, or null.
string
Validity start date.
string
Validity end date.
string | null
Invalidity marker, or null.
object
Request, release, and pagination metadata.
string
Request correlation ID.
string
Response timestamp.
string
Vocabulary release used.
object
Page, page size, totals, and navigation flags.