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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RxNormEntity.Builder

Method Summary

Modifier and Type	Method and Description
List<RxNormAttribute>	attributes() The extracted attributes that relate to the entity.
Integer	beginOffset() The 0-based character offset in the input text that shows where the entity begins.
static RxNormEntity.Builder	builder()
RxNormEntityCategory	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() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasRxNormConcepts() For responses, this returns true if the service returned a value for the RxNormConcepts property.
boolean	hasTraits() For responses, this returns true if the service returned a value for the Traits property.
Integer	id() The numeric identifier for the entity.
List<RxNormConcept>	rxNormConcepts() The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
Float	score() The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
List<SdkField<?>>	sdkFields()
static Class<? extends RxNormEntity.Builder>	serializableBuilderClass()
String	text() The segment of input text extracted from which the entity was detected.
RxNormEntity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<RxNormTrait>	traits() Contextual information for the entity.
RxNormEntityType	type() Describes the specific type of entity.
String	typeAsString() Describes the specific type of entity.

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

RxNormEntityCategory

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:

RxNormEntityCategory

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:

RxNormEntityType

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:

RxNormEntityType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<RxNormEntity.Builder,RxNormEntity>

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)

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