API ReferenceQuippeText Recognition

Recognize

View as Markdown
Recognizes structured medical terminology within free-text clinical notes — clinical natural-language processing (NLP), also described as medical named-entity recognition (NER) or automated clinical text encoding. Given the text of a patient note, the Recognize API (POST /Quippe/TextRecognition/Recognize) locates medical concepts in the text and returns each as a MEDCIN finding tagged with its character position and a confidence score, so narrative documentation can be turned into coded, structured clinical data. The findings this returns can then be mapped to standard vocabularies (ICD-10, SNOMED CT, CPT, and others) using the coding endpoints. Common uses include converting plain text to codes, extracting problems, symptoms, medications, and findings from dictated/ambient listening or typed notes, and structuring free text captured in an EHR. POST /Quippe/TextRecognition/Recognize This endpoint is the front of the coding pipeline: free text in, MEDCIN findings out. To then map those findings to other vocabularies, use [/Quippe/Coding/ChartMap](/api-reference/rest/post-quippe-coding-chart-map) for a whole chart of findings, or [/Quippe/Coding/TranslateItem](/api-reference/rest/get-quippe-coding-translate-item) for a single code. To search the MEDCIN terminology directly instead of recognizing it from prose, use [/Quippe/Search](/api-reference/rest/get-quippe-search).

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

ResolveFindingsbooleanOptional

When true (default), resolves each recognized finding through the NoteBuilder, enriching results with additional structure (nodeKey, term type, phrasing, and refined display text) as they would appear in a built note. Set false to return raw recognition results without the resolve pass.

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

The clinical text to analyze — typically a patient note or a section of one, as plain text.

DocumentTypestringOptional

Document type of the note (for example a progress note or H&P), used as context to guide recognition.

DocumentSectionstringOptional

Identifier of the section within the document that the text came from (for example an HPI or assessment section), used as recognition context.

ServiceTypestringOptional

Type of service being provided, using service codes from the E/M guidelines, used as recognition context. The list of valid service codes is available at /Medcin/Enums/Services.

ClinicalSettingstringOptional

Clinical setting where the service is provided (for example inpatient or emergency department), using setting codes from the E/M guidelines, used as recognition context. The list of valid setting codes is available at /Medcin/Enums/Settings.

ProvideRolestringOptional
Role of the provider authoring the note, used as recognition context.
ProviderSpecialtystringOptional

Provider specialty, used as recognition context to bias results toward specialty-relevant findings. The list of valid specialty codes is available at /Medcin/Enums/Specialty.

PatientIdstringOptional

Patient identifier, used to look up patient age and sex from the configured patient data provider so recognition can apply age- and sex-appropriate context. Requires an IPatientDataService.

EncounterTimestringOptional

Eencounter date/time, used with PatientId to compute the patient’s age at the time of the encounter. Defaults to the current time when a patient is resolved.

RecognitionProviderstringOptional

Name of the text-recognition provider to use, for installations configured with more than one. Leave blank (default) to use the default provider.

SettingsstringOptional

Provider-specific recognition settings, supplied as a JSON object. The accepted keys depend on the selected RecognitionProvider. Defaults to none.

Response

Successful response
taggedTextobjectOptional

Errors

401
Unauthorized Error
500
Internal Server Error