String type
The type of attribute.
Float score
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
Float relationshipScore
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
Integer id
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Integer beginOffset
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.
Integer endOffset
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.
String text
The segment of input text extracted as this attribute.
List<E> traits
Contextual information for this attribute.
String jobName
Filters on the name of the job.
String jobStatus
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
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.
Date submitTimeAfter
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.
String jobId
The identifier assigned to the detection job.
String jobName
The name that you assigned to the detection job.
String jobStatus
The current status of the detection job. If the status is FAILED, the Message field
shows the reason for the failure.
String message
A description of the status of a job.
Date submitTime
The time that the detection job was submitted for processing.
Date endTime
The time that the detection job completed.
Date expirationTime
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 inputDataConfig
The input data configuration that you supplied when you created the detection job.
OutputDataConfig outputDataConfig
The output data configuration that you supplied when you created the detection job.
String languageCode
The language code of the input documents.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
String manifestFilePath
The path to the file that describes the results of a batch job.
String kMSKey
The AWS Key Management Service key, if any, used to encrypt the output files.
String modelVersion
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.
String jobId
The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job
operation returns this identifier in its response.
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties
An object that contains the properties associated with a detection job.
String jobId
The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob
operation returns this identifier in its response.
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties
An object that contains the properties associated with a detection job.
String text
A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
List<E> entities
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.
List<E> unmappedAttributes
Attributes extracted from the input text that we were unable to relate to an entity.
String paginationToken
If the result of the previous request to DetectEntities was truncated, include the
PaginationToken to fetch the next page of entities.
String modelVersion
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.
String text
A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
List<E> entities
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.
List<E> unmappedAttributes
Attributes extracted from the input text that couldn't be related to an entity.
String paginationToken
If the result to the DetectEntitiesV2 operation was truncated, include the
PaginationToken to fetch the next page of entities.
String modelVersion
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.
String text
A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.
List<E> entities
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.
String paginationToken
If the result of the previous request to DetectPHI was truncated, include the
PaginationToken to fetch the next page of PHI entities.
String modelVersion
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.
Integer id
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Integer beginOffset
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.
Integer endOffset
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.
Float score
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
String text
The segment of input text extracted as this entity.
String category
The category of the entity.
String type
Describes the specific type of entity with category of entities.
List<E> traits
Contextual information for the entity.
List<E> attributes
The extracted attributes that relate to this entity.
String type
The type of attribute. InferICD10CM detects entities of the type DX_NAME.
Float score
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
Float relationshipScore
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
Integer id
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Integer beginOffset
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.
Integer endOffset
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.
String text
The segment of input text which contains the detected attribute.
List<E> traits
The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS,
SIGN, SYMPTOM, and NEGATION.
String description
The long description of the ICD-10-CM code in the ontology.
String code
The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.
Float score
The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM concept.
Integer id
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
String text
The segment of input text that is matched to the detected entity.
String category
The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
String type
Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type
DX_NAME.
Float score
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
Integer beginOffset
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.
Integer endOffset
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.
List<E> attributes
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.
List<E> traits
Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS,
SIGN, SYMPTOM, and NEGATION.
List<E> iCD10CMConcepts
The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
String text
The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.
List<E> entities
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.
String paginationToken
If the result of the previous request to InferICD10CM was truncated, include the
PaginationToken to fetch the next page of medical condition entities.
String modelVersion
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.
String text
The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.
List<E> entities
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.
String paginationToken
If the result of the previous request to InferRxNorm was truncated, include the
PaginationToken to fetch the next page of medication entities.
String modelVersion
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.
String s3Bucket
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.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
String s3Key
The path to the input data files in the S3 bucket.
ComprehendMedicalAsyncJobFilter filter
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.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
ComprehendMedicalAsyncJobFilter filter
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.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
String s3Bucket
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.
String s3Key
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.
String type
The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and
GENERIC_NAME.
Float score
The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
Float relationshipScore
The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
Integer id
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Integer beginOffset
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.
Integer endOffset
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.
String text
The segment of input text which corresponds to the detected attribute.
List<E> traits
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.
Integer id
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
String text
The segment of input text extracted from which the entity was detected.
String category
The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
String type
Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
Float score
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
Integer beginOffset
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.
Integer endOffset
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.
List<E> attributes
The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
DOSAGE, DURATION, FORM, FREQUENCY, RATE,
ROUTE_OR_MODE, and STRENGTH.
List<E> traits
Contextual information for the entity.
List<E> rxNormConcepts
The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
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.
String jobName
The identifier of the job.
String clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
String kMSKey
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.
String languageCode
The language of the input documents. All documents must be in the same language.
String jobId
The identifier generated for the job. To get the status of a job, use this identifier with the
DescribeEntitiesDetectionV2Job operation.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
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.
String jobName
The identifier of the job.
String clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
String kMSKey
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.
String languageCode
The language of the input documents. All documents must be in the same language.
String jobId
The identifier generated for the job. To get the status of a job, use this identifier with the
DescribePHIDetectionJob operation.
String jobId
The identifier of the medical entities job to stop.
String jobId
The identifier of the medical entities detection job that was stopped.
String jobId
The identifier of the PHI detection job to stop.
String jobId
The identifier of the PHI detection job that was stopped.
Copyright © 2019. All rights reserved.