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

Interface ICD10CMEntity.Builder

    • Method Detail

      • id

        ICD10CMEntity.Builder id​(Integer id)

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

        Parameters:
        id - The numeric identifier for the entity. 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.

      • text

        ICD10CMEntity.Builder text​(String text)

        The segment of input text that is matched to the detected entity.

        Parameters:
        text - The segment of input text that is matched to the detected entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • category

        ICD10CMEntity.Builder category​(String category)

        The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

        Parameters:
        category - The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ICD10CMEntityCategory, ICD10CMEntityCategory

      • category

        ICD10CMEntity.Builder category​(ICD10CMEntityCategory category)

        The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

        Parameters:
        category - The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ICD10CMEntityCategory, ICD10CMEntityCategory

      • type

        ICD10CMEntity.Builder type​(String type)

        Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

        Parameters:
        type - Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ICD10CMEntityType, ICD10CMEntityType

      • type

        ICD10CMEntity.Builder type​(ICD10CMEntityType type)

        Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

        Parameters:
        type - Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ICD10CMEntityType, ICD10CMEntityType

      • score

        ICD10CMEntity.Builder score​(Float score)

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

        Parameters:
        score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • beginOffset

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

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

      • endOffset

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

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

      • attributes

        ICD10CMEntity.Builder attributes​(Collection<ICD10CMAttribute> attributes)

        The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

        Parameters:
        attributes - The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributes

        ICD10CMEntity.Builder attributes​(ICD10CMAttribute... attributes)

        The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

        Parameters:
        attributes - The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributes

        ICD10CMEntity.Builder attributes​(Consumer<ICD10CMAttribute.Builder>... attributes)

        The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

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

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

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

      • traits

        ICD10CMEntity.Builder traits​(Collection<ICD10CMTrait> traits)

        Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

        Parameters:
        traits - Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • traits

        ICD10CMEntity.Builder traits​(ICD10CMTrait... traits)

        Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

        Parameters:
        traits - Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • traits

        ICD10CMEntity.Builder traits​(Consumer<ICD10CMTrait.Builder>... traits)

        Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

        This is a convenience method that creates an instance of the ICD10CMTrait.Builder avoiding the need to create one manually via ICD10CMTrait.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 ICD10CMTrait.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #traits(java.util.Collection)

      • icd10CMConcepts

        ICD10CMEntity.Builder icd10CMConcepts​(Collection<ICD10CMConcept> icd10CMConcepts)

        The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

        Parameters:
        icd10CMConcepts - The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • icd10CMConcepts

        ICD10CMEntity.Builder icd10CMConcepts​(ICD10CMConcept... icd10CMConcepts)

        The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

        Parameters:
        icd10CMConcepts - The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • icd10CMConcepts

        ICD10CMEntity.Builder icd10CMConcepts​(Consumer<ICD10CMConcept.Builder>... icd10CMConcepts)

        The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

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

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

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