Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • RxNormEntity

Index

Properties

Optional Attributes

Attributes: RxNormAttribute[]

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

Optional BeginOffset

BeginOffset: undefined | number

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.

Optional Category

Category: RxNormEntityCategory | string

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

Optional EndOffset

EndOffset: undefined | number

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.

Optional Id

Id: undefined | number

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

Optional RxNormConcepts

RxNormConcepts: RxNormConcept[]

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

Optional Score

Score: undefined | number

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

Optional Text

Text: undefined | string

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

Optional Traits

Traits: RxNormTrait[]

Contextual information for the entity.

Optional Type

Type: RxNormEntityType | string

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