software.amazon.awssdk.services.comprehendmedical.model

Class RxNormAttribute

java.lang.Object

software.amazon.awssdk.services.comprehendmedical.model.RxNormAttribute

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RxNormAttribute.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 RxNormAttribute.Builder	builder()
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() For responses, this returns true if the service returned a value for the Traits property.
Integer	id() The numeric identifier for this attribute.
Float	relationshipScore() The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
Float	score() The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends RxNormAttribute.Builder>	serializableBuilderClass()
String	text() The segment of input text which corresponds to the detected attribute.
RxNormAttribute.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<RxNormTrait>	traits() Contextual information for the attribute.
RxNormAttributeType	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 RxNormAttributeType type()

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

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

Returns:

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

See Also:

RxNormAttributeType

typeAsString

public final String typeAsString()

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

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

Returns:

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

See Also:

RxNormAttributeType

score

public final Float score()

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

Returns:

The level of confidence that 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 the attribute is accurately linked to an entity.

Returns:

The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an 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 corresponds to the detected attribute.

Returns:

The segment of input text which corresponds to 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<RxNormTrait> traits()

Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

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 attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

toBuilder

public RxNormAttribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RxNormAttribute.Builder,RxNormAttribute>

builder

public static RxNormAttribute.Builder builder()

serializableBuilderClass

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