Package software.amazon.awssdk.services.comprehendmedical.model

Class RxNormEntity

java.lang.Object
software.amazon.awssdk.services.comprehendmedical.model.RxNormEntity
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RxNormEntity.Builder,RxNormEntity>
@Generated("software.amazon.awssdk:codegen") public final class RxNormEntity extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RxNormEntity.Builder,RxNormEntity>

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:

  • Method Details

    • id

      public final 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 final String text()

      The segment of input text extracted from which the entity was detected.

      Returns:
      The segment of input text extracted from which the entity was detected.

    • category

      public final RxNormEntityCategory category()

      The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

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

      Returns:
      The category of the entity. The recognized categories are GENERIC or BRAND_NAME .
      See Also:

    • categoryAsString

      public final String categoryAsString()

      The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

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

      Returns:
      The category of the entity. The recognized categories are GENERIC or BRAND_NAME .
      See Also:

    • type

      public final RxNormEntityType type()

      Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

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

      Returns:
      Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
      See Also:

    • typeAsString

      public final String typeAsString()

      Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

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

      Returns:
      Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
      See Also:

    • score

      public final Float score()

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

      Returns:
      The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

    • beginOffset

      public final 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 final 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 final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributes

      public final List<RxNormAttribute> attributes()

      The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

      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 hasAttributes() method.

      Returns:
      The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

    • 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<RxNormTrait> traits()

      Contextual information for the entity.

      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:
      Contextual information for the entity.

    • hasRxNormConcepts

      public final boolean hasRxNormConcepts()
      For responses, this returns true if the service returned a value for the RxNormConcepts 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.

    • rxNormConcepts

      public final List<RxNormConcept> rxNormConcepts()

      The RxNorm 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.

      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 hasRxNormConcepts() method.

      Returns:
      The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

    • toBuilder

      public RxNormEntity.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<RxNormEntity.Builder,RxNormEntity>
      Returns:
      a builder for type T

    • builder

      public static RxNormEntity.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RxNormEntity.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.