Interface RxNormAttribute.Builder

    • Method Detail

      • type

        RxNormAttribute.Builder type​(String type)

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

        Parameters:
        type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RxNormAttributeType, RxNormAttributeType
      • type

        RxNormAttribute.Builder type​(RxNormAttributeType type)

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

        Parameters:
        type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RxNormAttributeType, RxNormAttributeType
      • score

        RxNormAttribute.Builder score​(Float score)

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

        Parameters:
        score - The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • relationshipScore

        RxNormAttribute.Builder relationshipScore​(Float relationshipScore)

        The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

        Parameters:
        relationshipScore - The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • id

        RxNormAttribute.Builder id​(Integer id)

        The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

        Parameters:
        id - The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • beginOffset

        RxNormAttribute.Builder beginOffset​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • endOffset

        RxNormAttribute.Builder endOffset​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • text

        RxNormAttribute.Builder text​(String text)

        The segment of input text which corresponds to the detected attribute.

        Parameters:
        text - The segment of input text which corresponds to the detected attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traits

        RxNormAttribute.Builder traits​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traits

        RxNormAttribute.Builder traits​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traits

        RxNormAttribute.Builder traits​(Consumer<RxNormTrait.Builder>... 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.

        This is a convenience method that creates an instance of the RxNormTrait.Builder avoiding the need to create one manually via RxNormTrait.builder() .

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #traits(List).

        Parameters:
        traits - a consumer that will call methods on RxNormTrait.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #traits(java.util.Collection)