API ReferenceQuippeNote Builder

Resolve Document

View as Markdown
Resolves an entire chart or note document — every MEDCIN finding found with a `MedcinId` attribute, no matter how deeply nested — into fully built note terms in a single pass. The ResolveDocument API (POST /Quippe/NoteBuilder/ResolveDocument) runs the whole document through the same NoteBuilder pipeline used to render a live note, expanding each finding into its display text, node key, term type, and phrasing in place. Common uses include re-resolving a saved or imported chart document after it's loaded outside the normal note-building flow, and resolving a large list of findings with different MEDCIN metadata properties, like prefix and modifier, associated with them. POST /Quippe/NoteBuilder/ResolveDocument Use this endpoint to resolve an entire chart document at once. To resolve a single finding, use [/Quippe/NoteBuilder/Resolve](/api-reference/rest/get-quippe-note-builder-resolve). To resolve a flat list of MEDCIN IDs instead of a chart document, use [/Quippe/NoteBuilder/ResolveTerms](/api-reference/rest/get-quippe-note-builder-resolve-terms).

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

PrePopulatebooleanOptional

When true and the document’s root element is a Document flagged with AutoPopulate, the registered Quippe.INoteAutoPopulationService is invoked before resolution to fill in dynamic content (such as data pulled from an EHR) for any auto-populate groups in the template.

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.

Request

This endpoint expects an object.
Datalist of objectsRequired

Response

Successful response

Errors

401
Unauthorized Error
500
Internal Server Error