API ReferenceQuippeNote Builder

Resolve Terms

View as Markdown
Resolves a batch of MEDCIN findings (by MEDCIN ID) into a fully built note list in a single call, the way each finding would appear as a line item in a clinical note. The ResolveTerms API (GET /Quippe/NoteBuilder/ResolveTerms) wraps the given MEDCIN IDs in a `List` array and runs them through the same NoteBuilder pipeline used to build a full note, returning each as a resolved term with display text, node key, term type, and phrasing. Common uses include previewing a group of findings before adding them to a note (for example the results of a search or text recognition), and building a prompt or checklist of terms tagged for a specific workflow. GET /Quippe/NoteBuilder/ResolveTerms Use this endpoint to resolve many findings at once. To resolve a single finding, use [/Quippe/NoteBuilder/Resolve](/api-reference/rest/get-quippe-note-builder-resolve). To resolve an entire chart document instead of a flat list of MEDCIN IDs, use [/Quippe/NoteBuilder/ResolveDocument](/api-reference/rest/post-quippe-note-builder-resolve-document).

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 findings to resolve, identified by their numeric MEDCIN IDs. Each ID becomes one Item in the resolved List, in the order given.

PrefixstringOptional

Optional MEDCIN prefix qualifier applied to every ID in MedcinIds — the prefix positions the findings in context, such as a family-history or “history of” framing. This single prefix applies uniformly to the whole list; it cannot be set per finding.

ListIdstringOptional

Optional identifier written to the resolved List’s id property, letting a caller correlate this resolved list with the list it was requested for.

ListDescriptionstringOptional

Optional display text written to the resolved List’s Text property (for example a heading such as “Search Results” or “Favorites”).

ListTypestringOptional

The kind of list being resolved, written to the resolved List’s ListType property (for example Prompt, the default, for a clinical prompt list). Consumers use this to decide how to render or group the resolved list.

TagsstringOptional
Comma separated list of term tags that should be applied to search results
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