AWS.ComprehendMedical — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using ComprehendMedical

var comprehendmedical = new AWS.ComprehendMedical();
comprehendmedical.describeEntitiesDetectionV2Job(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ComprehendMedical object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var comprehendmedical = new AWS.ComprehendMedical({apiVersion: '2018-10-30'});

You can also set the API version globally in AWS.config.apiVersions using the comprehendmedical service identifier:

AWS.config.apiVersions = {
  comprehendmedical: '2018-10-30',
  // other service API versions
};

var comprehendmedical = new AWS.ComprehendMedical();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ComprehendMedical(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

describeEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

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

describeICD10CMInferenceJob(params = {}, callback) ⇒ AWS.Request

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

describePHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

describeRxNormInferenceJob(params = {}, callback) ⇒ AWS.Request

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

describeSNOMEDCTInferenceJob(params = {}, callback) ⇒ AWS.Request

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

detectEntities(params = {}, callback) ⇒ AWS.Request

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.

detectEntitiesV2(params = {}, callback) ⇒ AWS.Request

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.

detectPHI(params = {}, callback) ⇒ AWS.Request

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.

inferICD10CM(params = {}, callback) ⇒ AWS.Request

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.

inferRxNorm(params = {}, callback) ⇒ AWS.Request

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.

inferSNOMEDCT(params = {}, callback) ⇒ AWS.Request

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

listEntitiesDetectionV2Jobs(params = {}, callback) ⇒ AWS.Request

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

listICD10CMInferenceJobs(params = {}, callback) ⇒ AWS.Request

Gets a list of InferICD10CM jobs that you have submitted.

listPHIDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

listRxNormInferenceJobs(params = {}, callback) ⇒ AWS.Request

Gets a list of InferRxNorm jobs that you have submitted.

listSNOMEDCTInferenceJobs(params = {}, callback) ⇒ AWS.Request

Gets a list of InferSNOMEDCT jobs a user has submitted.

startEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

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

startICD10CMInferenceJob(params = {}, callback) ⇒ AWS.Request

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.

startPHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

startRxNormInferenceJob(params = {}, callback) ⇒ AWS.Request

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.

startSNOMEDCTInferenceJob(params = {}, callback) ⇒ AWS.Request

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.

stopEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

Stops a medical entities detection job in progress.

stopICD10CMInferenceJob(params = {}, callback) ⇒ AWS.Request

Stops an InferICD10CM inference job in progress.

stopPHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

stopRxNormInferenceJob(params = {}, callback) ⇒ AWS.Request

Stops an InferRxNorm inference job in progress.

stopSNOMEDCTInferenceJob(params = {}, callback) ⇒ AWS.Request

Stops an InferSNOMEDCT inference job in progress.