API ReferenceQuippeCoding

Search

View as Markdown
Searches medical code descriptions across many vocabularies at once and returns the matching codes, ranked by relevance. Given free text such as "headache", the Code Search API (GET /Quippe/Coding/Search/Search) searches the descriptions of codes in vocabularies including SNOMED CT, ICD-10-CM, ICD-9-CM, MEDCIN, LOINC, RxNorm, CPT, MeSH, and CTCAE, and returns each matching code with its vocabulary, description, and rank. Optionally it can also return the MEDCIN findings each code maps to. Common uses include code lookup and autocomplete by description, finding the right billing or problem-list code from a clinical phrase, and cross-vocabulary code discovery. GET /Quippe/Coding/Search/Search Use this endpoint when you have descriptive text and want codes. MEDCIN can appear among the results but is not the focus. To search the MEDCIN clinical terminology specifically and get back MEDCIN terms, use [/Quippe/Search](/api-reference/rest/get-quippe-search). To translate a code you already have into another vocabulary, use [/Quippe/Coding/TranslateItem](/api-reference/rest/get-quippe-coding-translate-item).

Authentication

AuthorizationBasic

Login and password used to access quippe.medicomp.com. On-premise Quippe deployments can be configured to use whatever authentication and authorization your application is configured for, so basic authentication is used here to access the Quippe sandbox and is not a product requirement.

OR
AuthorizationBearer

JSON web token generated by a request to the /Quippe/Security/Token web service endpoint in Quippe.

Query parameters

QuerystringRequired

The free-text search query to match against code descriptions, such as “headache” or “chest pain”.

VocabCodesstringOptional
Comma-separated list of vocabulary codes to restrict the search to (for example snomed,icd10,loinc). When omitted, the service's default set of vocabularies is searched and results are merged and ranked together. Each code must be licensed. The full list of supported vocabulary codes can be retrieved from the [/Quippe/Coding/Vocabs](/api-reference/rest/get-quippe-coding-vocabs) endpoint. Note that "icd" is ICD-9-CM and "icd10" is ICD-10-CM.
TermTypestringOptional

Restricts results to a single term type within the searched vocabularies. Term-type codes are vocabulary-specific (for example RxNorm term types are upper-cased before use). Defaults to the service default term type; leave at the default to search all term types.

LimitintegerOptional

Maximum number of matches to return. Defaults to 100; valid range is 1 to the upper limit supported by the service or provider.

ExactbooleanOptional

When true, uses the query as-is (applying only the minimal required pre-processing) and disables the automatic suggestions (term suggestion and spell-correction).

CleanbooleanOptional

When true, removes punctuation from the query in addition to the minimal required pre-processing.

VerbosebooleanOptional

When true, returns additional detail per match: a Score, plus CodeInfo (code id, vocab version, matched description, hint/specifier/unreportable flags) and DescriptionInfo (description id, type, sequence, word and character counts).

SortModeenumOptional

Orders results either by relevance/search-score rank or in vocabulary order. Defaults to the service default sort mode. (Applies to the merged result set when multiple vocabularies are searched.)

Allowed values:
IncludeMedcinMapsenumOptional

Whether to include the MEDCIN findings that each non-MEDCIN match maps to, added as a MedcinMaps block per match. None (default) omits them; All includes every available map; Limited includes only the best-choice maps. MEDCIN matches themselves are never given a map block.

Allowed values:
TagsstringOptional

Comma-separated list of tag sets to evaluate and attach to matches (via the MEDCIN findings a code maps to), returned in a per-match Tags attribute.

DataFormatenumOptional
Specifies how objects are encoded in the output
Allowed values:
RequestIdstringOptional
Optional value that can be used by clients to track multiple requests.
CulturestringOptional
Culture to use when handling the request. If not specified the default value configured on the server will be used.

Response

Successful response
matchesobjectOptional

Errors

401
Unauthorized Error
500
Internal Server Error