AWS SDK for PHP 3.x

Client: Aws\ComprehendMedical\ComprehendMedicalClient

Service ID: comprehendmedical

Version: 2018-10-30

This page describes the parameters and results for the operations of the AWS Comprehend Medical (2018-10-30), and shows how to use the Aws\ComprehendMedical\ComprehendMedicalClient object to call the described operations. This documentation is specific to the 2018-10-30 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DescribeEntitiesDetectionV2Job ( array $params = [] )
Gets the properties associated with a medical entities detection job.
DescribeICD10CMInferenceJob ( array $params = [] )
Gets the properties associated with an InferICD10CM job.
DescribePHIDetectionJob ( array $params = [] )
Gets the properties associated with a protected health information (PHI) detection job.
DescribeRxNormInferenceJob ( array $params = [] )
Gets the properties associated with an InferRxNorm job.
DescribeSNOMEDCTInferenceJob ( array $params = [] )
Gets the properties associated with an InferSNOMEDCT job.
DetectEntities ( array $params = [] )
The DetectEntities operation is deprecated.
DetectEntitiesV2 ( array $params = [] )
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.
DetectPHI ( array $params = [] )
Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.
InferICD10CM ( array $params = [] )
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 ( array $params = [] )
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.
InferSNOMEDCT ( array $params = [] )
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
ListEntitiesDetectionV2Jobs ( array $params = [] )
Gets a list of medical entity detection jobs that you have submitted.
ListICD10CMInferenceJobs ( array $params = [] )
Gets a list of InferICD10CM jobs that you have submitted.
ListPHIDetectionJobs ( array $params = [] )
Gets a list of protected health information (PHI) detection jobs you have submitted.
ListRxNormInferenceJobs ( array $params = [] )
Gets a list of InferRxNorm jobs that you have submitted.
ListSNOMEDCTInferenceJobs ( array $params = [] )
Gets a list of InferSNOMEDCT jobs a user has submitted.
StartEntitiesDetectionV2Job ( array $params = [] )
Starts an asynchronous medical entity detection job for a collection of documents.
StartICD10CMInferenceJob ( array $params = [] )
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
StartPHIDetectionJob ( array $params = [] )
Starts an asynchronous job to detect protected health information (PHI).
StartRxNormInferenceJob ( array $params = [] )
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
StartSNOMEDCTInferenceJob ( array $params = [] )
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology.
StopEntitiesDetectionV2Job ( array $params = [] )
Stops a medical entities detection job in progress.
StopICD10CMInferenceJob ( array $params = [] )
Stops an InferICD10CM inference job in progress.
StopPHIDetectionJob ( array $params = [] )
Stops a protected health information (PHI) detection job in progress.
StopRxNormInferenceJob ( array $params = [] )
Stops an InferRxNorm inference job in progress.
StopSNOMEDCTInferenceJob ( array $params = [] )
Stops an InferSNOMEDCT inference job in progress.

Operations

DescribeEntitiesDetectionV2Job

$result = $client->describeEntitiesDetectionV2Job([/* ... */]);
$promise = $client->describeEntitiesDetectionV2JobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEntitiesDetectionV2Job([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

An object that contains the properties associated with a detection job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DescribeICD10CMInferenceJob

$result = $client->describeICD10CMInferenceJob([/* ... */]);
$promise = $client->describeICD10CMInferenceJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeICD10CMInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Comprehend Medical generated for the job. The StartICD10CMInferenceJob operation returns this identifier in its response.

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

An object that contains the properties associated with a detection job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DescribePHIDetectionJob

$result = $client->describePHIDetectionJob([/* ... */]);
$promise = $client->describePHIDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePHIDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

An object that contains the properties associated with a detection job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DescribeRxNormInferenceJob

$result = $client->describeRxNormInferenceJob([/* ... */]);
$promise = $client->describeRxNormInferenceJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeRxNormInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

An object that contains the properties associated with a detection job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DescribeSNOMEDCTInferenceJob

$result = $client->describeSNOMEDCTInferenceJob([/* ... */]);
$promise = $client->describeSNOMEDCTInferenceJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSNOMEDCTInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

Provides information about a detection job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DetectEntities

$result = $client->detectEntities([/* ... */]);
$promise = $client->detectEntitiesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detectEntities([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 text string containing the clinical content being examined for entities.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'RelationshipType' => 'EVERY|WITH_DOSAGE|ADMINISTERED_VIA|FOR|NEGATIVE|OVERLAP|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|STRENGTH|RATE|ACUITY|TEST_VALUE|TEST_UNITS|TEST_UNIT|DIRECTION|SYSTEM_ORGAN_SITE|AMOUNT|USAGE|QUALITY',
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
    'UnmappedAttributes' => [
        [
            'Attribute' => [
                'BeginOffset' => <integer>,
                'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
                'EndOffset' => <integer>,
                'Id' => <integer>,
                'RelationshipScore' => <float>,
                'RelationshipType' => 'EVERY|WITH_DOSAGE|ADMINISTERED_VIA|FOR|NEGATIVE|OVERLAP|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|STRENGTH|RATE|ACUITY|TEST_VALUE|TEST_UNITS|TEST_UNIT|DIRECTION|SYSTEM_ORGAN_SITE|AMOUNT|USAGE|QUALITY',
                'Score' => <float>,
                'Text' => '<string>',
                'Traits' => [
                    [
                        'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                        'Score' => <float>,
                    ],
                    // ...
                ],
                'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
            ],
            'Type' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
        ],
        // ...
    ],
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

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.

ModelVersion

Required: Yes
Type: string

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.

UnmappedAttributes

Type: Array of UnmappedAttribute structures

Attributes extracted from the input text that we were unable to relate to an entity.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

DetectEntitiesV2

$result = $client->detectEntitiesV2([/* ... */]);
$promise = $client->detectEntitiesV2Async([/* ... */]);

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.

Parameter Syntax

$result = $client->detectEntitiesV2([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 string containing the clinical content being examined for entities.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'RelationshipType' => 'EVERY|WITH_DOSAGE|ADMINISTERED_VIA|FOR|NEGATIVE|OVERLAP|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|STRENGTH|RATE|ACUITY|TEST_VALUE|TEST_UNITS|TEST_UNIT|DIRECTION|SYSTEM_ORGAN_SITE|AMOUNT|USAGE|QUALITY',
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
    'UnmappedAttributes' => [
        [
            'Attribute' => [
                'BeginOffset' => <integer>,
                'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
                'EndOffset' => <integer>,
                'Id' => <integer>,
                'RelationshipScore' => <float>,
                'RelationshipType' => 'EVERY|WITH_DOSAGE|ADMINISTERED_VIA|FOR|NEGATIVE|OVERLAP|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|STRENGTH|RATE|ACUITY|TEST_VALUE|TEST_UNITS|TEST_UNIT|DIRECTION|SYSTEM_ORGAN_SITE|AMOUNT|USAGE|QUALITY',
                'Score' => <float>,
                'Text' => '<string>',
                'Traits' => [
                    [
                        'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                        'Score' => <float>,
                    ],
                    // ...
                ],
                'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
            ],
            'Type' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
        ],
        // ...
    ],
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

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 in the detection and analysis. Attributes and traits of the entity are also returned.

ModelVersion

Required: Yes
Type: string

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

UnmappedAttributes

Type: Array of UnmappedAttribute structures

Attributes extracted from the input text that couldn't be related to an entity.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

DetectPHI

$result = $client->detectPHI([/* ... */]);
$promise = $client->detectPHIAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detectPHI([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 text string containing the clinical content being examined for PHI entities.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'RelationshipType' => 'EVERY|WITH_DOSAGE|ADMINISTERED_VIA|FOR|NEGATIVE|OVERLAP|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|STRENGTH|RATE|ACUITY|TEST_VALUE|TEST_UNITS|TEST_UNIT|DIRECTION|SYSTEM_ORGAN_SITE|AMOUNT|USAGE|QUALITY',
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY|TIME_EXPRESSION|BEHAVIORAL_ENVIRONMENTAL_SOCIAL',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DX_NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|TEST_UNIT|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|PHONE_OR_FAX|EMAIL|IDENTIFIER|ID|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY|TIME_EXPRESSION|TIME_TO_MEDICATION_NAME|TIME_TO_DX_NAME|TIME_TO_TEST_NAME|TIME_TO_PROCEDURE_NAME|TIME_TO_TREATMENT_NAME|AMOUNT|GENDER|RACE_ETHNICITY|ALLERGIES|TOBACCO_USE|ALCOHOL_CONSUMPTION|REC_DRUG_USE',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

The collection of PHI 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 its detection.

ModelVersion

Required: Yes
Type: string

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

InferICD10CM

$result = $client->inferICD10CM([/* ... */]);
$promise = $client->inferICD10CMAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->inferICD10CM([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

The input text used for analysis.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'Category' => 'DX_NAME|TIME_EXPRESSION',
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'RelationshipType' => 'OVERLAP|SYSTEM_ORGAN_SITE|QUALITY',
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'NEGATION|DIAGNOSIS|SIGN|SYMPTOM|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'ACUITY|DIRECTION|SYSTEM_ORGAN_SITE|QUALITY|QUANTITY|TIME_TO_DX_NAME|TIME_EXPRESSION',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICAL_CONDITION',
            'EndOffset' => <integer>,
            'ICD10CMConcepts' => [
                [
                    'Code' => '<string>',
                    'Description' => '<string>',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'NEGATION|DIAGNOSIS|SIGN|SYMPTOM|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'DX_NAME|TIME_EXPRESSION',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
]

Result Details

Members

Entities

Required: Yes
Type: Array of ICD10CMEntity structures

The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

ModelVersion

Type: string

The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result of the previous request to InferICD10CM was truncated, include the PaginationToken to fetch the next page of medical condition entities.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

InferRxNorm

$result = $client->inferRxNorm([/* ... */]);
$promise = $client->inferRxNormAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->inferRxNorm([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

The input text used for analysis.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'NEGATION|PAST_HISTORY',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'DOSAGE|DURATION|FORM|FREQUENCY|RATE|ROUTE_OR_MODE|STRENGTH',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'RxNormConcepts' => [
                [
                    'Code' => '<string>',
                    'Description' => '<string>',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'NEGATION|PAST_HISTORY',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'BRAND_NAME|GENERIC_NAME',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
]

Result Details

Members

Entities

Required: Yes
Type: Array of RxNormEntity structures

The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

ModelVersion

Type: string

The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

InferSNOMEDCT

$result = $client->inferSNOMEDCT([/* ... */]);
$promise = $client->inferSNOMEDCTAsync([/* ... */]);

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

Parameter Syntax

$result = $client->inferSNOMEDCT([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

The input text to be analyzed using InferSNOMEDCT.

Result Syntax

[
    'Characters' => [
        'OriginalTextCharacters' => <integer>,
    ],
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'Category' => 'MEDICAL_CONDITION|ANATOMY|TEST_TREATMENT_PROCEDURE',
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'RelationshipType' => 'ACUITY|QUALITY|TEST_VALUE|TEST_UNITS|DIRECTION|SYSTEM_ORGAN_SITE|TEST_UNIT',
                    'SNOMEDCTConcepts' => [
                        [
                            'Code' => '<string>',
                            'Description' => '<string>',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'NEGATION|DIAGNOSIS|SIGN|SYMPTOM|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'ACUITY|QUALITY|DIRECTION|SYSTEM_ORGAN_SITE|TEST_VALUE|TEST_UNIT',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICAL_CONDITION|ANATOMY|TEST_TREATMENT_PROCEDURE',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'SNOMEDCTConcepts' => [
                [
                    'Code' => '<string>',
                    'Description' => '<string>',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'NEGATION|DIAGNOSIS|SIGN|SYMPTOM|PERTAINS_TO_FAMILY|HYPOTHETICAL|LOW_CONFIDENCE|PAST_HISTORY|FUTURE',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'DX_NAME|TEST_NAME|PROCEDURE_NAME|TREATMENT_NAME',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
    'SNOMEDCTDetails' => [
        'Edition' => '<string>',
        'Language' => '<string>',
        'VersionDate' => '<string>',
    ],
]

Result Details

Members

Characters

Type: Characters structure

The number of characters in the input request documentation.

Entities

Required: Yes
Type: Array of SNOMEDCTEntity structures

The collection of medical concept 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.

ModelVersion

Type: string

The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

PaginationToken

Type: string

If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

SNOMEDCTDetails

Type: SNOMEDCTDetails structure

The details of the SNOMED-CT revision, including the edition, language, and version date.

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
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.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
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.

ListEntitiesDetectionV2Jobs

$result = $client->listEntitiesDetectionV2Jobs([/* ... */]);
$promise = $client->listEntitiesDetectionV2JobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEntitiesDetectionV2Jobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

MaxResults

Type: int

The maximum number of results to return in each page. The default is 100.

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

ListICD10CMInferenceJobs

$result = $client->listICD10CMInferenceJobs([/* ... */]);
$promise = $client->listICD10CMInferenceJobsAsync([/* ... */]);

Gets a list of InferICD10CM jobs that you have submitted.

Parameter Syntax

$result = $client->listICD10CMInferenceJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

MaxResults

Type: int

The maximum number of results to return in each page. The default is 100.

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job that is returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

ListPHIDetectionJobs

$result = $client->listPHIDetectionJobs([/* ... */]);
$promise = $client->listPHIDetectionJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPHIDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

MaxResults

Type: int

The maximum number of results to return in each page. The default is 100.

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

ListRxNormInferenceJobs

$result = $client->listRxNormInferenceJobs([/* ... */]);
$promise = $client->listRxNormInferenceJobsAsync([/* ... */]);

Gets a list of InferRxNorm jobs that you have submitted.

Parameter Syntax

$result = $client->listRxNormInferenceJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

MaxResults

Type: int

Identifies the next page of results to return.

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

The maximum number of results to return in each page. The default is 100.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

ListSNOMEDCTInferenceJobs

$result = $client->listSNOMEDCTInferenceJobs([/* ... */]);
$promise = $client->listSNOMEDCTInferenceJobsAsync([/* ... */]);

Gets a list of InferSNOMEDCT jobs a user has submitted.

Parameter Syntax

$result = $client->listSNOMEDCTInferenceJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

Provides information for filtering a list of detection jobs.

MaxResults

Type: int

The maximum number of results to return in each page. The default is 100.

NextToken

Type: string

Identifies the next page of InferSNOMEDCT results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job that is returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

StartEntitiesDetectionV2Job

$result = $client->startEntitiesDetectionV2Job([/* ... */]);
$promise = $client->startEntitiesDetectionV2JobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startEntitiesDetectionV2Job([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.

DataAccessRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

InputDataConfig

Required: Yes
Type: InputDataConfig structure

The input configuration that specifies the format and location of the input data for the job.

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode

Required: Yes
Type: string

The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

The output configuration that specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of a job, use this identifier with the DescribeEntitiesDetectionV2Job operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StartICD10CMInferenceJob

$result = $client->startICD10CMInferenceJob([/* ... */]);
$promise = $client->startICD10CMInferenceJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startICD10CMInferenceJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

DataAccessRoleArn

Required: Yes
Type: string

InputDataConfig

Required: Yes
Type: InputDataConfig structure

Specifies the format and location of the input data for the job.

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode

Required: Yes
Type: string

The language of the input documents. All documents must be in the same language.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of a job, use this identifier with the StartICD10CMInferenceJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StartPHIDetectionJob

$result = $client->startPHIDetectionJob([/* ... */]);
$promise = $client->startPHIDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startPHIDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

DataAccessRoleArn

Required: Yes
Type: string

InputDataConfig

Required: Yes
Type: InputDataConfig structure

Specifies the format and location of the input data for the job.

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode

Required: Yes
Type: string

The language of the input documents. All documents must be in the same language.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of a job, use this identifier with the DescribePHIDetectionJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StartRxNormInferenceJob

$result = $client->startRxNormInferenceJob([/* ... */]);
$promise = $client->startRxNormInferenceJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startRxNormInferenceJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

DataAccessRoleArn

Required: Yes
Type: string

InputDataConfig

Required: Yes
Type: InputDataConfig structure

Specifies the format and location of the input data for the job.

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode

Required: Yes
Type: string

The language of the input documents. All documents must be in the same language.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier of the job.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StartSNOMEDCTInferenceJob

$result = $client->startSNOMEDCTInferenceJob([/* ... */]);
$promise = $client->startSNOMEDCTInferenceJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startSNOMEDCTInferenceJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

DataAccessRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.

InputDataConfig

Required: Yes
Type: InputDataConfig structure

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.

JobName

Type: string

The user generated name the asynchronous InferSNOMEDCT job.

KMSKey

Type: string

An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode

Required: Yes
Type: string

The language of the input documents. All documents must be in the same language.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

The output properties for a detection job.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
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.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopEntitiesDetectionV2Job

$result = $client->stopEntitiesDetectionV2Job([/* ... */]);
$promise = $client->stopEntitiesDetectionV2JobAsync([/* ... */]);

Stops a medical entities detection job in progress.

Parameter Syntax

$result = $client->stopEntitiesDetectionV2Job([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the medical entities job to stop.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier of the medical entities detection job that was stopped.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopICD10CMInferenceJob

$result = $client->stopICD10CMInferenceJob([/* ... */]);
$promise = $client->stopICD10CMInferenceJobAsync([/* ... */]);

Stops an InferICD10CM inference job in progress.

Parameter Syntax

$result = $client->stopICD10CMInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the job.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of job, use this identifier with the DescribeICD10CMInferenceJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopPHIDetectionJob

$result = $client->stopPHIDetectionJob([/* ... */]);
$promise = $client->stopPHIDetectionJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->stopPHIDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the PHI detection job to stop.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier of the PHI detection job that was stopped.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopRxNormInferenceJob

$result = $client->stopRxNormInferenceJob([/* ... */]);
$promise = $client->stopRxNormInferenceJobAsync([/* ... */]);

Stops an InferRxNorm inference job in progress.

Parameter Syntax

$result = $client->stopRxNormInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the job.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of job, use this identifier with the DescribeRxNormInferenceJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopSNOMEDCTInferenceJob

$result = $client->stopSNOMEDCTInferenceJob([/* ... */]);
$promise = $client->stopSNOMEDCTInferenceJobAsync([/* ... */]);

Stops an InferSNOMEDCT inference job in progress.

Parameter Syntax

$result = $client->stopSNOMEDCTInferenceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The job id of the asynchronous InferSNOMEDCT job to be stopped.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of job, use this identifier with the DescribeSNOMEDCTInferenceJob operation.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
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.
InternalServerException:
An internal server error occurred. Retry your request.

Shapes

Attribute

Description

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.

Members

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of attribute.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RelationshipScore

Type: float

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

RelationshipType

Type: string

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Text

Type: string

The segment of input text extracted as this attribute.

Traits

Type: Array of Trait structures

Contextual information for this attribute.

Type

Type: string

The type of attribute.

Characters

Description

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

Members

OriginalTextCharacters

Type: int

The number of characters present in the input text document as processed by Amazon Comprehend Medical.

ComprehendMedicalAsyncJobFilter

Description

Provides information for filtering a list of detection jobs.

Members

JobName

Type: string

Filters on the name of the job.

JobStatus

Type: string

Filters the list of jobs based on job status. Returns only jobs with the specified status.

SubmitTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

SubmitTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

ComprehendMedicalAsyncJobProperties

Description

Provides information about a detection job.

Members

DataAccessRoleArn

Type: string

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the detection job completed.

ExpirationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

InputDataConfig

Type: InputDataConfig structure

The input data configuration that you supplied when you created the detection job.

JobId

Type: string

The identifier assigned to the detection job.

JobName

Type: string

The name that you assigned to the detection job.

JobStatus

Type: string

The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

KMSKey

Type: string

The AWS Key Management Service key, if any, used to encrypt the output files.

LanguageCode

Type: string

The language code of the input documents.

ManifestFilePath

Type: string

The path to the file that describes the results of a batch job.

Message

Type: string

A description of the status of a job.

ModelVersion

Type: string

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

OutputDataConfig

Type: OutputDataConfig structure

The output data configuration that you supplied when you created the detection job.

SubmitTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the detection job was submitted for processing.

Entity

Description

Provides information about an extracted medical entity.

Members

Attributes

Type: Array of Attribute structures

The extracted attributes that relate to this entity.

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the entity.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

Text

Type: string

The segment of input text extracted as this entity.

Traits

Type: Array of Trait structures

Contextual information for the entity.

Type

Type: string

Describes the specific type of entity with category of entities.

ICD10CMAttribute

Description

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.

Members

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RelationshipScore

Type: float

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

RelationshipType

Type: string

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Text

Type: string

The segment of input text which contains the detected attribute.

Traits

Type: Array of ICD10CMTrait structures

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

Type

Type: string

The type of attribute. InferICD10CM detects entities of the type DX_NAME.

ICD10CMConcept

Description

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

Members

Code

Type: string

The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.

Description

Type: string

The long description of the ICD-10-CM code in the ontology.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM concept.

ICD10CMEntity

Description

Members

Attributes

Type: Array of ICD10CMAttribute structures

The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

ICD10CMConcepts

Type: Array of ICD10CMConcept structures

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

Id

Type: int

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

Text

Type: string

The segment of input text that is matched to the detected entity.

Traits

Type: Array of ICD10CMTrait structures

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

Type

Type: string

Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

ICD10CMTrait

Description

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

Members

Name

Type: string

Provides a name or contextual description about the trait.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as a trait.

InputDataConfig

Description

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.

Members

S3Bucket

Required: Yes
Type: string

The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.

S3Key

Type: string

The path to the input data files in the S3 bucket.

InternalServerException

Description

An internal server error occurred. Retry your request.

Members

Message

Type: string

InvalidEncodingException

Description

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

Members

Message

Type: string

InvalidRequestException

Description

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

Members

Message

Type: string

OutputDataConfig

Description

The output properties for a detection job.

Members

S3Bucket

Required: Yes
Type: string

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.

S3Key

Type: string

The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

ResourceNotFoundException

Description

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

Members

Message

Type: string

RxNormAttribute

Description

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

Members

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RelationshipScore

Type: float

The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Text

Type: string

The segment of input text which corresponds to the detected attribute.

Traits

Type: Array of RxNormTrait structures

Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

Type

Type: string

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

RxNormConcept

Description

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

Members

Code

Type: string

RxNorm concept ID, also known as the RxCUI.

Description

Type: string

The description of the RxNorm concept.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported RxNorm concept.

RxNormEntity

Description

Members

Attributes

Type: Array of RxNormAttribute structures

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

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RxNormConcepts

Type: Array of RxNormConcept structures

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

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Text

Type: string

The segment of input text extracted from which the entity was detected.

Traits

Type: Array of RxNormTrait structures

Contextual information for the entity.

Type

Type: string

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

RxNormTrait

Description

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

Members

Name

Type: string

Provides a name or contextual description about the trait.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.

SNOMEDCTAttribute

Description

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.

Members

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RelationshipScore

Type: float

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

RelationshipType

Type: string

The type of relationship that exists between the entity and the related attribute.

SNOMEDCTConcepts

Type: Array of SNOMEDCTConcept structures

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Text

Type: string

The segment of input text extracted as this attribute.

Traits

Type: Array of SNOMEDCTTrait structures

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

Type

Type: string

The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.

SNOMEDCTConcept

Description

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

Members

Code

Type: string

The numeric ID for the SNOMED-CT concept.

Description

Type: string

The description of the SNOMED-CT concept.

Score

Type: float

The level of confidence Amazon Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.

SNOMEDCTDetails

Description

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.

Members

Edition

Type: string

The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition.

Language

Type: string

The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).

VersionDate

Type: string

The version date of the SNOMED-CT ontology used.

SNOMEDCTEntity

Description

Members

Attributes

Type: Array of SNOMEDCTAttribute structures

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.

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

SNOMEDCTConcepts

Type: Array of SNOMEDCTConcept structures

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

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Text

Type: string

The segment of input text extracted as this entity.

Traits

Type: Array of SNOMEDCTTrait structures

Contextual information for the entity.

Type

Type: string

Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.

SNOMEDCTTrait

Description

Contextual information for an entity.

Members

Name

Type: string

The name or contextual description of a detected trait.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of a detected trait.

ServiceUnavailableException

Description

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

Members

Message

Type: string

TextSizeLimitExceededException

Description

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.

Members

Message

Type: string

TooManyRequestsException

Description

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.

Members

Message

Type: string

Trait

Description

Provides contextual information about the extracted entity.

Members

Name

Type: string

Provides a name or contextual description about the trait.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.

UnmappedAttribute

Description

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

Members

Attribute

Type: Attribute structure

The specific attribute that has been extracted but not mapped to an entity.

Type

Type: string

The type of the unmapped attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".

ValidationException

Description

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

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Comprehend Medical 2018-10-30

Operation Summary

Operations

DescribeEntitiesDetectionV2Job

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeICD10CMInferenceJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribePHIDetectionJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeRxNormInferenceJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeSNOMEDCTInferenceJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectEntities

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectEntitiesV2

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectPHI

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

InferICD10CM

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members