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

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::RxNormEntity

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Array<Types::RxNormAttribute>

  The extracted attributes that relate to the entity.

• #begin_offset ⇒ Integer

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

• #category ⇒ String

  The category of the entity.

• #end_offset ⇒ Integer

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

• #id ⇒ Integer

  The numeric identifier for the entity.

• #rx_norm_concepts ⇒ Array<Types::RxNormConcept>

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

• #score ⇒ Float

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

• #text ⇒ String

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

• #traits ⇒ Array<Types::RxNormTrait>

  Contextual information for the entity.

• #type ⇒ String

  Describes the specific type of entity.

Instance Attribute Details

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

• (Array<Types::RxNormAttribute>)

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

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

#begin_offset ⇒ Integer

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)

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

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

#category ⇒ String

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

Returns:

• (String)

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

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

#end_offset ⇒ Integer

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)

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

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

#id ⇒ Integer

The numeric identifier for the entity. 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 1355

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_concepts ⇒ Array<Types::RxNormConcept>

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

Returns:

• (Array<Types::RxNormConcept>)

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

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

#score ⇒ Float

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

Returns:

• (Float)

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

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

#text ⇒ String

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

Returns:

• (String)

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

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

#traits ⇒ Array<Types::RxNormTrait>

Contextual information for the entity.

Returns:

• (Array<Types::RxNormTrait>)

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

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

#type ⇒ String

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

Returns:

• (String)

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

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