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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.