Class: Aws::ComprehendMedical::Types::SNOMEDCTAttribute

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::SNOMEDCTAttribute

Defined in:

gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

The extracted attributes that relate to an entity. 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.

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.

• #category ⇒ String

  The category of the detected attribute.

• #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 this attribute is correctly related to this entity.

• #relationship_type ⇒ String

  The type of relationship that exists between the entity and the related attribute.

• #score ⇒ Float

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

• #snomedct_concepts ⇒ Array<Types::SNOMEDCTConcept>

  The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

• #text ⇒ String

  The segment of input text extracted as this attribute.

• #traits ⇒ Array<Types::SNOMEDCTTrait>

  Contextual information for an 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 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1456

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

#category ⇒ String

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

Returns:

• (String)

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

class SNOMEDCTAttribute < Struct.new(
  :category,
  :type,
  :score,
  :relationship_score,
  :relationship_type,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits,
  :snomedct_concepts)
  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 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1456

class SNOMEDCTAttribute < Struct.new(
  :category,
  :type,
  :score,
  :relationship_score,
  :relationship_type,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits,
  :snomedct_concepts)
  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 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1456

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

#relationship_score ⇒ Float

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

Returns:

• (Float)

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

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

#relationship_type ⇒ String

The type of relationship that exists between the entity and the related attribute.

Returns:

• (String)

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

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

#score ⇒ Float

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

Returns:

• (Float)

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

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

#snomedct_concepts ⇒ Array<Types::SNOMEDCTConcept>

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Returns:

• (Array<Types::SNOMEDCTConcept>)

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

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

#text ⇒ String

The segment of input text extracted as this attribute.

Returns:

• (String)

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

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

#traits ⇒ Array<Types::SNOMEDCTTrait>

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Returns:

• (Array<Types::SNOMEDCTTrait>)

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

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

#type ⇒ String

The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.

Returns:

• (String)

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

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