Class: AWS.ComprehendMedical

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.describeICD10CMInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobProperties — (map)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.describePHIDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobProperties — (map)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.describeRxNormInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobProperties — (map)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.describeSNOMEDCTInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobProperties — (map)

      Provides information about a detection job.

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.detectEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      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.

      • Id — (Integer)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Score — (Float)

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

      • Text — (String)

        The segment of input text extracted as this entity.

      • Category — (String)

        The category of the entity.

        Possible values include:
        • "MEDICATION"
        • "MEDICAL_CONDITION"
        • "PROTECTED_HEALTH_INFORMATION"
        • "TEST_TREATMENT_PROCEDURE"
        • "ANATOMY"
        • "TIME_EXPRESSION"
        • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
      • Type — (String)

        Describes the specific type of entity with category of entities.

        Possible values include:
        • "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"
      • Traits — (Array<map>)

        Contextual information for the entity.

        • Name — (String)

          Provides a name or contextual description about the trait.

          Possible values include:
          • "SIGN"
          • "SYMPTOM"
          • "DIAGNOSIS"
          • "NEGATION"
          • "PERTAINS_TO_FAMILY"
          • "HYPOTHETICAL"
          • "LOW_CONFIDENCE"
          • "PAST_HISTORY"
          • "FUTURE"
        • Score — (Float)

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

      • Attributes — (Array<map>)

        The extracted attributes that relate to this entity.

        • Type — (String)

          The type of attribute.

          Possible values include:
          • "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"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "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"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Category — (String)

          The category of attribute.

          Possible values include:
          • "MEDICATION"
          • "MEDICAL_CONDITION"
          • "PROTECTED_HEALTH_INFORMATION"
          • "TEST_TREATMENT_PROCEDURE"
          • "ANATOMY"
          • "TIME_EXPRESSION"
          • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
        • Traits — (Array<map>)

          Contextual information for this attribute.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "SIGN"
            • "SYMPTOM"
            • "DIAGNOSIS"
            • "NEGATION"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

    • UnmappedAttributes — (Array<map>)

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

      • Type — (String)

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

        Possible values include:
        • "MEDICATION"
        • "MEDICAL_CONDITION"
        • "PROTECTED_HEALTH_INFORMATION"
        • "TEST_TREATMENT_PROCEDURE"
        • "ANATOMY"
        • "TIME_EXPRESSION"
        • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
      • Attribute — (map)

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

        • Type — (String)

          The type of attribute.

          Possible values include:
          • "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"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "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"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Category — (String)

          The category of attribute.

          Possible values include:
          • "MEDICATION"
          • "MEDICAL_CONDITION"
          • "PROTECTED_HEALTH_INFORMATION"
          • "TEST_TREATMENT_PROCEDURE"
          • "ANATOMY"
          • "TIME_EXPRESSION"
          • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
        • Traits — (Array<map>)

          Contextual information for this attribute.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "SIGN"
            • "SYMPTOM"
            • "DIAGNOSIS"
            • "NEGATION"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.detectEntitiesV2(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      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.

      • Id — (Integer)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Score — (Float)

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

      • Text — (String)

        The segment of input text extracted as this entity.

      • Category — (String)

        The category of the entity.

        Possible values include:
        • "MEDICATION"
        • "MEDICAL_CONDITION"
        • "PROTECTED_HEALTH_INFORMATION"
        • "TEST_TREATMENT_PROCEDURE"
        • "ANATOMY"
        • "TIME_EXPRESSION"
        • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
      • Type — (String)

        Describes the specific type of entity with category of entities.

        Possible values include:
        • "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"
      • Traits — (Array<map>)

        Contextual information for the entity.

        • Name — (String)

          Provides a name or contextual description about the trait.

          Possible values include:
          • "SIGN"
          • "SYMPTOM"
          • "DIAGNOSIS"
          • "NEGATION"
          • "PERTAINS_TO_FAMILY"
          • "HYPOTHETICAL"
          • "LOW_CONFIDENCE"
          • "PAST_HISTORY"
          • "FUTURE"
        • Score — (Float)

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

      • Attributes — (Array<map>)

        The extracted attributes that relate to this entity.

        • Type — (String)

          The type of attribute.

          Possible values include:
          • "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"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "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"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Category — (String)

          The category of attribute.

          Possible values include:
          • "MEDICATION"
          • "MEDICAL_CONDITION"
          • "PROTECTED_HEALTH_INFORMATION"
          • "TEST_TREATMENT_PROCEDURE"
          • "ANATOMY"
          • "TIME_EXPRESSION"
          • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
        • Traits — (Array<map>)

          Contextual information for this attribute.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "SIGN"
            • "SYMPTOM"
            • "DIAGNOSIS"
            • "NEGATION"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

    • UnmappedAttributes — (Array<map>)

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

      • Type — (String)

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

        Possible values include:
        • "MEDICATION"
        • "MEDICAL_CONDITION"
        • "PROTECTED_HEALTH_INFORMATION"
        • "TEST_TREATMENT_PROCEDURE"
        • "ANATOMY"
        • "TIME_EXPRESSION"
        • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
      • Attribute — (map)

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

        • Type — (String)

          The type of attribute.

          Possible values include:
          • "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"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "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"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Category — (String)

          The category of attribute.

          Possible values include:
          • "MEDICATION"
          • "MEDICAL_CONDITION"
          • "PROTECTED_HEALTH_INFORMATION"
          • "TEST_TREATMENT_PROCEDURE"
          • "ANATOMY"
          • "TIME_EXPRESSION"
          • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
        • Traits — (Array<map>)

          Contextual information for this attribute.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "SIGN"
            • "SYMPTOM"
            • "DIAGNOSIS"
            • "NEGATION"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.detectPHI(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      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.

      • Id — (Integer)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Score — (Float)

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

      • Text — (String)

        The segment of input text extracted as this entity.

      • Category — (String)

        The category of the entity.

        Possible values include:
        • "MEDICATION"
        • "MEDICAL_CONDITION"
        • "PROTECTED_HEALTH_INFORMATION"
        • "TEST_TREATMENT_PROCEDURE"
        • "ANATOMY"
        • "TIME_EXPRESSION"
        • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
      • Type — (String)

        Describes the specific type of entity with category of entities.

        Possible values include:
        • "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"
      • Traits — (Array<map>)

        Contextual information for the entity.

        • Name — (String)

          Provides a name or contextual description about the trait.

          Possible values include:
          • "SIGN"
          • "SYMPTOM"
          • "DIAGNOSIS"
          • "NEGATION"
          • "PERTAINS_TO_FAMILY"
          • "HYPOTHETICAL"
          • "LOW_CONFIDENCE"
          • "PAST_HISTORY"
          • "FUTURE"
        • Score — (Float)

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

      • Attributes — (Array<map>)

        The extracted attributes that relate to this entity.

        • Type — (String)

          The type of attribute.

          Possible values include:
          • "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"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "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"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Category — (String)

          The category of attribute.

          Possible values include:
          • "MEDICATION"
          • "MEDICAL_CONDITION"
          • "PROTECTED_HEALTH_INFORMATION"
          • "TEST_TREATMENT_PROCEDURE"
          • "ANATOMY"
          • "TIME_EXPRESSION"
          • "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
        • Traits — (Array<map>)

          Contextual information for this attribute.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "SIGN"
            • "SYMPTOM"
            • "DIAGNOSIS"
            • "NEGATION"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.inferICD10CM(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

    The input text used for analysis.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      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.

      • Id — (Integer)

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

      • Text — (String)

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

      • Category — (String)

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

        Possible values include:
        • "MEDICAL_CONDITION"
      • Type — (String)

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

        Possible values include:
        • "DX_NAME"
        • "TIME_EXPRESSION"
      • Score — (Float)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Attributes — (Array<map>)

        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.

        • Type — (String)

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

          Possible values include:
          • "ACUITY"
          • "DIRECTION"
          • "SYSTEM_ORGAN_SITE"
          • "QUALITY"
          • "QUANTITY"
          • "TIME_TO_DX_NAME"
          • "TIME_EXPRESSION"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text which contains the detected attribute.

        • Traits — (Array<map>)

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

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "NEGATION"
            • "DIAGNOSIS"
            • "SIGN"
            • "SYMPTOM"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
          • Score — (Float)

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

        • Category — (String)

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

          Possible values include:
          • "DX_NAME"
          • "TIME_EXPRESSION"
        • RelationshipType — (String)

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

          Possible values include:
          • "OVERLAP"
          • "SYSTEM_ORGAN_SITE"
          • "QUALITY"
      • Traits — (Array<map>)

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

        • Name — (String)

          Provides a name or contextual description about the trait.

          Possible values include:
          • "NEGATION"
          • "DIAGNOSIS"
          • "SIGN"
          • "SYMPTOM"
          • "PERTAINS_TO_FAMILY"
          • "HYPOTHETICAL"
          • "LOW_CONFIDENCE"
        • Score — (Float)

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

      • ICD10CMConcepts — (Array<map>)

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

        • Description — (String)

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

        • Code — (String)

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

        • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.inferRxNorm(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

    The input text used for analysis.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      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.

      • Id — (Integer)

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

      • Text — (String)

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

      • Category — (String)

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

        Possible values include:
        • "MEDICATION"
      • Type — (String)

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

        Possible values include:
        • "BRAND_NAME"
        • "GENERIC_NAME"
      • Score — (Float)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Attributes — (Array<map>)

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

        • Type — (String)

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

          Possible values include:
          • "DOSAGE"
          • "DURATION"
          • "FORM"
          • "FREQUENCY"
          • "RATE"
          • "ROUTE_OR_MODE"
          • "STRENGTH"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

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

        • Traits — (Array<map>)

          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.

          • Name — (String)

            Provides a name or contextual description about the trait.

            Possible values include:
            • "NEGATION"
            • "PAST_HISTORY"
          • Score — (Float)

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

      • Traits — (Array<map>)

        Contextual information for the entity.

        • Name — (String)

          Provides a name or contextual description about the trait.

          Possible values include:
          • "NEGATION"
          • "PAST_HISTORY"
        • Score — (Float)

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

      • RxNormConcepts — (Array<map>)

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

        • Description — (String)

          The description of the RxNorm concept.

        • Code — (String)

          RxNorm concept ID, also known as the RxCUI.

        • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Text: 'STRING_VALUE' /* required */
};
comprehendmedical.inferSNOMEDCT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

    The input text to be analyzed using InferSNOMEDCT.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Entities — (Array<map>)

      The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

      • Id — (Integer)

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

      • Text — (String)

        The segment of input text extracted as this entity.

      • Category — (String)

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

        Possible values include:
        • "MEDICAL_CONDITION"
        • "ANATOMY"
        • "TEST_TREATMENT_PROCEDURE"
      • Type — (String)

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

        Possible values include:
        • "DX_NAME"
        • "TEST_NAME"
        • "PROCEDURE_NAME"
        • "TREATMENT_NAME"
      • Score — (Float)

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

      • BeginOffset — (Integer)

        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.

      • EndOffset — (Integer)

        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.

      • Attributes — (Array<map>)

        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.

        • Category — (String)

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

          Possible values include:
          • "MEDICAL_CONDITION"
          • "ANATOMY"
          • "TEST_TREATMENT_PROCEDURE"
        • Type — (String)

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

          Possible values include:
          • "ACUITY"
          • "QUALITY"
          • "DIRECTION"
          • "SYSTEM_ORGAN_SITE"
          • "TEST_VALUE"
          • "TEST_UNIT"
        • Score — (Float)

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

        • RelationshipScore — (Float)

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

        • RelationshipType — (String)

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

          Possible values include:
          • "ACUITY"
          • "QUALITY"
          • "TEST_VALUE"
          • "TEST_UNITS"
          • "DIRECTION"
          • "SYSTEM_ORGAN_SITE"
          • "TEST_UNIT"
        • Id — (Integer)

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

        • BeginOffset — (Integer)

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

        • EndOffset — (Integer)

          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.

        • Text — (String)

          The segment of input text extracted as this attribute.

        • Traits — (Array<map>)

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

          • Name — (String)

            The name or contextual description of a detected trait.

            Possible values include:
            • "NEGATION"
            • "DIAGNOSIS"
            • "SIGN"
            • "SYMPTOM"
            • "PERTAINS_TO_FAMILY"
            • "HYPOTHETICAL"
            • "LOW_CONFIDENCE"
            • "PAST_HISTORY"
            • "FUTURE"
          • Score — (Float)

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

        • SNOMEDCTConcepts — (Array<map>)

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

          • Description — (String)

            The description of the SNOMED-CT concept.

          • Code — (String)

            The numeric ID for the SNOMED-CT concept.

          • Score — (Float)

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

      • Traits — (Array<map>)

        Contextual information for the entity.

        • Name — (String)

          The name or contextual description of a detected trait.

          Possible values include:
          • "NEGATION"
          • "DIAGNOSIS"
          • "SIGN"
          • "SYMPTOM"
          • "PERTAINS_TO_FAMILY"
          • "HYPOTHETICAL"
          • "LOW_CONFIDENCE"
          • "PAST_HISTORY"
          • "FUTURE"
        • Score — (Float)

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

      • SNOMEDCTConcepts — (Array<map>)

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

        • Description — (String)

          The description of the SNOMED-CT concept.

        • Code — (String)

          The numeric ID for the SNOMED-CT concept.

        • Score — (Float)

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

    • PaginationToken — (String)

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

    • ModelVersion — (String)

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

    • SNOMEDCTDetails — (map)

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

      • Edition — (String)

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

      • Language — (String)

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

      • VersionDate — (String)

        The version date of the SNOMED-CT ontology used.

    • Characters — (map)

      The number of characters in the input request documentation.

      • OriginalTextCharacters — (Integer)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehendmedical.listEntitiesDetectionV2Jobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    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.

    • JobName — (String)

      Filters on the name of the job.

    • JobStatus — (String)

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "PARTIAL_SUCCESS"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmitTimeBefore — (Date)

      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.

    • SubmitTimeAfter — (Date)

      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.

  • NextToken — (String)

    Identifies the next page of results to return.

  • MaxResults — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobPropertiesList — (Array<map>)

      A list containing the properties of each job returned.

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

    • NextToken — (String)

      Identifies the next page of results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehendmedical.listICD10CMInferenceJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    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.

    • JobName — (String)

      Filters on the name of the job.

    • JobStatus — (String)

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "PARTIAL_SUCCESS"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmitTimeBefore — (Date)

      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.

    • SubmitTimeAfter — (Date)

      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.

  • NextToken — (String)

    Identifies the next page of results to return.

  • MaxResults — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobPropertiesList — (Array<map>)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

    • NextToken — (String)

      Identifies the next page of results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehendmedical.listPHIDetectionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    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.

    • JobName — (String)

      Filters on the name of the job.

    • JobStatus — (String)

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "PARTIAL_SUCCESS"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmitTimeBefore — (Date)

      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.

    • SubmitTimeAfter — (Date)

      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.

  • NextToken — (String)

    Identifies the next page of results to return.

  • MaxResults — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobPropertiesList — (Array<map>)

      A list containing the properties of each job returned.

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

    • NextToken — (String)

      Identifies the next page of results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehendmedical.listRxNormInferenceJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    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.

    • JobName — (String)

      Filters on the name of the job.

    • JobStatus — (String)

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "PARTIAL_SUCCESS"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmitTimeBefore — (Date)

      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.

    • SubmitTimeAfter — (Date)

      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.

  • NextToken — (String)

    Identifies the next page of results to return.

  • MaxResults — (Integer)

    Identifies the next page of results to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobPropertiesList — (Array<map>)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

    • NextToken — (String)

      Identifies the next page of results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED,
    SubmitTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmitTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
comprehendmedical.listSNOMEDCTInferenceJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Provides information for filtering a list of detection jobs.

    • JobName — (String)

      Filters on the name of the job.

    • JobStatus — (String)

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "PARTIAL_SUCCESS"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmitTimeBefore — (Date)

      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.

    • SubmitTimeAfter — (Date)

      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.

  • NextToken — (String)

    Identifies the next page of InferSNOMEDCT results to return.

  • MaxResults — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ComprehendMedicalAsyncJobPropertiesList — (Array<map>)

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

      • JobId — (String)

        The identifier assigned to the detection job.

      • JobName — (String)

        The name that you assigned to the detection job.

      • JobStatus — (String)

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • Message — (String)

        A description of the status of a job.

      • SubmitTime — (Date)

        The time that the detection job was submitted for processing.

      • EndTime — (Date)

        The time that the detection job completed.

      • ExpirationTime — (Date)

        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 — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • OutputDataConfig — (map)

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

        • S3Bucket — required — (String)

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

        • S3Key — (String)

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

      • LanguageCode — (String)

        The language code of the input documents.

        Possible values include:
        • "en"
      • DataAccessRoleArn — (String)

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

      • ManifestFilePath — (String)

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

      • KMSKey — (String)

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

      • ModelVersion — (String)

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

    • NextToken — (String)

      Identifies the next page of results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  LanguageCode: en, /* required */
  OutputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  KMSKey: 'STRING_VALUE'
};
comprehendmedical.startEntitiesDetectionV2Job(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InputDataConfig — (map)

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

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • OutputDataConfig — (map)

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

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • DataAccessRoleArn — (String)

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

  • JobName — (String)

    The identifier of the job.

  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • KMSKey — (String)

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

  • LanguageCode — (String)

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

    Possible values include:
    • "en"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  LanguageCode: en, /* required */
  OutputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  KMSKey: 'STRING_VALUE'
};
comprehendmedical.startICD10CMInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InputDataConfig — (map)

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

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • OutputDataConfig — (map)

    Specifies where to send the output files.

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • DataAccessRoleArn — (String)

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

  • JobName — (String)

    The identifier of the job.

  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • KMSKey — (String)

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

  • LanguageCode — (String)

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

    Possible values include:
    • "en"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  LanguageCode: en, /* required */
  OutputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  KMSKey: 'STRING_VALUE'
};
comprehendmedical.startPHIDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InputDataConfig — (map)

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

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • OutputDataConfig — (map)

    Specifies where to send the output files.

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • DataAccessRoleArn — (String)

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

  • JobName — (String)

    The identifier of the job.

  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • KMSKey — (String)

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

  • LanguageCode — (String)

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

    Possible values include:
    • "en"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  LanguageCode: en, /* required */
  OutputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  KMSKey: 'STRING_VALUE'
};
comprehendmedical.startRxNormInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InputDataConfig — (map)

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

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • OutputDataConfig — (map)

    Specifies where to send the output files.

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • DataAccessRoleArn — (String)

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

  • JobName — (String)

    The identifier of the job.

  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • KMSKey — (String)

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

  • LanguageCode — (String)

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

    Possible values include:
    • "en"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

      The identifier of the job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  LanguageCode: en, /* required */
  OutputDataConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Key: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  JobName: 'STRING_VALUE',
  KMSKey: 'STRING_VALUE'
};
comprehendmedical.startSNOMEDCTInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InputDataConfig — (map)

    The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • OutputDataConfig — (map)

    The output properties for a detection job.

    • S3Bucket — required — (String)

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

    • S3Key — (String)

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

  • DataAccessRoleArn — (String)

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

  • JobName — (String)

    The user generated name the asynchronous InferSNOMEDCT job.

  • ClientRequestToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • KMSKey — (String)

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

  • LanguageCode — (String)

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

    Possible values include:
    • "en"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.stopEntitiesDetectionV2Job(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The identifier of the medical entities job to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.stopICD10CMInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The identifier of the job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.stopPHIDetectionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The identifier of the PHI detection job to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

      The identifier of the PHI detection job that was stopped.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.stopRxNormInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The identifier of the job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.stopSNOMEDCTInferenceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.