Comprehendmedical

This page documents function available when using the Comprehendmedical module, created with @service Comprehendmedical.

Index

Documentation

Main.Comprehendmedical.describe_entities_detection_v2_jobMethod
describe_entities_detection_v2_job(job_id)
describe_entities_detection_v2_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Comprehend Medical; generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.
Main.Comprehendmedical.describe_icd10_cminference_jobMethod
describe_icd10_cminference_job(job_id)
describe_icd10_cminference_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend Medical generated for the job. The StartICD10CMInferenceJob operation returns this identifier in its response.
Main.Comprehendmedical.describe_phidetection_jobMethod
describe_phidetection_job(job_id)
describe_phidetection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Comprehend Medical; generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.
Main.Comprehendmedical.describe_rx_norm_inference_jobMethod
describe_rx_norm_inference_job(job_id)
describe_rx_norm_inference_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.
Main.Comprehendmedical.describe_snomedctinference_jobMethod
describe_snomedctinference_job(job_id)
describe_snomedctinference_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.
Main.Comprehendmedical.detect_entitiesMethod
detect_entities(text)
detect_entities(text, params::Dict{String,<:Any})

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 .

Arguments

  • 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.
Main.Comprehendmedical.detect_entities_v2Method
detect_entities_v2(text)
detect_entities_v2(text, params::Dict{String,<:Any})

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.

Arguments

  • text: A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
Main.Comprehendmedical.detect_phiMethod
detect_phi(text)
detect_phi(text, params::Dict{String,<:Any})

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.

Arguments

  • 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.
Main.Comprehendmedical.infer_icd10_cmMethod
infer_icd10_cm(text)
infer_icd10_cm(text, params::Dict{String,<:Any})

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.

Arguments

  • text: The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.
Main.Comprehendmedical.infer_rx_normMethod
infer_rx_norm(text)
infer_rx_norm(text, params::Dict{String,<:Any})

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.

Arguments

  • text: The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.
Main.Comprehendmedical.infer_snomedctMethod
infer_snomedct(text)
infer_snomedct(text, params::Dict{String,<:Any})

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

Arguments

  • text: The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.
Main.Comprehendmedical.list_entities_detection_v2_jobsMethod
list_entities_detection_v2_jobs()
list_entities_detection_v2_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehendmedical.list_icd10_cminference_jobsMethod
list_icd10_cminference_jobs()
list_icd10_cminference_jobs(params::Dict{String,<:Any})

Gets a list of InferICD10CM jobs that you have submitted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehendmedical.list_phidetection_jobsMethod
list_phidetection_jobs()
list_phidetection_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "MaxResults": The maximum number of results to return in each page. The default is 100.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehendmedical.list_rx_norm_inference_jobsMethod
list_rx_norm_inference_jobs()
list_rx_norm_inference_jobs(params::Dict{String,<:Any})

Gets a list of InferRxNorm jobs that you have submitted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "MaxResults": Identifies the next page of results to return.
  • "NextToken": Identifies the next page of results to return.
Main.Comprehendmedical.list_snomedctinference_jobsMethod
list_snomedctinference_jobs()
list_snomedctinference_jobs(params::Dict{String,<:Any})

Gets a list of InferSNOMEDCT jobs a user has submitted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter":
  • "MaxResults": The maximum number of results to return in each page. The default is
  • "NextToken": Identifies the next page of InferSNOMEDCT results to return.
Main.Comprehendmedical.start_entities_detection_v2_jobMethod
start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: The input configuration that specifies the format and location of the input data for the job.
  • language_code: The language of the input documents. All documents must be in the same language. Comprehend Medical; processes files in US English (en).
  • output_data_config: The output configuration that specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one for you.
  • "JobName": The identifier of the job.
  • "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.
Main.Comprehendmedical.start_icd10_cminference_jobMethod
start_icd10_cminference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_icd10_cminference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: The language of the input documents. All documents must be in the same language.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
  • "JobName": The identifier of the job.
  • "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.
Main.Comprehendmedical.start_phidetection_jobMethod
start_phidetection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_phidetection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: The language of the input documents. All documents must be in the same language.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
  • "JobName": The identifier of the job.
  • "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.
Main.Comprehendmedical.start_rx_norm_inference_jobMethod
start_rx_norm_inference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_rx_norm_inference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: 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.
  • input_data_config: Specifies the format and location of the input data for the job.
  • language_code: The language of the input documents. All documents must be in the same language.
  • output_data_config: Specifies where to send the output files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
  • "JobName": The identifier of the job.
  • "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.
Main.Comprehendmedical.start_snomedctinference_jobMethod
start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})

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.

Arguments

  • data_access_role_arn: 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.
  • input_data_config:
  • language_code: The language of the input documents. All documents must be in the same language.
  • output_data_config:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
  • "JobName": The user generated name the asynchronous InferSNOMEDCT job.
  • "KMSKey": 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.
Main.Comprehendmedical.stop_entities_detection_v2_jobMethod
stop_entities_detection_v2_job(job_id)
stop_entities_detection_v2_job(job_id, params::Dict{String,<:Any})

Stops a medical entities detection job in progress.

Arguments

  • job_id: The identifier of the medical entities job to stop.
Main.Comprehendmedical.stop_icd10_cminference_jobMethod
stop_icd10_cminference_job(job_id)
stop_icd10_cminference_job(job_id, params::Dict{String,<:Any})

Stops an InferICD10CM inference job in progress.

Arguments

  • job_id: The identifier of the job.
Main.Comprehendmedical.stop_phidetection_jobMethod
stop_phidetection_job(job_id)
stop_phidetection_job(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The identifier of the PHI detection job to stop.
Main.Comprehendmedical.stop_rx_norm_inference_jobMethod
stop_rx_norm_inference_job(job_id)
stop_rx_norm_inference_job(job_id, params::Dict{String,<:Any})

Stops an InferRxNorm inference job in progress.

Arguments

  • job_id: The identifier of the job.
Main.Comprehendmedical.stop_snomedctinference_jobMethod
stop_snomedctinference_job(job_id)
stop_snomedctinference_job(job_id, params::Dict{String,<:Any})

Stops an InferSNOMEDCT inference job in progress.

Arguments

  • job_id: The job id of the asynchronous InferSNOMEDCT job to be stopped.