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::RxNormAttribute

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offsetInteger

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.

Returns:

  • (Integer)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#end_offsetInteger

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.

Returns:

  • (Integer)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#idInteger

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

Returns:

  • (Integer)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#relationship_scoreFloat

The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

Returns:

  • (Float)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#scoreFloat

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

Returns:

  • (Float)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#textString

The segment of input text which corresponds to the detected attribute.

Returns:

  • (String)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#traitsArray<Types::RxNormTrait>

Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

Returns:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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

#typeString

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

Returns:

  • (String)


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1274

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