API ReferenceQuippeNote Builder

Multi Quick Prompt

View as Markdown
Generates a MEDCIN "quick prompt" (nomenclature/differential list) for several findings at once — the combined list of related MEDCIN terms (associated symptoms, tests, therapies, and diagnoses) that clinicians pick from to build out a note after entering multiple diagnoses or symptoms. The MultiQuickPrompt API (GET /Quippe/NoteBuilder/MultiQuickPrompt) takes an array of MEDCIN IDs and returns a single list of related terms sized and filtered for interactive charting. Common uses include populating the pick-list shown after a user selects several diagnoses or chief complaints together, structured symptom review across multiple findings, and driving point-of-care documentation workflows that prompt the clinician for related findings from more than one starting term. GET /Quippe/NoteBuilder/MultiQuickPrompt This is the multi-finding counterpart of [/Quippe/NoteBuilder/QuickPrompt](/api-reference/rest/get-quippe-note-builder-quick-prompt): it activates every ID in `Quippe.MultiQuickPromptHandler.MedcinIds` against the MEDCIN knowledge base and returns one merged prompt list. For a single-finding prompt, use [/Quippe/NoteBuilder/QuickPrompt](/api-reference/rest/get-quippe-note-builder-quick-prompt) 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

MedcinIdsstringRequired

The MEDCIN ids of the findings (diagnoses, symptoms, or other terms) to prompt from. The returned list contains the terms that the MEDCIN knowledge base associates with all of these findings combined.

ListSizeenumOptional

Controls how many related terms are returned in the prompt list. Values: Small, Medium (default), Large. Small provides the hallmark findings for a given diagnosis or term, while other values will cast a progressively wider net when looking for related terms.

Allowed values:
RoleenumOptional

The clinician role (e.g. physician, nurse) recording the findings. When set to a value other than medNoneEntering, the MEDCIN knowledge base’s active doctor ID is switched to this role before the prompt list is built, which can change which terms are returned.

Allowed values:
TermPropertiesstringOptional

Comma-separated list of additional term properties to be included with each term in the result list.

PatientIdstringOptional
The patient's identifier in the EHR.
EncounterTimestringOptional
The date of the encounter that this operation is for.
GroupingFlagsenumOptional
Options to control default group assignments for findings.
Allowed values:
ResolvePhrasesbooleanOptional
Flag indicating whether the text phrases used to render a given finding for the user should be returned.
BuilderVersionintegerOptional

Controls how the note builder is instantiated to resolve terms. 1 will always use a Quippe.NoteBuilder object, while other values will instatiate a Quippe.INoteBuilderService instance from the list of registered data services, allowing for customization of the term resolution process.

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