Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class InferRxNormCommandProtected

InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

Example

Use a bare-bones client and the command you need to make an API call.

import { ComprehendMedicalClient, InferRxNormCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import
// const { ComprehendMedicalClient, InferRxNormCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import
const client = new ComprehendMedicalClient(config);
const input = { // InferRxNormRequest
Text: "STRING_VALUE", // required
};
const command = new InferRxNormCommand(input);
const response = await client.send(command);
// { // InferRxNormResponse
// Entities: [ // RxNormEntityList // required
// { // RxNormEntity
// Id: Number("int"),
// Text: "STRING_VALUE",
// Category: "MEDICATION",
// Type: "BRAND_NAME" || "GENERIC_NAME",
// Score: Number("float"),
// BeginOffset: Number("int"),
// EndOffset: Number("int"),
// Attributes: [ // RxNormAttributeList
// { // RxNormAttribute
// Type: "DOSAGE" || "DURATION" || "FORM" || "FREQUENCY" || "RATE" || "ROUTE_OR_MODE" || "STRENGTH",
// Score: Number("float"),
// RelationshipScore: Number("float"),
// Id: Number("int"),
// BeginOffset: Number("int"),
// EndOffset: Number("int"),
// Text: "STRING_VALUE",
// Traits: [ // RxNormTraitList
// { // RxNormTrait
// Name: "NEGATION" || "PAST_HISTORY",
// Score: Number("float"),
// },
// ],
// },
// ],
// Traits: [
// {
// Name: "NEGATION" || "PAST_HISTORY",
// Score: Number("float"),
// },
// ],
// RxNormConcepts: [ // RxNormConceptList
// { // RxNormConcept
// Description: "STRING_VALUE",
// Code: "STRING_VALUE",
// Score: Number("float"),
// },
// ],
// },
// ],
// PaginationToken: "STRING_VALUE",
// ModelVersion: "STRING_VALUE",
// };

Param

InferRxNormCommandInput

Returns

InferRxNormCommandOutput

See

Throws

InternalServerException (server fault)

An internal server error occurred. Retry your request.

Throws

InvalidEncodingException (client fault)

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

Throws

InvalidRequestException (client fault)

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

Throws

ServiceUnavailableException (server fault)

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

Throws

TextSizeLimitExceededException (client fault)

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

Throws

TooManyRequestsException (client fault)

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

Throws

ComprehendMedicalServiceException

Base exception class for all service exceptions from ComprehendMedical service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods