Amazon Comprehend
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Entity

Provides information about an extracted medical entity.

Contents

Attributes

The extracted attributes that relate to this entity.

Type: Array of Attribute 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.

Type: String

Valid Values: MEDICATION | MEDICAL_CONDITION | PROTECTED_HEALTH_INFORMATION | TEST_TREATMENT_PROCEDURE | ANATOMY

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

Score

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

Type: Float

Required: No

Text

The segment of input text extracted as this entity.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Traits

Contextual information for the entity

Type: Array of Trait objects

Required: No

Type

Describes the specific type of entity with category of entities.

Type: String

Valid Values: NAME | DOSAGE | ROUTE_OR_MODE | FORM | FREQUENCY | DURATION | GENERIC_NAME | BRAND_NAME | STRENGTH | RATE | ACUITY | TEST_NAME | TEST_VALUE | TEST_UNITS | PROCEDURE_NAME | TREATMENT_NAME | DATE | AGE | CONTACT_POINT | EMAIL | IDENTIFIER | URL | ADDRESS | PROFESSION | SYSTEM_ORGAN_SITE | DIRECTION | QUALITY | QUANTITY

Required: No

See Also

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

On this page: