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.

Interface for accessing ComprehendMedical

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and quotas in the Amazon Comprehend Medical Developer Guide.

Inheritance Hierarchy

Amazon.ComprehendMedical.IAmazonComprehendMedical

Namespace: Amazon.ComprehendMedical
Assembly: AWSSDK.ComprehendMedical.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonComprehendMedical
         IAmazonService, IDisposable

The IAmazonComprehendMedical type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DescribeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest)

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

Public Method DescribeEntitiesDetectionV2JobAsync(DescribeEntitiesDetectionV2JobRequest, CancellationToken)

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

Public Method DescribeICD10CMInferenceJob(DescribeICD10CMInferenceJobRequest)

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

Public Method DescribeICD10CMInferenceJobAsync(DescribeICD10CMInferenceJobRequest, CancellationToken)

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

Public Method DescribePHIDetectionJob(DescribePHIDetectionJobRequest)

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

Public Method DescribePHIDetectionJobAsync(DescribePHIDetectionJobRequest, CancellationToken)

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

Public Method DescribeRxNormInferenceJob(DescribeRxNormInferenceJobRequest)

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

Public Method DescribeRxNormInferenceJobAsync(DescribeRxNormInferenceJobRequest, CancellationToken)

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

Public Method DescribeSNOMEDCTInferenceJob(DescribeSNOMEDCTInferenceJobRequest)

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

Public Method DescribeSNOMEDCTInferenceJobAsync(DescribeSNOMEDCTInferenceJobRequest, CancellationToken)

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

Public Method DetectEntities(DetectEntitiesRequest)

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.

Public Method DetectEntitiesAsync(DetectEntitiesRequest, CancellationToken)

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.

Public Method DetectEntitiesV2(DetectEntitiesV2Request)

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.

Public Method DetectEntitiesV2Async(DetectEntitiesV2Request, CancellationToken)

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.

Public Method DetectPHI(DetectPHIRequest)

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.

Public Method DetectPHIAsync(DetectPHIRequest, CancellationToken)

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.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method InferICD10CM(InferICD10CMRequest)

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.

Public Method InferICD10CMAsync(InferICD10CMRequest, CancellationToken)

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.

Public Method InferRxNorm(InferRxNormRequest)

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.

Public Method InferRxNormAsync(InferRxNormRequest, CancellationToken)

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.

Public Method InferSNOMEDCT(InferSNOMEDCTRequest)

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

Public Method InferSNOMEDCTAsync(InferSNOMEDCTRequest, CancellationToken)

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

Public Method ListEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest)

Gets a list of medical entity detection jobs that you have submitted.

Public Method ListEntitiesDetectionV2JobsAsync(ListEntitiesDetectionV2JobsRequest, CancellationToken)

Gets a list of medical entity detection jobs that you have submitted.

Public Method ListICD10CMInferenceJobs(ListICD10CMInferenceJobsRequest)

Gets a list of InferICD10CM jobs that you have submitted.

Public Method ListICD10CMInferenceJobsAsync(ListICD10CMInferenceJobsRequest, CancellationToken)

Gets a list of InferICD10CM jobs that you have submitted.

Public Method ListPHIDetectionJobs(ListPHIDetectionJobsRequest)

Gets a list of protected health information (PHI) detection jobs you have submitted.

Public Method ListPHIDetectionJobsAsync(ListPHIDetectionJobsRequest, CancellationToken)

Gets a list of protected health information (PHI) detection jobs you have submitted.

Public Method ListRxNormInferenceJobs(ListRxNormInferenceJobsRequest)

Gets a list of InferRxNorm jobs that you have submitted.

Public Method ListRxNormInferenceJobsAsync(ListRxNormInferenceJobsRequest, CancellationToken)

Gets a list of InferRxNorm jobs that you have submitted.

Public Method ListSNOMEDCTInferenceJobs(ListSNOMEDCTInferenceJobsRequest)

Gets a list of InferSNOMEDCT jobs a user has submitted.

Public Method ListSNOMEDCTInferenceJobsAsync(ListSNOMEDCTInferenceJobsRequest, CancellationToken)

Gets a list of InferSNOMEDCT jobs a user has submitted.

Public Method StartEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest)

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

Public Method StartEntitiesDetectionV2JobAsync(StartEntitiesDetectionV2JobRequest, CancellationToken)

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

Public Method StartICD10CMInferenceJob(StartICD10CMInferenceJobRequest)

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.

Public Method StartICD10CMInferenceJobAsync(StartICD10CMInferenceJobRequest, CancellationToken)

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.

Public Method StartPHIDetectionJob(StartPHIDetectionJobRequest)

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

Public Method StartPHIDetectionJobAsync(StartPHIDetectionJobRequest, CancellationToken)

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

Public Method StartRxNormInferenceJob(StartRxNormInferenceJobRequest)

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.

Public Method StartRxNormInferenceJobAsync(StartRxNormInferenceJobRequest, CancellationToken)

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.

Public Method StartSNOMEDCTInferenceJob(StartSNOMEDCTInferenceJobRequest)

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.

Public Method StartSNOMEDCTInferenceJobAsync(StartSNOMEDCTInferenceJobRequest, CancellationToken)

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.

Public Method StopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest)

Stops a medical entities detection job in progress.

Public Method StopEntitiesDetectionV2JobAsync(StopEntitiesDetectionV2JobRequest, CancellationToken)

Stops a medical entities detection job in progress.

Public Method StopICD10CMInferenceJob(StopICD10CMInferenceJobRequest)

Stops an InferICD10CM inference job in progress.

Public Method StopICD10CMInferenceJobAsync(StopICD10CMInferenceJobRequest, CancellationToken)

Stops an InferICD10CM inference job in progress.

Public Method StopPHIDetectionJob(StopPHIDetectionJobRequest)

Stops a protected health information (PHI) detection job in progress.

Public Method StopPHIDetectionJobAsync(StopPHIDetectionJobRequest, CancellationToken)

Stops a protected health information (PHI) detection job in progress.

Public Method StopRxNormInferenceJob(StopRxNormInferenceJobRequest)

Stops an InferRxNorm inference job in progress.

Public Method StopRxNormInferenceJobAsync(StopRxNormInferenceJobRequest, CancellationToken)

Stops an InferRxNorm inference job in progress.

Public Method StopSNOMEDCTInferenceJob(StopSNOMEDCTInferenceJobRequest)

Stops an InferSNOMEDCT inference job in progress.

Public Method StopSNOMEDCTInferenceJobAsync(StopSNOMEDCTInferenceJobRequest, CancellationToken)

Stops an InferSNOMEDCT inference job in progress.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5