Attribute - Amazon Comprehend

Attribute

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

Contents

BeginOffset

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

Type: Integer

Required: No

Category

The category of attribute.

Type: String

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

Required: No

EndOffset

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

Type: Integer

Required: No

Id

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

Type: Integer

Required: No

RelationshipScore

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

Type: Float

Required: No

RelationshipType

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

Type: String

Valid Values: EVERY | WITH_DOSAGE | ADMINISTERED_VIA | FOR | NEGATIVE | OVERLAP | DOSAGE | ROUTE_OR_MODE | FORM | FREQUENCY | DURATION | STRENGTH | RATE | ACUITY | TEST_VALUE | TEST_UNITS | DIRECTION | SYSTEM_ORGAN_SITE

Required: No

Score

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Type: Float

Required: No

Text

The segment of input text extracted as this attribute.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Traits

Contextual information for this attribute.

Type: Array of Trait objects

Required: No

Type

The type of attribute.

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 | TIME_EXPRESSION | TIME_TO_MEDICATION_NAME | TIME_TO_DX_NAME | TIME_TO_TEST_NAME | TIME_TO_PROCEDURE_NAME | TIME_TO_TREATMENT_NAME

Required: No

See Also

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