AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ComprehendMedical::Types::RxNormEntity

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::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.

Returns:



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#begin_offsetInteger

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.

Returns:

  • (Integer)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#categoryString

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

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#end_offsetInteger

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.

Returns:

  • (Integer)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#idInteger

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

Returns:

  • (Integer)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#rx_norm_conceptsArray<Types::RxNormConcept>

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

Returns:



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#scoreFloat

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

Returns:

  • (Float)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#textString

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

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#traitsArray<Types::RxNormTrait>

Contextual information for the entity.

Returns:



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1374

class RxNormEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :rx_norm_concepts)
  SENSITIVE = []
  include Aws::Structure
end