Text search (keyword-based)
/construe/codes/{codesystem}/search/textPerforms fast full-text search over code IDs and descriptions.
Availability: This endpoint is only available for built-in code systems.
Custom code systems uploaded via /construe/upload are not indexed for full-text search
and will return empty results. Use /search/semantic to search custom code systems.
When to use: Best for autocomplete UIs, code lookup, or when users know part of the code ID or specific keywords. Fast response times suitable for typeahead interfaces.
Features:
- Substring matching on code IDs (e.g., "11.65" finds "E11.65")
- Typo tolerance on descriptions (not on code IDs)
- Fast response times (~10-50ms)
Examples:
- Query "E11" finds all codes starting with E11 (diabetes codes)
- Query "diabtes" (typo) still finds "diabetes" codes
Trade-offs: Faster than semantic search, but only matches keywords/substrings. Won't find conceptually related codes with different terminology.
See also: /search/semantic for finding conceptually similar codes.
Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
Path parameters
codesystemstringrequiredCode system name
Query parameters
qstringrequiredSearch query (searches code IDs and descriptions)
versionstringoptionalSpecific version of the code system
limitintegeroptionaldefault 20Maximum number of results (default 20, max 100)
Text search results
Response fields
systemobjectrequirednamestringrequiredCode system name
versionstringrequiredCode system version
resultsobject[]requiredCodes matching the search query
codestringrequireddescriptionstringrequiredfoundintegerrequiredTotal number of matching results (may exceed results array due to pagination)