Package 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("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:

  • Method Details

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

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

    • 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 the isEmpty() 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, and NEGATION.

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

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

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

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

    • toBuilder

      public ICD10CMAttribute.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ICD10CMAttribute.Builder,ICD10CMAttribute>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.