software.amazon.awssdk.services.comprehendmedical.model

Class ICD10CMEntity

java.lang.Object

software.amazon.awssdk.services.comprehendmedical.model.ICD10CMEntity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ICD10CMEntity.Builder,ICD10CMEntity>

@Generated(value="software.amazon.awssdk:codegen")
public final class ICD10CMEntity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ICD10CMEntity.Builder,ICD10CMEntity>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ICD10CMEntity.Builder

Method Summary

Modifier and Type	Method and Description
List<ICD10CMAttribute>	attributes() The detected attributes that relate to the entity.
Integer	beginOffset() The 0-based character offset in the input text that shows where the entity begins.
static ICD10CMEntity.Builder	builder()
ICD10CMEntityCategory	category() The category of the entity.
String	categoryAsString() The category of the entity.
Integer	endOffset() The 0-based character offset in the input text that shows where the entity ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasIcd10CMConcepts() Returns true if the ICD10CMConcepts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTraits() Returns true if the Traits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<ICD10CMConcept>	icd10CMConcepts() The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
Integer	id() The numeric identifier for the entity.
Float	score() The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
List<SdkField<?>>	sdkFields()
static Class<? extends ICD10CMEntity.Builder>	serializableBuilderClass()
String	text() The segment of input text that is matched to the detected entity.
ICD10CMEntity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ICD10CMTrait>	traits() Provides Contextual information for the entity.
ICD10CMEntityType	type() Describes the specific type of entity with category of entities.
String	typeAsString() Describes the specific type of entity with category of entities.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public Integer id()

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.

text

public String text()

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

Returns:

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

category

public ICD10CMEntityCategory category()

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

If the service returns an enum value that is not available in the current SDK version, category will return ICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

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

See Also:

ICD10CMEntityCategory

categoryAsString

public String categoryAsString()

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

If the service returns an enum value that is not available in the current SDK version, category will return ICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

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

See Also:

ICD10CMEntityCategory

type

public ICD10CMEntityType type()

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

If the service returns an enum value that is not available in the current SDK version, type will return ICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

ICD10CMEntityType

typeAsString

public String typeAsString()

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

If the service returns an enum value that is not available in the current SDK version, type will return ICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

ICD10CMEntityType

score

public Float score()

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

Returns:

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

beginOffset

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

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.

endOffset

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

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.

hasAttributes

public boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public List<ICD10CMAttribute> attributes()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

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.

hasTraits

public boolean hasTraits()

Returns true if the Traits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

traits

public List<ICD10CMTrait> traits()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTraits() to see if a value was sent in this field.

Returns:

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

hasIcd10CMConcepts

public boolean hasIcd10CMConcepts()

Returns true if the ICD10CMConcepts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

icd10CMConcepts

public List<ICD10CMConcept> icd10CMConcepts()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIcd10CMConcepts() to see if a value was sent in this field.

Returns:

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

toBuilder

public ICD10CMEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ICD10CMEntity.Builder,ICD10CMEntity>

builder

public static ICD10CMEntity.Builder builder()

serializableBuilderClass

public static Class<? extends ICD10CMEntity.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo