Score Note

View as Markdown
Scores the documentation quality of a clinical note (chart note scoring / documentation completeness scoring) for one or more diagnoses. Given a chart and a set of diagnosis MEDCIN IDs — or, if none are supplied, the diagnoses already coded in the chart — the ScoreNote API (POST /Quippe/ChartReview/ScoreNote) checks whether the chart contains Subjective, Objective, Assessment, and Plan (SOAP) evidence supporting each diagnosis and returns a numeric score along with the record IDs that contributed to it. Common uses include clinical documentation improvement (CDI) review, auditing a note for missing SOAP elements before signing, and flagging diagnoses that lack supporting documentation. POST /Quippe/ChartReview/ScoreNote For each evaluated diagnosis, the score is 0 when no Assessment (SOAPCategory "A") evidence is found; 1 when Assessment evidence exists but Subjective, Objective, and Plan are not all present; and 2 when all four SOAP categories (S, O, A, P) are present. The score is further incremented by 1 when the note also qualifies for a higher-complexity E/M level, so the maximum score is 3. The response is a `NoteScores` element containing one `Item` per evaluated diagnosis, each with the diagnosis `MedcinId`, its `Text` description, the computed `Score`, and a comma-separated `TargetIds` list of the chart record IDs that were counted as evidence.

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

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.
ChartstringRequired

The chart note to score, as XML (or another format recognized via InputFormat). Passed to the ScoreNote API and parsed into its constituent records before scoring; parsing failures cause the request to fail with an error describing the parse problem.

DiagnosesstringOptional
A list of diagnosis MEDCIN IDs to score the chart against. If not specified, the diagnoses already coded as an unqualified, non-negated Assessment (SOAPCategory "A") in the chart are used instead. If no diagnoses are supplied and none can be found in the chart, the ScoreNote API returns an empty `NoteScores` result.
ScoringMethodintegerOptional

Reserved for selecting an alternate scoring algorithm. Accepted but not currently applied by the ScoreNote API, which always uses its default SOAP-category scoring.

InputFormatstringOptional

Indicates the mime type of the Chart input parameter, such as “application/vnd.medicomp.quippe.note+xml”. If left blank, the ScoreNote API attempts to deduce the format from the content of Chart.

Response

Successful response
noteScoreslist of objectsOptional

Errors

401
Unauthorized Error
500
Internal Server Error