RxNormEntity - Amazon Comprehend

RxNormEntity

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

Contents

Attributes

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

Type: Array of RxNormAttribute objects

Required: No

BeginOffset

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Type: Integer

Required: No

Category

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Type: String

Valid Values: MEDICATION

Required: No

EndOffset

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Type: Integer

Required: No

Id

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Type: Integer

Required: No

RxNormConcepts

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Type: Array of RxNormConcept objects

Required: No

Score

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Type: Float

Required: No

Text

The segment of input text extracted from which the entity was detected.

Type: String

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

Required: No

Traits

Contextual information for the entity.

Type: Array of RxNormTrait objects

Required: No

Type

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

Type: String

Valid Values: BRAND_NAME | GENERIC_NAME

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: