API ReferenceQuippeCoding

Translate Items

View as Markdown

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

SourceVocabularystringRequired

The unique string code of the source vocabulary to translate from. The list of supported vocabularies can be retrieved from the /Quippe/Coding/Vocabs endpoint.

SourceCodestringRequired

Comma-separate list of source codes to translate.

TargetVocabularystringRequired
The vocabulary to translate into — the vocabulary of the codes returned in each `Entry/@Code`. Common values: `icd10` (ICD-10-CM), `icd10pcs`, `cpt`, `hcpcs`, `snomed`, `loinc`, `rxnorm`. Note that `icd` is ICD-9-CM, not ICD-10 — use `icd10` for ICD-10-CM. Not every source/target pair has maps; a pair with no maps returns an empty `Map` element. The list of supported vocabularies can be retrieved from the [/Quippe/Coding/Vocabs](/api-reference/rest/get-quippe-coding-vocabs) endpoint.
PrefixstringOptional

Optional MEDCIN prefix qualifier for the source code — the prefix positions a finding in context, such as a family-history or “history of” framing. Applies only when SourceVocabulary is a MEDCIN vocabulary and SourceCode is numeric; ignored otherwise, and affects which target codes the translation produces.

ResultstringOptional

Optional MEDCIN result qualifier for the source code — for example to indicate a positive vs. negative finding. Applies only when SourceVocabulary is a MEDCIN vocabulary and SourceCode is numeric; ignored otherwise.

StatusstringOptional

Optional MEDCIN status qualifier for the source code — for example to mark a finding as absent, resolved, or historical rather than currently present. Applies only when SourceVocabulary is a MEDCIN vocabulary and SourceCode is numeric; ignored otherwise.

ModifierstringOptional

Optional MEDCIN modifier qualifier for the source code, refining the finding (for example laterality or severity). Applies only when SourceVocabulary is a MEDCIN vocabulary and SourceCode is numeric; ignored otherwise.

SpecifierstringOptional

Optional MEDCIN specification string for the source code, carrying the finding’s post-coordinated detail. Applies only when SourceVocabulary is a MEDCIN vocabulary and SourceCode is numeric; ignored otherwise.

AgeintegerOptional

Optional patient age in minutes, used as translation context for age-specific MEDCIN source findings. MEDCIN expresses age in minutes for neonatal/pediatric precision; for example 1 year is about 525,960 minutes. Applies only to MEDCIN source codes. Defaults to 0 (no age context).

SexstringOptional

Optional patient sex (M or F), used as translation context for sex-specific MEDCIN source findings. Applies only to MEDCIN source codes. Leave blank (default) for no sex context.

ValuestringOptional

Optional test or measurement value for the source code — for example a numeric result attached to a MEDCIN finding that carries a value. Applies only to MEDCIN source codes. Defaults to none.

EncounterTimestringOptional
The optional encounter date and time associated with an item.
AutoGenerateMapsbooleanOptional
Indicates whether maps from qualified MEDCIN concepts should be automatically generated where applicable if no maps are available.
LimitintegerOptional
Limits the number of maps returned. Defaults to no limit.
RelationshipFilterstringOptional
Limits the maps to only those with the specified relationship.
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
mapslist of objectsOptional

Errors

401
Unauthorized Error
500
Internal Server Error