Class ICD10CMAttribute
- java.lang.Object
-
- software.amazon.awssdk.services.comprehendmedical.model.ICD10CMAttribute
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ICD10CMAttribute.Builder,ICD10CMAttribute>
@Generated("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, andAcuity.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceICD10CMAttribute.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerbeginOffset()The 0-based character offset in the input text that shows where the attribute begins.static ICD10CMAttribute.Builderbuilder()ICD10CMEntityTypecategory()The category of attribute.StringcategoryAsString()The category of attribute.IntegerendOffset()The 0-based character offset in the input text that shows where the attribute ends.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTraits()For responses, this returns true if the service returned a value for the Traits property.Integerid()The numeric identifier for this attribute.FloatrelationshipScore()The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.ICD10CMRelationshipTyperelationshipType()The type of relationship between the entity and attribute.StringrelationshipTypeAsString()The type of relationship between the entity and attribute.Floatscore()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()Stringtext()The segment of input text which contains the detected attribute.ICD10CMAttribute.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<ICD10CMTrait>traits()The contextual information for the attribute.ICD10CMAttributeTypetype()The type of attribute.StringtypeAsString()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,
typewill returnICD10CMAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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,
typewill returnICD10CMAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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()
For responses, this returns true if the service returned a value for the Traits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
traits
public final List<ICD10CMTrait> traits()
The contextual information for the attribute. The traits recognized by InferICD10CM are
DIAGNOSIS,SIGN,SYMPTOM, andNEGATION.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTraits()method.- Returns:
- The contextual information for the attribute. The traits recognized by InferICD10CM are
DIAGNOSIS,SIGN,SYMPTOM, andNEGATION.
-
category
public final ICD10CMEntityType category()
The category of attribute. Can be either of
DX_NAMEorTIME_EXPRESSION.If the service returns an enum value that is not available in the current SDK version,
categorywill returnICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of attribute. Can be either of
DX_NAMEorTIME_EXPRESSION. - See Also:
ICD10CMEntityType
-
categoryAsString
public final String categoryAsString()
The category of attribute. Can be either of
DX_NAMEorTIME_EXPRESSION.If the service returns an enum value that is not available in the current SDK version,
categorywill returnICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of attribute. Can be either of
DX_NAMEorTIME_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
OVERLAPorSYSTEM_ORGAN_SITE.If the service returns an enum value that is not available in the current SDK version,
relationshipTypewill returnICD10CMRelationshipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrelationshipTypeAsString().- Returns:
- The type of relationship between the entity and attribute. Type for the relationship can be either of
OVERLAPorSYSTEM_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
OVERLAPorSYSTEM_ORGAN_SITE.If the service returns an enum value that is not available in the current SDK version,
relationshipTypewill returnICD10CMRelationshipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrelationshipTypeAsString().- Returns:
- The type of relationship between the entity and attribute. Type for the relationship can be either of
OVERLAPorSYSTEM_ORGAN_SITE. - See Also:
ICD10CMRelationshipType
-
toBuilder
public ICD10CMAttribute.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ICD10CMAttribute.Builder,ICD10CMAttribute>
-
builder
public static ICD10CMAttribute.Builder builder()
-
serializableBuilderClass
public static Class<? extends ICD10CMAttribute.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-