The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

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.

DescribeICD10CMInferenceJob

JobId => Str

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

Returns: a Paws::ComprehendMedical::DescribeICD10CMInferenceJobResponse instance

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference 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.

DescribeRxNormInferenceJob

JobId => Str

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

Returns: a Paws::ComprehendMedical::DescribeRxNormInferenceJobResponse instance

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference 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. 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

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 returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

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. Amazon Comprehend Medical only detects medical entities in English language texts.

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. Amazon Comprehend Medical only detects medical entities in English language texts.

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.

ListICD10CMInferenceJobs

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

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

Returns: a Paws::ComprehendMedical::ListICD10CMInferenceJobsResponse instance

Gets a list of InferICD10CM 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.

ListRxNormInferenceJobs

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

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

Returns: a Paws::ComprehendMedical::ListRxNormInferenceJobsResponse instance

Gets a list of InferRxNorm 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.

StartICD10CMInferenceJob

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::StartICD10CMInferenceJob

Returns: a Paws::ComprehendMedical::StartICD10CMInferenceJobResponse instance

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

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.

StartRxNormInferenceJob

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::StartRxNormInferenceJob

Returns: a Paws::ComprehendMedical::StartRxNormInferenceJobResponse instance

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.

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.

StopICD10CMInferenceJob

JobId => Str

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

Returns: a Paws::ComprehendMedical::StopICD10CMInferenceJobResponse instance

Stops an InferICD10CM inference 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.

StopRxNormInferenceJob

JobId => Str

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

Returns: a Paws::ComprehendMedical::StopRxNormInferenceJobResponse instance

Stops an InferRxNorm inference 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