Search

View as Markdown
Searches the MEDCIN clinical terminology for medical terms matching a search query, ranked by a relevance/confidence score. Given free-text input such as "headache" — or a partial term for type-ahead / autocomplete — the Search API ([/Quippe/Search](/api-reference/rest/get-quippe-search)) returns matching MEDCIN terms (findings, symptoms, diagnoses, history, physical-exam, tests, and therapies) that can then be mapped to standard vocabularies such as ICD-10, SNOMED CT, and CPT via the coding endpoints ([/Quippe/Coding/TranslateItem](/api-reference/rest/get-quippe-coding-translate-item) for a single term, [/Quippe/Coding/ChartMap](/api-reference/rest/post-quippe-coding-chart-map) for a whole chart). Common uses include clinical-note autocomplete, encoding free text into structured findings, and looking up a term before translating its codes. GET /Quippe/Search To search code descriptions across many vocabularies at once (SNOMED, ICD-10, LOINC, and others), use [/Quippe/Coding/Search/Search](/api-reference/rest/get-quippe-coding-search-search) instead.

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, such as "headache" or "chest pain". Required. Beyond plain text it accepts a compact syntax: an embedded command (e.g. "-dx headache"), a single term by id ("!12345"), a trailing "+"/"-" result qualifier, and code-like input that is matched and mapped to MEDCIN. See the remarks for the full syntax and command list. Queries are trimmed and normalized (apostrophes and extra whitespace removed) and, unless disabled, common stop words are dropped; a query must exceed 2 characters to return results.
CommandstringOptional
An explicit search command, as an alternative to embedding one in Query (e.g. Command=dx is equivalent to "-dx ..."). Commands restrict the search to a term type (dx, sx, hx, px, tx, rx), search a specific code vocabulary (icd10, snomed, cpt, loinc, rxnorm, and others), or switch result type (draw, list, form, library, childterms, customterms). Case-insensitive. See the remarks for the complete list.
SearchVersionintegerOptional
Term search algorithm version. Use version 1 for the legacy Medcin Engine search, version 2 to use the ITermSearchService.
MaxResultsintegerOptional

Maximum number of results to return when paging is not used. Defaults to -1 (no limit). Superseded by PageSize; for paged access use StartIndex and PageSize instead.

StartIndexintegerOptional

For paged results, the zero-based index of the first item to return. Defaults to 0. Only takes effect when PageSize is greater than 0.

PageSizeintegerOptional

For paged results, the number of items per page. Defaults to -1 (paging disabled). When greater than 0, the response adds StartIndex, PageSize, Page, and Pages attributes.

IncludeImagesbooleanOptional

When true (default), includes related images from the MEDCIN Knowledge Base and Content Library. Automatically disabled when TermRoots restricts the search to a subtree, and by term-type commands. To also include images built into the MEDCIN engine, set UseMedcinServerImages.

TagsstringOptional

Comma-separated list of tag sets to evaluate and attach to matching terms (for example HCC or other quality tags). Returned per item in the Tags attribute, alongside built-in tags such as udf (custom/user-defined), ret (retired), and rn (nurse role). Defaults to none.

UseApproximateMatchingbooleanOptional

Enables fuzzy matching (default true), so approximate spellings and minor misspellings in Query still match terms.

PatientSexstringOptional

Patient sex used to filter out sex-specific terms: M or F. For example, an F patient excludes male-only findings. Leave blank (default) to disable sex filtering. Ignored for family-history queries. May be supplied directly or resolved from PatientId.

PatientAgeintegerOptional

Patient age in minutes, used to filter age-specific terms and content. Defaults to 0 (no age filtering). MEDCIN expresses age in minutes for neonatal/pediatric precision; for example 1 year is about 525,960 minutes. May be supplied directly or resolved from PatientId.

PatientIdstringOptional

Patient identifier used to look up age and sex from the configured patient data provider, as an alternative to passing PatientAge and PatientSex directly. Requires an IPatientDataService. Defaults to none.

EncounterTimestringOptional

The encounter date/time used to compute patient age when PatientId is supplied (age = encounter time − birth date). Defaults to the current time when a patient is resolved. Has no effect when age and sex are passed directly.

IncludeScorebooleanOptional

When true, adds the computed relevance Score to each result. Higher scores indicate a closer match (exact matches rank highest, then prefix matches, then partial-word matches). Defaults to false.

IncludeHighlightbooleanOptional

When true (default), each result includes a Highlight attribute: a list of [start, length] character ranges marking where the query matched the term text, for highlighting in a UI.

TermRootsstringOptional

One or more MEDCIN ids to use as search roots. A value ≥ 0 limits results to descendants of that term; -1 (default) means no restriction; 0 limits results to MEDCIN terms only. When multiple roots are supplied, all must be greater than zero. Supplying a root also disables image and content-library results.

TermDepthintegerOptional

When a positive TermRoots value is set, limits how many levels below the root are searched. Defaults to -1 (no depth limit).

UseMedcinServerImagesbooleanOptional

When true, also searches images built into the MEDCIN engine, in addition to Knowledge Base and Content Library images. Defaults to false; only effective when IncludeImages is true.

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
searchResultsobjectOptional

Errors

401
Unauthorized Error
500
Internal Server Error