amazonka-comprehendmedical-2.0: Amazon Comprehend Medical SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ComprehendMedical.Lens

Description

 
Synopsis

Operations

DescribeEntitiesDetectionV2Job

describeEntitiesDetectionV2Job_jobId :: Lens' DescribeEntitiesDetectionV2Job Text Source #

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

DescribeICD10CMInferenceJob

describeICD10CMInferenceJob_jobId :: Lens' DescribeICD10CMInferenceJob Text Source #

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

DescribePHIDetectionJob

describePHIDetectionJob_jobId :: Lens' DescribePHIDetectionJob Text Source #

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

DescribeRxNormInferenceJob

describeRxNormInferenceJob_jobId :: Lens' DescribeRxNormInferenceJob Text Source #

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

DescribeSNOMEDCTInferenceJob

describeSNOMEDCTInferenceJob_jobId :: Lens' DescribeSNOMEDCTInferenceJob Text Source #

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

DetectEntitiesV2

detectEntitiesV2_text :: Lens' DetectEntitiesV2 Text Source #

A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

detectEntitiesV2Response_paginationToken :: Lens' DetectEntitiesV2Response (Maybe Text) Source #

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

detectEntitiesV2Response_unmappedAttributes :: Lens' DetectEntitiesV2Response (Maybe [UnmappedAttribute]) Source #

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

detectEntitiesV2Response_entities :: Lens' DetectEntitiesV2Response [Entity] Source #

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.

detectEntitiesV2Response_modelVersion :: Lens' DetectEntitiesV2Response Text Source #

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.

DetectPHI

detectPHI_text :: Lens' DetectPHI Text Source #

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.

detectPHIResponse_paginationToken :: Lens' DetectPHIResponse (Maybe Text) Source #

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

detectPHIResponse_httpStatus :: Lens' DetectPHIResponse Int Source #

The response's http status code.

detectPHIResponse_entities :: Lens' DetectPHIResponse [Entity] Source #

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 Comprehend Medical; has in its detection.

detectPHIResponse_modelVersion :: Lens' DetectPHIResponse Text Source #

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.

InferICD10CM

inferICD10CM_text :: Lens' InferICD10CM Text Source #

The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.

inferICD10CMResponse_modelVersion :: Lens' InferICD10CMResponse (Maybe Text) Source #

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.

inferICD10CMResponse_paginationToken :: Lens' InferICD10CMResponse (Maybe Text) Source #

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

inferICD10CMResponse_entities :: Lens' InferICD10CMResponse [ICD10CMEntity] Source #

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.

InferRxNorm

inferRxNorm_text :: Lens' InferRxNorm Text Source #

The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

inferRxNormResponse_modelVersion :: Lens' InferRxNormResponse (Maybe Text) Source #

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.

inferRxNormResponse_paginationToken :: Lens' InferRxNormResponse (Maybe Text) Source #

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

inferRxNormResponse_entities :: Lens' InferRxNormResponse [RxNormEntity] Source #

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.

InferSNOMEDCT

inferSNOMEDCT_text :: Lens' InferSNOMEDCT Text Source #

The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.

inferSNOMEDCTResponse_characters :: Lens' InferSNOMEDCTResponse (Maybe Characters) Source #

The number of characters in the input request documentation.

inferSNOMEDCTResponse_modelVersion :: Lens' InferSNOMEDCTResponse (Maybe Text) Source #

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.

inferSNOMEDCTResponse_paginationToken :: Lens' InferSNOMEDCTResponse (Maybe Text) Source #

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

inferSNOMEDCTResponse_sNOMEDCTDetails :: Lens' InferSNOMEDCTResponse (Maybe SNOMEDCTDetails) Source #

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

inferSNOMEDCTResponse_entities :: Lens' InferSNOMEDCTResponse [SNOMEDCTEntity] Source #

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

ListEntitiesDetectionV2Jobs

listEntitiesDetectionV2Jobs_filter :: Lens' ListEntitiesDetectionV2Jobs (Maybe ComprehendMedicalAsyncJobFilter) Source #

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.

listEntitiesDetectionV2Jobs_maxResults :: Lens' ListEntitiesDetectionV2Jobs (Maybe Natural) Source #

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

listEntitiesDetectionV2Jobs_nextToken :: Lens' ListEntitiesDetectionV2Jobs (Maybe Text) Source #

Identifies the next page of results to return.

ListICD10CMInferenceJobs

listICD10CMInferenceJobs_filter :: Lens' ListICD10CMInferenceJobs (Maybe ComprehendMedicalAsyncJobFilter) Source #

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.

listICD10CMInferenceJobs_maxResults :: Lens' ListICD10CMInferenceJobs (Maybe Natural) Source #

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

listICD10CMInferenceJobs_nextToken :: Lens' ListICD10CMInferenceJobs (Maybe Text) Source #

Identifies the next page of results to return.

ListPHIDetectionJobs

listPHIDetectionJobs_filter :: Lens' ListPHIDetectionJobs (Maybe ComprehendMedicalAsyncJobFilter) Source #

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.

listPHIDetectionJobs_maxResults :: Lens' ListPHIDetectionJobs (Maybe Natural) Source #

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

listPHIDetectionJobs_nextToken :: Lens' ListPHIDetectionJobs (Maybe Text) Source #

Identifies the next page of results to return.

ListRxNormInferenceJobs

listRxNormInferenceJobs_filter :: Lens' ListRxNormInferenceJobs (Maybe ComprehendMedicalAsyncJobFilter) Source #

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.

listRxNormInferenceJobs_maxResults :: Lens' ListRxNormInferenceJobs (Maybe Natural) Source #

Identifies the next page of results to return.

listRxNormInferenceJobs_nextToken :: Lens' ListRxNormInferenceJobs (Maybe Text) Source #

Identifies the next page of results to return.

ListSNOMEDCTInferenceJobs

listSNOMEDCTInferenceJobs_maxResults :: Lens' ListSNOMEDCTInferenceJobs (Maybe Natural) Source #

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

listSNOMEDCTInferenceJobs_nextToken :: Lens' ListSNOMEDCTInferenceJobs (Maybe Text) Source #

Identifies the next page of InferSNOMEDCT results to return.

StartEntitiesDetectionV2Job

startEntitiesDetectionV2Job_clientRequestToken :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #

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

startEntitiesDetectionV2Job_kmsKey :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #

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.

startEntitiesDetectionV2Job_inputDataConfig :: Lens' StartEntitiesDetectionV2Job InputDataConfig Source #

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

startEntitiesDetectionV2Job_outputDataConfig :: Lens' StartEntitiesDetectionV2Job OutputDataConfig Source #

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

startEntitiesDetectionV2Job_dataAccessRoleArn :: Lens' StartEntitiesDetectionV2Job Text Source #

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

startEntitiesDetectionV2Job_languageCode :: Lens' StartEntitiesDetectionV2Job LanguageCode Source #

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

startEntitiesDetectionV2JobResponse_jobId :: Lens' StartEntitiesDetectionV2JobResponse (Maybe Text) Source #

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

StartICD10CMInferenceJob

startICD10CMInferenceJob_clientRequestToken :: Lens' StartICD10CMInferenceJob (Maybe Text) Source #

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

startICD10CMInferenceJob_kmsKey :: Lens' StartICD10CMInferenceJob (Maybe Text) Source #

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.

startICD10CMInferenceJob_inputDataConfig :: Lens' StartICD10CMInferenceJob InputDataConfig Source #

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

startICD10CMInferenceJob_dataAccessRoleArn :: Lens' StartICD10CMInferenceJob Text Source #

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

startICD10CMInferenceJob_languageCode :: Lens' StartICD10CMInferenceJob LanguageCode Source #

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

startICD10CMInferenceJobResponse_jobId :: Lens' StartICD10CMInferenceJobResponse (Maybe Text) Source #

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

StartPHIDetectionJob

startPHIDetectionJob_clientRequestToken :: Lens' StartPHIDetectionJob (Maybe Text) Source #

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

startPHIDetectionJob_kmsKey :: Lens' StartPHIDetectionJob (Maybe Text) Source #

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.

startPHIDetectionJob_inputDataConfig :: Lens' StartPHIDetectionJob InputDataConfig Source #

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

startPHIDetectionJob_dataAccessRoleArn :: Lens' StartPHIDetectionJob Text Source #

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

startPHIDetectionJob_languageCode :: Lens' StartPHIDetectionJob LanguageCode Source #

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

startPHIDetectionJobResponse_jobId :: Lens' StartPHIDetectionJobResponse (Maybe Text) Source #

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

StartRxNormInferenceJob

startRxNormInferenceJob_clientRequestToken :: Lens' StartRxNormInferenceJob (Maybe Text) Source #

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

startRxNormInferenceJob_kmsKey :: Lens' StartRxNormInferenceJob (Maybe Text) Source #

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.

startRxNormInferenceJob_inputDataConfig :: Lens' StartRxNormInferenceJob InputDataConfig Source #

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

startRxNormInferenceJob_dataAccessRoleArn :: Lens' StartRxNormInferenceJob Text Source #

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

startRxNormInferenceJob_languageCode :: Lens' StartRxNormInferenceJob LanguageCode Source #

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

StartSNOMEDCTInferenceJob

startSNOMEDCTInferenceJob_clientRequestToken :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

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

startSNOMEDCTInferenceJob_jobName :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

The user generated name the asynchronous InferSNOMEDCT job.

startSNOMEDCTInferenceJob_kmsKey :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

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.

startSNOMEDCTInferenceJob_dataAccessRoleArn :: Lens' StartSNOMEDCTInferenceJob Text Source #

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.

startSNOMEDCTInferenceJob_languageCode :: Lens' StartSNOMEDCTInferenceJob LanguageCode Source #

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

startSNOMEDCTInferenceJobResponse_jobId :: Lens' StartSNOMEDCTInferenceJobResponse (Maybe Text) Source #

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

StopEntitiesDetectionV2Job

stopEntitiesDetectionV2Job_jobId :: Lens' StopEntitiesDetectionV2Job Text Source #

The identifier of the medical entities job to stop.

stopEntitiesDetectionV2JobResponse_jobId :: Lens' StopEntitiesDetectionV2JobResponse (Maybe Text) Source #

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

StopICD10CMInferenceJob

stopICD10CMInferenceJobResponse_jobId :: Lens' StopICD10CMInferenceJobResponse (Maybe Text) Source #

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

StopPHIDetectionJob

stopPHIDetectionJob_jobId :: Lens' StopPHIDetectionJob Text Source #

The identifier of the PHI detection job to stop.

stopPHIDetectionJobResponse_jobId :: Lens' StopPHIDetectionJobResponse (Maybe Text) Source #

The identifier of the PHI detection job that was stopped.

StopRxNormInferenceJob

stopRxNormInferenceJobResponse_jobId :: Lens' StopRxNormInferenceJobResponse (Maybe Text) Source #

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

StopSNOMEDCTInferenceJob

stopSNOMEDCTInferenceJob_jobId :: Lens' StopSNOMEDCTInferenceJob Text Source #

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

stopSNOMEDCTInferenceJobResponse_jobId :: Lens' StopSNOMEDCTInferenceJobResponse (Maybe Text) Source #

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

Types

Attribute

attribute_beginOffset :: Lens' Attribute (Maybe Int) Source #

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.

attribute_category :: Lens' Attribute (Maybe EntityType) Source #

The category of attribute.

attribute_endOffset :: Lens' Attribute (Maybe Int) Source #

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.

attribute_id :: Lens' Attribute (Maybe Int) Source #

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

attribute_relationshipScore :: Lens' Attribute (Maybe Double) Source #

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

attribute_relationshipType :: Lens' Attribute (Maybe RelationshipType) Source #

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.

attribute_score :: Lens' Attribute (Maybe Double) Source #

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

attribute_text :: Lens' Attribute (Maybe Text) Source #

The segment of input text extracted as this attribute.

attribute_traits :: Lens' Attribute (Maybe [Trait]) Source #

Contextual information for this attribute.

Characters

characters_originalTextCharacters :: Lens' Characters (Maybe Int) Source #

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

ComprehendMedicalAsyncJobFilter

comprehendMedicalAsyncJobFilter_jobStatus :: Lens' ComprehendMedicalAsyncJobFilter (Maybe JobStatus) Source #

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

comprehendMedicalAsyncJobFilter_submitTimeAfter :: Lens' ComprehendMedicalAsyncJobFilter (Maybe UTCTime) Source #

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.

comprehendMedicalAsyncJobFilter_submitTimeBefore :: Lens' ComprehendMedicalAsyncJobFilter (Maybe UTCTime) Source #

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

comprehendMedicalAsyncJobProperties_dataAccessRoleArn :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

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

comprehendMedicalAsyncJobProperties_expirationTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #

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.

comprehendMedicalAsyncJobProperties_inputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe InputDataConfig) Source #

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

comprehendMedicalAsyncJobProperties_jobStatus :: Lens' ComprehendMedicalAsyncJobProperties (Maybe JobStatus) Source #

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

comprehendMedicalAsyncJobProperties_kmsKey :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

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

comprehendMedicalAsyncJobProperties_manifestFilePath :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

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

comprehendMedicalAsyncJobProperties_modelVersion :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

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.

comprehendMedicalAsyncJobProperties_outputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe OutputDataConfig) Source #

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

comprehendMedicalAsyncJobProperties_submitTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #

The time that the detection job was submitted for processing.

Entity

entity_attributes :: Lens' Entity (Maybe [Attribute]) Source #

The extracted attributes that relate to this entity.

entity_beginOffset :: Lens' Entity (Maybe Int) Source #

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.

entity_category :: Lens' Entity (Maybe EntityType) Source #

The category of the entity.

entity_endOffset :: Lens' Entity (Maybe Int) Source #

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.

entity_id :: Lens' Entity (Maybe Int) Source #

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

entity_score :: Lens' Entity (Maybe Double) Source #

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

entity_text :: Lens' Entity (Maybe Text) Source #

The segment of input text extracted as this entity.

entity_traits :: Lens' Entity (Maybe [Trait]) Source #

Contextual information for the entity.

entity_type :: Lens' Entity (Maybe EntitySubType) Source #

Describes the specific type of entity with category of entities.

ICD10CMAttribute

iCD10CMAttribute_beginOffset :: Lens' ICD10CMAttribute (Maybe Int) Source #

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.

iCD10CMAttribute_category :: Lens' ICD10CMAttribute (Maybe ICD10CMEntityType) Source #

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

iCD10CMAttribute_endOffset :: Lens' ICD10CMAttribute (Maybe Int) Source #

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.

iCD10CMAttribute_id :: Lens' ICD10CMAttribute (Maybe Int) Source #

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

iCD10CMAttribute_relationshipScore :: Lens' ICD10CMAttribute (Maybe Double) Source #

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

iCD10CMAttribute_relationshipType :: Lens' ICD10CMAttribute (Maybe ICD10CMRelationshipType) Source #

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

iCD10CMAttribute_score :: Lens' ICD10CMAttribute (Maybe Double) Source #

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

iCD10CMAttribute_text :: Lens' ICD10CMAttribute (Maybe Text) Source #

The segment of input text which contains the detected attribute.

iCD10CMAttribute_traits :: Lens' ICD10CMAttribute (Maybe [ICD10CMTrait]) Source #

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

iCD10CMAttribute_type :: Lens' ICD10CMAttribute (Maybe ICD10CMAttributeType) Source #

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

ICD10CMConcept

iCD10CMConcept_code :: Lens' ICD10CMConcept (Maybe Text) Source #

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

iCD10CMConcept_description :: Lens' ICD10CMConcept (Maybe Text) Source #

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

iCD10CMConcept_score :: Lens' ICD10CMConcept (Maybe Double) Source #

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

ICD10CMEntity

iCD10CMEntity_attributes :: Lens' ICD10CMEntity (Maybe [ICD10CMAttribute]) Source #

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.

iCD10CMEntity_beginOffset :: Lens' ICD10CMEntity (Maybe Int) Source #

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.

iCD10CMEntity_category :: Lens' ICD10CMEntity (Maybe ICD10CMEntityCategory) Source #

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

iCD10CMEntity_endOffset :: Lens' ICD10CMEntity (Maybe Int) Source #

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.

iCD10CMEntity_iCD10CMConcepts :: Lens' ICD10CMEntity (Maybe [ICD10CMConcept]) Source #

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

iCD10CMEntity_id :: Lens' ICD10CMEntity (Maybe Int) Source #

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

iCD10CMEntity_score :: Lens' ICD10CMEntity (Maybe Double) Source #

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

iCD10CMEntity_text :: Lens' ICD10CMEntity (Maybe Text) Source #

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

iCD10CMEntity_traits :: Lens' ICD10CMEntity (Maybe [ICD10CMTrait]) Source #

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

iCD10CMEntity_type :: Lens' ICD10CMEntity (Maybe ICD10CMEntityType) Source #

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

ICD10CMTrait

iCD10CMTrait_name :: Lens' ICD10CMTrait (Maybe ICD10CMTraitName) Source #

Provides a name or contextual description about the trait.

iCD10CMTrait_score :: Lens' ICD10CMTrait (Maybe Double) Source #

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

InputDataConfig

inputDataConfig_s3Key :: Lens' InputDataConfig (Maybe Text) Source #

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

inputDataConfig_s3Bucket :: Lens' InputDataConfig Text Source #

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.

OutputDataConfig

outputDataConfig_s3Key :: Lens' OutputDataConfig (Maybe Text) Source #

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

outputDataConfig_s3Bucket :: Lens' OutputDataConfig Text Source #

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.

RxNormAttribute

rxNormAttribute_beginOffset :: Lens' RxNormAttribute (Maybe Int) Source #

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.

rxNormAttribute_endOffset :: Lens' RxNormAttribute (Maybe Int) Source #

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.

rxNormAttribute_id :: Lens' RxNormAttribute (Maybe Int) Source #

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

rxNormAttribute_relationshipScore :: Lens' RxNormAttribute (Maybe Double) Source #

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

rxNormAttribute_score :: Lens' RxNormAttribute (Maybe Double) Source #

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

rxNormAttribute_text :: Lens' RxNormAttribute (Maybe Text) Source #

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

rxNormAttribute_traits :: Lens' RxNormAttribute (Maybe [RxNormTrait]) Source #

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.

rxNormAttribute_type :: Lens' RxNormAttribute (Maybe RxNormAttributeType) Source #

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

RxNormConcept

rxNormConcept_code :: Lens' RxNormConcept (Maybe Text) Source #

RxNorm concept ID, also known as the RxCUI.

rxNormConcept_description :: Lens' RxNormConcept (Maybe Text) Source #

The description of the RxNorm concept.

rxNormConcept_score :: Lens' RxNormConcept (Maybe Double) Source #

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

RxNormEntity

rxNormEntity_attributes :: Lens' RxNormEntity (Maybe [RxNormAttribute]) Source #

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

rxNormEntity_beginOffset :: Lens' RxNormEntity (Maybe Int) Source #

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.

rxNormEntity_category :: Lens' RxNormEntity (Maybe RxNormEntityCategory) Source #

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

rxNormEntity_endOffset :: Lens' RxNormEntity (Maybe Int) Source #

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.

rxNormEntity_id :: Lens' RxNormEntity (Maybe Int) Source #

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

rxNormEntity_rxNormConcepts :: Lens' RxNormEntity (Maybe [RxNormConcept]) Source #

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

rxNormEntity_score :: Lens' RxNormEntity (Maybe Double) Source #

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

rxNormEntity_text :: Lens' RxNormEntity (Maybe Text) Source #

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

rxNormEntity_traits :: Lens' RxNormEntity (Maybe [RxNormTrait]) Source #

Contextual information for the entity.

rxNormEntity_type :: Lens' RxNormEntity (Maybe RxNormEntityType) Source #

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

RxNormTrait

rxNormTrait_name :: Lens' RxNormTrait (Maybe RxNormTraitName) Source #

Provides a name or contextual description about the trait.

rxNormTrait_score :: Lens' RxNormTrait (Maybe Double) Source #

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

SNOMEDCTAttribute

sNOMEDCTAttribute_beginOffset :: Lens' SNOMEDCTAttribute (Maybe Int) Source #

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.

sNOMEDCTAttribute_category :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTEntityCategory) Source #

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

sNOMEDCTAttribute_endOffset :: Lens' SNOMEDCTAttribute (Maybe Int) Source #

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.

sNOMEDCTAttribute_id :: Lens' SNOMEDCTAttribute (Maybe Int) Source #

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

sNOMEDCTAttribute_relationshipScore :: Lens' SNOMEDCTAttribute (Maybe Double) Source #

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

sNOMEDCTAttribute_relationshipType :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTRelationshipType) Source #

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

sNOMEDCTAttribute_sNOMEDCTConcepts :: Lens' SNOMEDCTAttribute (Maybe [SNOMEDCTConcept]) Source #

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

sNOMEDCTAttribute_score :: Lens' SNOMEDCTAttribute (Maybe Double) Source #

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

sNOMEDCTAttribute_text :: Lens' SNOMEDCTAttribute (Maybe Text) Source #

The segment of input text extracted as this attribute.

sNOMEDCTAttribute_traits :: Lens' SNOMEDCTAttribute (Maybe [SNOMEDCTTrait]) Source #

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

sNOMEDCTAttribute_type :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTAttributeType) Source #

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

sNOMEDCTConcept_code :: Lens' SNOMEDCTConcept (Maybe Text) Source #

The numeric ID for the SNOMED-CT concept.

sNOMEDCTConcept_description :: Lens' SNOMEDCTConcept (Maybe Text) Source #

The description of the SNOMED-CT concept.

sNOMEDCTConcept_score :: Lens' SNOMEDCTConcept (Maybe Double) Source #

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

SNOMEDCTDetails

sNOMEDCTDetails_edition :: Lens' SNOMEDCTDetails (Maybe Text) Source #

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

sNOMEDCTDetails_language :: Lens' SNOMEDCTDetails (Maybe Text) Source #

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

sNOMEDCTDetails_versionDate :: Lens' SNOMEDCTDetails (Maybe Text) Source #

The version date of the SNOMED-CT ontology used.

SNOMEDCTEntity

sNOMEDCTEntity_attributes :: Lens' SNOMEDCTEntity (Maybe [SNOMEDCTAttribute]) Source #

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.

sNOMEDCTEntity_beginOffset :: Lens' SNOMEDCTEntity (Maybe Int) Source #

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.

sNOMEDCTEntity_category :: Lens' SNOMEDCTEntity (Maybe SNOMEDCTEntityCategory) Source #

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

sNOMEDCTEntity_endOffset :: Lens' SNOMEDCTEntity (Maybe Int) Source #

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.

sNOMEDCTEntity_id :: Lens' SNOMEDCTEntity (Maybe Int) Source #

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

sNOMEDCTEntity_sNOMEDCTConcepts :: Lens' SNOMEDCTEntity (Maybe [SNOMEDCTConcept]) Source #

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

sNOMEDCTEntity_score :: Lens' SNOMEDCTEntity (Maybe Double) Source #

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

sNOMEDCTEntity_text :: Lens' SNOMEDCTEntity (Maybe Text) Source #

The segment of input text extracted as this entity.

sNOMEDCTEntity_traits :: Lens' SNOMEDCTEntity (Maybe [SNOMEDCTTrait]) Source #

Contextual information for the entity.

sNOMEDCTEntity_type :: Lens' SNOMEDCTEntity (Maybe SNOMEDCTEntityType) Source #

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

sNOMEDCTTrait_name :: Lens' SNOMEDCTTrait (Maybe SNOMEDCTTraitName) Source #

The name or contextual description of a detected trait.

sNOMEDCTTrait_score :: Lens' SNOMEDCTTrait (Maybe Double) Source #

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

Trait

trait_name :: Lens' Trait (Maybe AttributeName) Source #

Provides a name or contextual description about the trait.

trait_score :: Lens' Trait (Maybe Double) Source #

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

UnmappedAttribute

unmappedAttribute_attribute :: Lens' UnmappedAttribute (Maybe Attribute) Source #

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

unmappedAttribute_type :: Lens' UnmappedAttribute (Maybe EntityType) Source #

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".