API ReferenceQuippeNote Builder

Quick Prompt

View as Markdown
Generates a MEDCIN "quick prompt" (nomenclature/differential list) for a single finding — the list of related MEDCIN terms (associated symptoms, tests, therapies, and diagnoses) that clinicians pick from to build out a note after entering a diagnosis or symptom. The QuickPrompt API (GET /Quippe/NoteBuilder/QuickPrompt) takes one MEDCIN ID and returns a list of related terms sized and filtered for interactive charting. Common uses include populating the pick-list shown immediately after a user selects a diagnosis or chief complaint, structured symptom review, and driving point-of-care documentation workflows that prompt the clinician for related findings. GET /Quippe/NoteBuilder/QuickPrompt This endpoint prompts from a single MEDCIN ID. To prompt from several findings at once (e.g. all the diagnoses already on a chart) in one call, use [/Quippe/NoteBuilder/MultiQuickPrompt](/api-reference/rest/get-quippe-note-builder-multi-quick-prompt) instead, which accepts an array of MEDCIN IDs and otherwise behaves the same way.

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

MedcinIdintegerRequired

The MEDCIN id of the finding (diagnosis, symptom, or other term) to prompt from. The returned list contains the terms that the MEDCIN knowledgebase associates with this finding.

OnsetstringOptional

The onset date/time of the finding, used together with the patient’s birth date to compute the finding’s age-of-onset for the prompt operation. If omitted and Quippe.QuickPromptHandler.Duration is supplied, onset is derived by subtracting the duration from the encounter time instead.

DurationstringOptional

How long the finding has been present (e.g. “3 days”), expressed as a duration string understood by Quippe.DateUtil.GetDurationInMinutes(). Used to compute Quippe.QuickPromptHandler.Onset when Quippe.QuickPromptHandler.Onset is not explicitly supplied.

PrefixstringOptional

Reserved for future use; not currently read by the QuickPrompt handler.

ResultstringOptional

Reserved for future use; not currently read by the QuickPrompt handler.

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:
ScaleintegerOptional

Reserved for future use; not currently read by the QuickPrompt handler.

RoleenumOptional

The clinician role (e.g. physician, nurse) recording the finding. 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