API ReferenceQuippeNote Builder

Resolve

View as Markdown
Resolves a single MEDCIN finding (by MEDCIN ID) into a fully built note term, the way it would appear as a line item in a clinical note. The Resolve API (GET /Quippe/NoteBuilder/Resolve) expands the bare MEDCIN ID and its optional qualifiers into a rendered term with display text, node key, term type, and phrasing, driven through the same NoteBuilder pipeline used when building a full note. Common uses include previewing how a single finding will read before adding it to a note, resolving a term picked from search or autocomplete, and re-resolving a term after its qualifiers (prefix, result, value) change. GET /Quippe/NoteBuilder/Resolve Use this endpoint to resolve one finding at a time. To resolve a whole list of MEDCIN IDs in one call, use [/Quippe/NoteBuilder/ResolveTerms](/api-reference/rest/get-quippe-note-builder-resolve-terms). To resolve an entire chart document instead of a single finding, 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

MedcinIdintegerRequired

The MEDCIN finding to resolve, identified by its numeric MEDCIN ID (the Resolve endpoint’s primary key for the term).

PrefixstringOptional

Optional MEDCIN prefix qualifier applied to MedcinId — the prefix positions the finding in context, such as a family-history or “history of” framing.

ResultstringOptional

Optional MEDCIN result qualifier applied to MedcinId — for example to indicate a positive vs. negative finding.

ValuestringOptional

Optional test or measurement value for the finding, carried through to the resolved term (for example a lab result or vital sign reading associated with MedcinId).

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
termobjectOptional

Errors

401
Unauthorized Error
500
Internal Server Error