software.amazon.awssdk.services.comprehendmedical.model

Class ICD10CMAttribute

java.lang.Object

software.amazon.awssdk.services.comprehendmedical.model.ICD10CMAttribute

All Implemented Interfaces:

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

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

The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction, System, Organ or Site, and Acuity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ICD10CMAttribute.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() The 0-based character offset in the input text that shows where the attribute begins.
static ICD10CMAttribute.Builder	builder()
ICD10CMEntityType	category() The category of attribute.
String	categoryAsString() The category of attribute.
Integer	endOffset() The 0-based character offset in the input text that shows where the attribute ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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).
Integer	id() The numeric identifier for this attribute.
Float	relationshipScore() The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
ICD10CMRelationshipType	relationshipType() The type of relationship between the entity and attribute.
String	relationshipTypeAsString() The type of relationship between the entity and attribute.
Float	score() The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends ICD10CMAttribute.Builder>	serializableBuilderClass()
String	text() The segment of input text which contains the detected attribute.
ICD10CMAttribute.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ICD10CMTrait>	traits() The contextual information for the attribute.
ICD10CMAttributeType	type() The type of attribute.
String	typeAsString() The type of attribute.

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

type

public final ICD10CMAttributeType type()

The type of attribute. 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 ICD10CMAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of attribute. InferICD10CM detects entities of the type DX_NAME.

See Also:

ICD10CMAttributeType

typeAsString

public final String typeAsString()

The type of attribute. 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 ICD10CMAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of attribute. InferICD10CM detects entities of the type DX_NAME.

See Also:

ICD10CMAttributeType

score

public final Float score()

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

Returns:

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

relationshipScore

public final Float relationshipScore()

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

Returns:

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

id

public final Integer id()

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Returns:

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

beginOffset

public final Integer beginOffset()

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:

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.

endOffset

public final Integer endOffset()

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:

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.

text

public final String text()

The segment of input text which contains the detected attribute.

Returns:

The segment of input text which contains the detected attribute.

hasTraits

public final 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 final List<ICD10CMTrait> traits()

The contextual information for the attribute. 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:

The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

category

public final ICD10CMEntityType category()

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

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

Returns:

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

See Also:

ICD10CMEntityType

categoryAsString

public final String categoryAsString()

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

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

Returns:

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

See Also:

ICD10CMEntityType

relationshipType

public final ICD10CMRelationshipType relationshipType()

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

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

Returns:

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

See Also:

ICD10CMRelationshipType

relationshipTypeAsString

public final String relationshipTypeAsString()

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

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

Returns:

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

See Also:

ICD10CMRelationshipType

toBuilder

public ICD10CMAttribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ICD10CMAttribute.Builder,ICD10CMAttribute>

builder

public static ICD10CMAttribute.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo