SNOMEDCTEntity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehendmedical.model.SNOMEDCTEntity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SNOMEDCTEntity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SNOMEDCTEntity()

Constructors
Constructor and Description
`SNOMEDCTEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SNOMEDCTEntity`	`clone()`
`boolean`	`equals(Object obj)`
`List<SNOMEDCTAttribute>`	`getAttributes()` 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.
`Integer`	`getBeginOffset()` The 0-based character offset in the input text that shows where the entity begins.
`String`	`getCategory()` The category of the detected entity.
`Integer`	`getEndOffset()` The 0-based character offset in the input text that shows where the entity ends.
`Integer`	`getId()` The numeric identifier for the entity.
`Float`	`getScore()` The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
`List<SNOMEDCTConcept>`	`getSNOMEDCTConcepts()` The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`String`	`getText()` The segment of input text extracted as this entity.
`List<SNOMEDCTTrait>`	`getTraits()` Contextual information for the entity.
`String`	`getType()` Describes the specific type of entity with category of entities.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Collection<SNOMEDCTAttribute> attributes)` 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.
`void`	`setBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`void`	`setCategory(String category)` The category of the detected entity.
`void`	`setEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`void`	`setId(Integer id)` The numeric identifier for the entity.
`void`	`setScore(Float score)` The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
`void`	`setSNOMEDCTConcepts(Collection<SNOMEDCTConcept> sNOMEDCTConcepts)` The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`void`	`setText(String text)` The segment of input text extracted as this entity.
`void`	`setTraits(Collection<SNOMEDCTTrait> traits)` Contextual information for the entity.
`void`	`setType(String type)` Describes the specific type of entity with category of entities.
`String`	`toString()` Returns a string representation of this object.
`SNOMEDCTEntity`	`withAttributes(Collection<SNOMEDCTAttribute> attributes)` 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.
`SNOMEDCTEntity`	`withAttributes(SNOMEDCTAttribute... attributes)` 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.
`SNOMEDCTEntity`	`withBeginOffset(Integer beginOffset)` The 0-based character offset in the input text that shows where the entity begins.
`SNOMEDCTEntity`	`withCategory(SNOMEDCTEntityCategory category)` The category of the detected entity.
`SNOMEDCTEntity`	`withCategory(String category)` The category of the detected entity.
`SNOMEDCTEntity`	`withEndOffset(Integer endOffset)` The 0-based character offset in the input text that shows where the entity ends.
`SNOMEDCTEntity`	`withId(Integer id)` The numeric identifier for the entity.
`SNOMEDCTEntity`	`withScore(Float score)` The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
`SNOMEDCTEntity`	`withSNOMEDCTConcepts(Collection<SNOMEDCTConcept> sNOMEDCTConcepts)` The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`SNOMEDCTEntity`	`withSNOMEDCTConcepts(SNOMEDCTConcept... sNOMEDCTConcepts)` The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`SNOMEDCTEntity`	`withText(String text)` The segment of input text extracted as this entity.
`SNOMEDCTEntity`	`withTraits(Collection<SNOMEDCTTrait> traits)` Contextual information for the entity.
`SNOMEDCTEntity`	`withTraits(SNOMEDCTTrait... traits)` Contextual information for the entity.
`SNOMEDCTEntity`	`withType(SNOMEDCTEntityType type)` Describes the specific type of entity with category of entities.
`SNOMEDCTEntity`	`withType(String type)` Describes the specific type of entity with category of entities.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SNOMEDCTEntity
```
public SNOMEDCTEntity()
```
- Method Detail
  - setId
```
public void setId(Integer id)
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - getId
```
public Integer getId()
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
  - withId
```
public SNOMEDCTEntity withId(Integer id)
```
    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Parameters:
    
    id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The segment of input text extracted as this entity.
    
    Parameters:
    
    text - The segment of input text extracted as this entity.
  - getText
```
public String getText()
```
    The segment of input text extracted as this entity.
    
    Returns:
    
    The segment of input text extracted as this entity.
  - withText
```
public SNOMEDCTEntity withText(String text)
```
    The segment of input text extracted as this entity.
    
    Parameters:
    
    text - The segment of input text extracted as this entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategory
```
public void setCategory(String category)
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Parameters:
    
    category - The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - getCategory
```
public String getCategory()
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Returns:
    
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - withCategory
```
public SNOMEDCTEntity withCategory(String category)
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Parameters:
    
    category - The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - withCategory
```
public SNOMEDCTEntity withCategory(SNOMEDCTEntityCategory category)
```
    The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Parameters:
    
    category - The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SNOMEDCTEntityCategory
  - setType
```
public void setType(String type)
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTEntityType
  - getType
```
public String getType()
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Returns:
    
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    See Also:
    
    SNOMEDCTEntityType
  - withType
```
public SNOMEDCTEntity withType(String type)
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SNOMEDCTEntityType
  - withType
```
public SNOMEDCTEntity withType(SNOMEDCTEntityType type)
```
    Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Parameters:
    
    type - Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SNOMEDCTEntityType
  - setScore
```
public void setScore(Float score)
```
    The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
  - getScore
```
public Float getScore()
```
    The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
    
    Returns:
    
    The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
  - withScore
```
public SNOMEDCTEntity withScore(Float score)
```
    The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
    
    Parameters:
    
    score - The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBeginOffset
```
public void setBeginOffset(Integer beginOffset)
```
    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.
    
    Parameters:
    
    beginOffset - 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.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    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:
    
    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.
  - withBeginOffset
```
public SNOMEDCTEntity withBeginOffset(Integer beginOffset)
```
    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.
    
    Parameters:
    
    beginOffset - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndOffset
```
public void setEndOffset(Integer endOffset)
```
    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.
    
    Parameters:
    
    endOffset - 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.
  - getEndOffset
```
public Integer getEndOffset()
```
    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:
    
    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.
  - withEndOffset
```
public SNOMEDCTEntity withEndOffset(Integer endOffset)
```
    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.
    
    Parameters:
    
    endOffset - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public List<SNOMEDCTAttribute> getAttributes()
```
    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.
    
    Returns:
    
    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.
  - setAttributes
```
public void setAttributes(Collection<SNOMEDCTAttribute> attributes)
```
    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.
    
    Parameters:
    
    attributes - 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.
  - withAttributes
```
public SNOMEDCTEntity withAttributes(SNOMEDCTAttribute... attributes)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attributes - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributes
```
public SNOMEDCTEntity withAttributes(Collection<SNOMEDCTAttribute> attributes)
```
    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.
    
    Parameters:
    
    attributes - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTraits
```
public List<SNOMEDCTTrait> getTraits()
```
    Contextual information for the entity.
    
    Returns:
    
    Contextual information for the entity.
  - setTraits
```
public void setTraits(Collection<SNOMEDCTTrait> traits)
```
    Contextual information for the entity.
    
    Parameters:
    
    traits - Contextual information for the entity.
  - withTraits
```
public SNOMEDCTEntity withTraits(SNOMEDCTTrait... traits)
```
    Contextual information for the entity.
    
    NOTE: This method appends the values to the existing list (if any). Use setTraits(java.util.Collection) or withTraits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    traits - Contextual information for the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTraits
```
public SNOMEDCTEntity withTraits(Collection<SNOMEDCTTrait> traits)
```
    Contextual information for the entity.
    
    Parameters:
    
    traits - Contextual information for the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSNOMEDCTConcepts
```
public List<SNOMEDCTConcept> getSNOMEDCTConcepts()
```
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
  - setSNOMEDCTConcepts
```
public void setSNOMEDCTConcepts(Collection<SNOMEDCTConcept> sNOMEDCTConcepts)
```
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Parameters:
    
    sNOMEDCTConcepts - The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
  - withSNOMEDCTConcepts
```
public SNOMEDCTEntity withSNOMEDCTConcepts(SNOMEDCTConcept... sNOMEDCTConcepts)
```
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    NOTE: This method appends the values to the existing list (if any). Use setSNOMEDCTConcepts(java.util.Collection) or withSNOMEDCTConcepts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sNOMEDCTConcepts - The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSNOMEDCTConcepts
```
public SNOMEDCTEntity withSNOMEDCTConcepts(Collection<SNOMEDCTConcept> sNOMEDCTConcepts)
```
    The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Parameters:
    
    sNOMEDCTConcepts - The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SNOMEDCTEntity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SNOMEDCTEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SNOMEDCTEntity

Method Detail

setId

getId

withId

setText

getText

withText

setCategory

getCategory

withCategory

withCategory

setType

getType

withType

withType

setScore

getScore

withScore

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

getAttributes

setAttributes

withAttributes

withAttributes

getTraits

setTraits

withTraits

withTraits

getSNOMEDCTConcepts

setSNOMEDCTConcepts

withSNOMEDCTConcepts

withSNOMEDCTConcepts

toString

equals

hashCode

clone

marshall