Prompt | Medicomp Docs

Generates a Clinical Lens “prompt” list - the set of related MEDCIN findings (differential diagnoses, associated symptoms, work-up, and treatment terms) suggested for a given source term, so an application can offer clinically relevant filtering of a patient’s chart. Given a MEDCIN ID (or, with SourceType=content, a content library item ID), the Prompt API (GET /Quippe/ClinicalLens/Prompt) expands the source into a ranked list of MEDCIN terms using the MEDCIN knowledge base’s built-in prompting/associativity data, optionally overridden or filtered by author-curated content from the content library.

Common uses include driving clinically-intelligent filtering and highlighting of items in a patient’s chart related to a particular diagnosis

GET /Quippe/ClinicalLens/Prompt

Use this endpoint when you already have a MEDCIN ID (or a content library item ID) and want the related terms the MEDCIN knowledge base or curated content suggests for it. To search the MEDCIN clinical terminology for a term in the first place, use /Quippe/Search. To map the resulting MEDCIN findings to other vocabularies, use /Quippe/Coding/ChartMap or /Quippe/Coding/TranslateItem.

Generates a Clinical Lens "prompt" list - the set of related MEDCIN findings (differential diagnoses, associated symptoms, work-up, and treatment terms) suggested for a given source term, so an application can offer clinically relevant filtering of a patient's chart. Given a MEDCIN ID (or, with `SourceType=content`, a content library item ID), the Prompt API (GET /Quippe/ClinicalLens/Prompt) expands the source into a ranked list of MEDCIN terms using the MEDCIN knowledge base's built-in prompting/associativity data, optionally overridden or filtered by author-curated content from the content library. Common uses include driving clinically-intelligent filtering and highlighting of items in a patient's chart related to a particular diagnosis GET /Quippe/ClinicalLens/Prompt Use this endpoint when you already have a MEDCIN ID (or a content library item ID) and want the related terms the MEDCIN knowledge base or curated content suggests for it. To search the MEDCIN clinical terminology for a term in the first place, use [/Quippe/Search](/api-reference/rest/get-quippe-search). To map the resulting MEDCIN findings to other vocabularies, use [/Quippe/Coding/ChartMap](/api-reference/rest/post-quippe-coding-chart-map) or [/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.

AuthorizationBearer

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

Query parameters

SourceIdstringRequired

The ID of the source item to expand into a prompt list. When SourceType=term (default), this is a MEDCIN ID and must parse as a positive integer. When SourceType=content, this is a content library item ID instead.

SourceTypestringOptional

Determines how SourceId is interpreted. term (default) treats SourceId as a MEDCIN ID and expands it via the MEDCIN knowledge base (or a nursing-intervention prompt if the ID falls under the nursing root node). content treats SourceId as a content library item ID and returns the MEDCIN list authored directly in that XML content item.

Determines how `SourceId` is interpreted. `term` (default) treats `SourceId` as a MEDCIN ID and expands it via the MEDCIN knowledge base (or a nursing-intervention prompt if the ID falls under the nursing root node). `content` treats `SourceId` as a content library item ID and returns the MEDCIN list authored directly in that XML content item.

ListSizeenumOptional

Controls how many related terms are returned in the prompt list. medListSmall provides the hallmark findings for a given diagnosis, while other values will cast a progressively wider net when looking for related terms. medListFull is eligible for the BroadPromptMethod/ExpandOnAllDx broadening behaviors. Ignored when SourceType=content.

Controls how many related terms are returned in the prompt list. `medListSmall` provides the hallmark findings for a given diagnosis, while other values will cast a progressively wider net when looking for related terms. `medListFull` is eligible for the `BroadPromptMethod`/`ExpandOnAllDx` broadening behaviors. Ignored when `SourceType=content`.

Allowed values:

PatientIdstringOptional

Optional patient ID used to set patient demographics (age, sex, ethnicity, religion, race, last name) on the MEDCIN knowledge base before the prompt list is built, so age/sex-specific MEDCIN content is applied. Requires the patient’s birth date to be resolvable; ignored otherwise.

EncounterTimestringOptional

The clinical time of the encounter, used with PatientId to compute the patient’s age for knowledge-base demographics. Defaults to the current time when a PatientId is supplied but no EncounterTime is given.

UseContentOverridebooleanOptional

When true (default), checks the Content Library for a curated list that overrides the MEDCIN knowledge-base expansion for this SourceId and ListSize (matched by a ContentPrefix+size+id keyword) before falling back to the standard MEDCIN prompt. Ignored when SourceType=content, since the source is already a content item.

When true (default), checks the Content Library for a curated list that overrides the MEDCIN knowledge-base expansion for this `SourceId` and `ListSize` (matched by a `ContentPrefix`+size+id keyword) before falling back to the standard MEDCIN prompt. Ignored when `SourceType=content`, since the source is already a content item.

ContentPrefixstringOptional

The keyword prefix used to look up a Content Library override (combined with the numeric ListSize value and the MEDCIN id, e.g. “lens2_123456”). Only used when UseContentOverride is true.

ResponseTypestringOptional

Shapes the response body. terms returns full term detail per item (MedcinId, NodeKey, TermType, Description, and optionally Source); expression returns a single compact node-key regular expression string covering the whole list, which can be used to match node keys for patient chart entries against the prompt list in a single operation; keys (default, used for any other value) returns a flat list of node keys only.

Shapes the response body. `terms` returns full term detail per item (MedcinId, NodeKey, TermType, Description, and optionally Source); `expression` returns a single compact node-key regular expression string covering the whole list, which can be used to match node keys for patient chart entries against the prompt list in a single operation; `keys` (default, used for any other value) returns a flat list of node keys only.

PruneTermsbooleanOptional

When true (default), sorts the result list by node key and removes any item whose node key is a descendant of another item already in the list, collapsing redundant child terms down to their nearest included ancestor.

UsePrimarySpecialtybooleanOptional

Accepted for compatibility with existing callers of the Prompt API, but not currently read by this handler’s implementation. Use BroadPromptMethod=2 to restrict expansion to the primary specialty instead.

ExpandOnAllDxbooleanOptional

When true (default) and the resulting list from the MEDCIN knowledge base consists entirely of diagnosis terms, re-expands each of those diagnoses individually and merges the results, retrying up to 3 times. This broadens an all-diagnosis result into a richer mix of associated terms. Ignored when SourceType=content or for nursing prompts.

IncludeRsbooleanOptional

When true (default), includes findings with R prompt-level records when building the MEDCIN activation list mode. Combines with IncludeMs to set the knowledge base’s list-build mode for this request.

IncludeMsbooleanOptional

When true (default), includes findings with M prompt-level records when building the MEDCIN activation list mode. Combines with IncludeRs to set the knowledge base’s list-build mode for this request.

BroadPromptMethodintegerOptional

Selects how the list is broadened when ListSize=medListFull: 1 (default) uses all specialties applicable to the source term; 2 restricts the specialty to the source term’s primary (parent-node) specialty only; 3 instead extends the list with all terms from the source term’s ICD-10-WHO diagnostic category. Ignored for any other ListSize.

Selects how the list is broadened when `ListSize=medListFull`: `1` (default) uses all specialties applicable to the source term; `2` restricts the specialty to the source term's primary (parent-node) specialty only; `3` instead extends the list with all terms from the source term's ICD-10-WHO diagnostic category. Ignored for any other `ListSize`.

ExpandLabPanelsbooleanOptional

When true (default), scans the result list for lab test terms and appends any related lab findings (as items tagged RelatedLab) so ordering a panel-adjacent test surfaces its companion labs.

ShowSourcesbooleanOptional

When true (default) and ResponseType=terms, includes a Source attribute on each item describing where the term came from. Has no effect on keys or expression responses.

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

listobjectOptional

Errors

401

Unauthorized Error

500

Internal Server Error

1	{
2	"list": {
3	"item": [
4	{
5	"medcinId": 1,
6	"nodeKey": "string",
7	"termType": 1,
8	"description": "string",
9	"source": "string"
10	}
11	],
12	"expression": "string",
13	"keys": [
14	"string"
15	],
16	"sourceId": "string",
17	"count": 1,
18	"specialty": "string",
19	"contentId": "string",
20	"contentName": "string"
21	}
22	}