Class: Aws::ComprehendMedical::Types::RxNormAttribute

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::RxNormAttribute

Includes:

Structure

Defined in:

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset ⇒ Integer

  The 0-based character offset in the input text that shows where the attribute begins.

• #end_offset ⇒ Integer

  The 0-based character offset in the input text that shows where the attribute ends.

• #id ⇒ Integer

  The numeric identifier for this attribute.

• #relationship_score ⇒ Float

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

• #score ⇒ Float

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

• #text ⇒ String

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

• #traits ⇒ Array<Types::RxNormTrait>

  Contextual information for the attribute.

• #type ⇒ String

  The type of attribute.

Instance Attribute Details

#begin_offset ⇒ Integer

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)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#end_offset ⇒ Integer

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)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#id ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#relationship_score ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#score ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#text ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#traits ⇒ Array<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:

• (Array<Types::RxNormTrait>)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1263

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