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

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

The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

Returns:



747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

class ICD10CMEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :icd10cm_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)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#categoryString

The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

Returns:

  • (String)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

class ICD10CMEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :icd10cm_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)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#icd10cm_conceptsArray<Types::ICD10CMConcept>

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Returns:



747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

class ICD10CMEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :icd10cm_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)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#scoreFloat

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

Returns:

  • (Float)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#textString

The segment of input text that is matched to the detected entity.

Returns:

  • (String)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#traitsArray<Types::ICD10CMTrait>

Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

Returns:



747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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

#typeString

Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

Returns:

  • (String)


747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 747

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