Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

InferRxNorm

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.

Request Syntax


{
   "Text": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Text

The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10000.

Required: Yes

Response Syntax


{
   "Entities": [ 
      { 
         "Attributes": [ 
            { 
               "BeginOffset": number,
               "EndOffset": number,
               "Id": number,
               "RelationshipScore": number,
               "Score": number,
               "Text": "string",
               "Traits": [ 
                  { 
                     "Name": "string",
                     "Score": number
                  }
               ],
               "Type": "string"
            }
         ],
         "BeginOffset": number,
         "Category": "string",
         "EndOffset": number,
         "Id": number,
         "RxNormConcepts": [ 
            { 
               "Code": "string",
               "Description": "string",
               "Score": number
            }
         ],
         "Score": number,
         "Text": "string",
         "Traits": [ 
            { 
               "Name": "string",
               "Score": number
            }
         ],
         "Type": "string"
      }
   ],
   "ModelVersion": "string",
   "PaginationToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entities

The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

Type: Array of RxNormEntity objects

ModelVersion

The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

Type: String

Length Constraints: Minimum length of 1.

PaginationToken

If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidEncodingException

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

HTTP Status Code: 400

InvalidRequestException

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

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 400

TextSizeLimitExceededException

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.

HTTP Status Code: 400

TooManyRequestsException

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.

HTTP Status Code: 400