AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Attribute

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

Class Characters

The number of characters in the input text to be analyzed.

Class ComprehendMedicalAsyncJobFilter

Provides information for filtering a list of detection jobs.

Class ComprehendMedicalAsyncJobProperties

Provides information about a detection job.

Class DescribeEntitiesDetectionV2JobRequest

Container for the parameters to the DescribeEntitiesDetectionV2Job operation. Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

Class DescribeEntitiesDetectionV2JobResponse

This is the response object from the DescribeEntitiesDetectionV2Job operation.

Class DescribeICD10CMInferenceJobRequest

Container for the parameters to the DescribeICD10CMInferenceJob operation. Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

Class DescribeICD10CMInferenceJobResponse

This is the response object from the DescribeICD10CMInferenceJob operation.

Class DescribePHIDetectionJobRequest

Container for the parameters to the DescribePHIDetectionJob operation. Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Class DescribePHIDetectionJobResponse

This is the response object from the DescribePHIDetectionJob operation.

Class DescribeRxNormInferenceJobRequest

Container for the parameters to the DescribeRxNormInferenceJob operation. Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

Class DescribeRxNormInferenceJobResponse

This is the response object from the DescribeRxNormInferenceJob operation.

Class DescribeSNOMEDCTInferenceJobRequest

Container for the parameters to the DescribeSNOMEDCTInferenceJob operation. Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.

Class DescribeSNOMEDCTInferenceJobResponse

This is the response object from the DescribeSNOMEDCTInferenceJob operation.

Class DetectEntitiesRequest

Container for the parameters to the DetectEntities operation. The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

Class DetectEntitiesResponse

This is the response object from the DetectEntities operation.

Class DetectEntitiesV2Request

Container for the parameters to the DetectEntitiesV2 operation. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

Class DetectEntitiesV2Response

This is the response object from the DetectEntitiesV2 operation.

Class DetectPHIRequest

Container for the parameters to the DetectPHI operation. Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

Class DetectPHIResponse

This is the response object from the DetectPHI operation.

Class Entity

Provides information about an extracted medical entity.

Class ICD10CMAttribute

The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction, System, Organ or Site, and Acuity.

Class ICD10CMConcept

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

Class ICD10CMEntity

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.

Class ICD10CMTrait

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

Class InferICD10CMRequest

Container for the parameters to the InferICD10CM operation. InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.

Class InferICD10CMResponse

This is the response object from the InferICD10CM operation.

Class InferRxNormRequest

Container for the parameters to the InferRxNorm operation. InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

Class InferRxNormResponse

This is the response object from the InferRxNorm operation.

Class InferSNOMEDCTRequest

Container for the parameters to the InferSNOMEDCT operation. InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

Class InferSNOMEDCTResponse

This is the response object from the InferSNOMEDCT operation.

Class InputDataConfig

The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.

Class InternalServerException

An internal server error occurred. Retry your request.

Class InvalidEncodingException

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

Class InvalidRequestException

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

Class ListEntitiesDetectionV2JobsRequest

Container for the parameters to the ListEntitiesDetectionV2Jobs operation. Gets a list of medical entity detection jobs that you have submitted.

Class ListEntitiesDetectionV2JobsResponse

This is the response object from the ListEntitiesDetectionV2Jobs operation.

Class ListICD10CMInferenceJobsRequest

Container for the parameters to the ListICD10CMInferenceJobs operation. Gets a list of InferICD10CM jobs that you have submitted.

Class ListICD10CMInferenceJobsResponse

This is the response object from the ListICD10CMInferenceJobs operation.

Class ListPHIDetectionJobsRequest

Container for the parameters to the ListPHIDetectionJobs operation. Gets a list of protected health information (PHI) detection jobs you have submitted.

Class ListPHIDetectionJobsResponse

This is the response object from the ListPHIDetectionJobs operation.

Class ListRxNormInferenceJobsRequest

Container for the parameters to the ListRxNormInferenceJobs operation. Gets a list of InferRxNorm jobs that you have submitted.

Class ListRxNormInferenceJobsResponse

This is the response object from the ListRxNormInferenceJobs operation.

Class ListSNOMEDCTInferenceJobsRequest

Container for the parameters to the ListSNOMEDCTInferenceJobs operation. Gets a list of InferSNOMEDCT jobs a user has submitted.

Class ListSNOMEDCTInferenceJobsResponse

This is the response object from the ListSNOMEDCTInferenceJobs operation.

Class OutputDataConfig

The output properties for a detection job.

Class ResourceNotFoundException

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

Class RxNormAttribute

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

Class RxNormConcept

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

Class 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.

Class RxNormTrait

The contextual information for the entity. InferRxNorm recognizes the trait NEGATION, which is any indication that the patient is not taking a medication.

Class ServiceUnavailableException

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

Class SNOMEDCTAttribute

The extracted attributes that relate to an entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.

Class SNOMEDCTConcept

The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Class SNOMEDCTDetails

The information about the revision of the SNOMED-CT ontology in the response. Specifically, the details include the SNOMED-CT edition, language, and version date.

Class SNOMEDCTEntity

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.

Class SNOMEDCTTrait

Contextual information for an entity.

Class StartEntitiesDetectionV2JobRequest

Container for the parameters to the StartEntitiesDetectionV2Job operation. Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

Class StartEntitiesDetectionV2JobResponse

This is the response object from the StartEntitiesDetectionV2Job operation.

Class StartICD10CMInferenceJobRequest

Container for the parameters to the StartICD10CMInferenceJob operation. Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.

Class StartICD10CMInferenceJobResponse

This is the response object from the StartICD10CMInferenceJob operation.

Class StartPHIDetectionJobRequest

Container for the parameters to the StartPHIDetectionJob operation. Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Class StartPHIDetectionJobResponse

This is the response object from the StartPHIDetectionJob operation.

Class StartRxNormInferenceJobRequest

Container for the parameters to the StartRxNormInferenceJob operation. Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.

Class StartRxNormInferenceJobResponse

This is the response object from the StartRxNormInferenceJob operation.

Class StartSNOMEDCTInferenceJobRequest

Container for the parameters to the StartSNOMEDCTInferenceJob operation. Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.

Class StartSNOMEDCTInferenceJobResponse

This is the response object from the StartSNOMEDCTInferenceJob operation.

Class StopEntitiesDetectionV2JobRequest

Container for the parameters to the StopEntitiesDetectionV2Job operation. Stops a medical entities detection job in progress.

Class StopEntitiesDetectionV2JobResponse

This is the response object from the StopEntitiesDetectionV2Job operation.

Class StopICD10CMInferenceJobRequest

Container for the parameters to the StopICD10CMInferenceJob operation. Stops an InferICD10CM inference job in progress.

Class StopICD10CMInferenceJobResponse

This is the response object from the StopICD10CMInferenceJob operation.

Class StopPHIDetectionJobRequest

Container for the parameters to the StopPHIDetectionJob operation. Stops a protected health information (PHI) detection job in progress.

Class StopPHIDetectionJobResponse

This is the response object from the StopPHIDetectionJob operation.

Class StopRxNormInferenceJobRequest

Container for the parameters to the StopRxNormInferenceJob operation. Stops an InferRxNorm inference job in progress.

Class StopRxNormInferenceJobResponse

This is the response object from the StopRxNormInferenceJob operation.

Class StopSNOMEDCTInferenceJobRequest

Container for the parameters to the StopSNOMEDCTInferenceJob operation. Stops an InferSNOMEDCT inference job in progress.

Class StopSNOMEDCTInferenceJobResponse

This is the response object from the StopSNOMEDCTInferenceJob operation.

Class TextSizeLimitExceededException

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

Class TooManyRequestsException

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

Class Trait

Provides contextual information about the extracted entity.

Class UnmappedAttribute

An attribute that was extracted, but Amazon Comprehend Medical was unable to relate to an entity.

Class ValidationException

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.