For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scores a patient's charted findings against the conditions (diagnoses) present in the same chart, flagging which documented findings support or relate to which conditions. Also known as clinical documentation improvement (CDI) scoring or clinical relevance scoring, the ScoreChart API (POST /Quippe/ClinicalLens/ScoreChart) takes a chart of coded entries, identifies condition (diagnosis) entries within it, uses MEDCIN prompting logic to build small/large/full lists of findings clinically associated with each condition, and annotates every non-condition finding in the chart with the conditions it supports.
Common uses include clinical documentation improvement (CDI) review, surfacing evidence in a note that justifies a billed or coded diagnosis, and highlighting findings that appear unrelated to any documented condition.
POST /Quippe/ClinicalLens/ScoreChart
The request body's coded entries are supplied and returned via the shared `CodedEntries` schema (the same coded-chart shape used elsewhere in the API). For each condition entry found in the chart (or, if `Sources` is supplied, for each MEDCIN ID, external code, or content library item listed there instead), three MEDCIN prompt lists are built: a small list, a large list, and a full list. Every other finding in the chart is compared against these lists, and when a match is found an `AssociatedFindings/Finding` is appended to that finding's entry, carrying the matched condition's code, vocabulary, and a `Score` of 1, 2, or 3 indicating whether the match came from the small, large, or full prompt list respectively (lower scores indicate a tighter clinical association). Prompt lists can be overridden per condition by tagged content library items (see `UseContentOverride` and `ContentPrefix`) instead of the built-in MEDCIN prompting logic.
A finding that matches no condition's prompt lists is left without an `AssociatedFindings` rather than causing an error, so callers should treat a missing element as "unrelated to any documented condition" rather than a failure. When a source entry also matches a content library item (rather than only the built-in MEDCIN logic), the finding additionally gets an `AssociatedContentLibraryItems/Item` identifying the matching content library item(s) by ID and name.
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.
CodedEntriesXMLstringRequired
Coded data from the patient's chart that we want to score.
UseContentOverridebooleanOptional
Flag indicating whether you wish to look in the user's content library for custom prompt lists that have been tagged to override the default MEDCIN prompting logic for a given MEDCIN ID.
BroadPromptMethodintegerOptional
When developing the scoring for level 3 (the broad prompt), this controls the logic that we use. 0 or 1 means we match any specialties for the chart item against any specialties for the condition. 2 means we match any specialties for the chart item against the primary specialty for the condition. 3 means we match against any items in the ICD10WHO category for the condition.
IncludeMedcinMetadatabooleanOptional
Flag indicating whether you want the mapped MEDCIN ID and prefix to be included in the response data.
ExpandOnAllDxbooleanOptional
When you prompt on a condition that is simply a pointer to a set of other conditions, this flag controls whether we combine the prompt results for all of those other conditions.
ContentPrefixstringOptional
When looking in the user's content library for custom prompt lists, this is the prefix that should be used when searching for tags that indicate a custom prompt list.
ExpandLabPanelsbooleanOptional
Flag indicating whether we should expand lab panels in the prompt results to include the components of the lab panel.
SourcesstringOptional
List of sources that the chart data should be scored against. If this is not specified, we look for conditions in the provided chart data. If it is specified, it can be a comma separated list of MEDCIN IDs, external codes (in the format of “vocab_code:code”), or content library item IDs.
Response
Successful response
codedEntriesobjectOptional
Errors
401
Unauthorized Error
500
Internal Server Error
Scores a patient’s charted findings against the conditions (diagnoses) present in the same chart, flagging which documented findings support or relate to which conditions. Also known as clinical documentation improvement (CDI) scoring or clinical relevance scoring, the ScoreChart API (POST /Quippe/ClinicalLens/ScoreChart) takes a chart of coded entries, identifies condition (diagnosis) entries within it, uses MEDCIN prompting logic to build small/large/full lists of findings clinically associated with each condition, and annotates every non-condition finding in the chart with the conditions it supports.
Common uses include clinical documentation improvement (CDI) review, surfacing evidence in a note that justifies a billed or coded diagnosis, and highlighting findings that appear unrelated to any documented condition.
POST /Quippe/ClinicalLens/ScoreChart
The request body’s coded entries are supplied and returned via the shared CodedEntries schema (the same coded-chart shape used elsewhere in the API). For each condition entry found in the chart (or, if Sources is supplied, for each MEDCIN ID, external code, or content library item listed there instead), three MEDCIN prompt lists are built: a small list, a large list, and a full list. Every other finding in the chart is compared against these lists, and when a match is found an AssociatedFindings/Finding is appended to that finding’s entry, carrying the matched condition’s code, vocabulary, and a Score of 1, 2, or 3 indicating whether the match came from the small, large, or full prompt list respectively (lower scores indicate a tighter clinical association). Prompt lists can be overridden per condition by tagged content library items (see UseContentOverride and ContentPrefix) instead of the built-in MEDCIN prompting logic.
A finding that matches no condition’s prompt lists is left without an AssociatedFindings rather than causing an error, so callers should treat a missing element as “unrelated to any documented condition” rather than a failure. When a source entry also matches a content library item (rather than only the built-in MEDCIN logic), the finding additionally gets an AssociatedContentLibraryItems/Item identifying the matching content library item(s) by ID and name.
When developing the scoring for level 3 (the broad prompt), this controls the logic that we use. 0 or 1 means we match any specialties for the chart item against any specialties for the condition. 2 means we match any specialties for the chart item against the primary specialty for the condition. 3 means we match against any items in the ICD10WHO category for the condition.