/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::ComprehendMedical

NAME

Paws::ComprehendMedical - Perl Interface to AWS AWS Comprehend Medical

SYNOPSIS

use Paws;

my $obj = Paws->service('ComprehendMedical');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30

METHODS

DescribeEntitiesDetectionV2Job

JobId => Str

Each argument is described in detail in: Paws::ComprehendMedical::DescribeEntitiesDetectionV2Job

Returns: a Paws::ComprehendMedical::DescribeEntitiesDetectionV2JobResponse instance

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

DescribePHIDetectionJob

JobId => Str

Each argument is described in detail in: Paws::ComprehendMedical::DescribePHIDetectionJob

Returns: a Paws::ComprehendMedical::DescribePHIDetectionJobResponse instance

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

DetectEntities

Text => Str

Each argument is described in detail in: Paws::ComprehendMedical::DetectEntities

Returns: a Paws::ComprehendMedical::DetectEntitiesResponse instance

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

Text => Str

Each argument is described in detail in: Paws::ComprehendMedical::DetectEntitiesV2

Returns: a Paws::ComprehendMedical::DetectEntitiesV2Response instance

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.

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

Text => Str

Each argument is described in detail in: Paws::ComprehendMedical::DetectPHI

Returns: a Paws::ComprehendMedical::DetectPHIResponse instance

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

InferICD10CM

Text => Str

Each argument is described in detail in: Paws::ComprehendMedical::InferICD10CM

Returns: a Paws::ComprehendMedical::InferICD10CMResponse instance

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.

InferRxNorm

Text => Str

Each argument is described in detail in: Paws::ComprehendMedical::InferRxNorm

Returns: a Paws::ComprehendMedical::InferRxNormResponse instance

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.

ListEntitiesDetectionV2Jobs

[Filter => Paws::ComprehendMedical::ComprehendMedicalAsyncJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ComprehendMedical::ListEntitiesDetectionV2Jobs

Returns: a Paws::ComprehendMedical::ListEntitiesDetectionV2JobsResponse instance

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

ListPHIDetectionJobs

[Filter => Paws::ComprehendMedical::ComprehendMedicalAsyncJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ComprehendMedical::ListPHIDetectionJobs

Returns: a Paws::ComprehendMedical::ListPHIDetectionJobsResponse instance

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

StartEntitiesDetectionV2Job

DataAccessRoleArn => Str
InputDataConfig => Paws::ComprehendMedical::InputDataConfig
LanguageCode => Str
OutputDataConfig => Paws::ComprehendMedical::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[KMSKey => Str]

Each argument is described in detail in: Paws::ComprehendMedical::StartEntitiesDetectionV2Job

Returns: a Paws::ComprehendMedical::StartEntitiesDetectionV2JobResponse instance

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

StartPHIDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::ComprehendMedical::InputDataConfig
LanguageCode => Str
OutputDataConfig => Paws::ComprehendMedical::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[KMSKey => Str]

Each argument is described in detail in: Paws::ComprehendMedical::StartPHIDetectionJob

Returns: a Paws::ComprehendMedical::StartPHIDetectionJobResponse instance

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

StopEntitiesDetectionV2Job

JobId => Str

Each argument is described in detail in: Paws::ComprehendMedical::StopEntitiesDetectionV2Job

Returns: a Paws::ComprehendMedical::StopEntitiesDetectionV2JobResponse instance

Stops a medical entities detection job in progress.

StopPHIDetectionJob

JobId => Str

Each argument is described in detail in: Paws::ComprehendMedical::StopPHIDetectionJob

Returns: a Paws::ComprehendMedical::StopPHIDetectionJobResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues