Class: AWS.ComprehendMedical

Inherits:
AWS.Service show all
Identifier:
comprehendmedical
API Version:
2018-10-30
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

Sending a Request Using ComprehendMedical

var comprehendmedical = new AWS.ComprehendMedical();
comprehendmedical.describeEntitiesDetectionV2Job(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ComprehendMedical object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var comprehendmedical = new AWS.ComprehendMedical({apiVersion: '2018-10-30'});

You can also set the API version globally in AWS.config.apiVersions using the comprehendmedical service identifier:

AWS.config.apiVersions = {
  comprehendmedical: '2018-10-30',
  // other service API versions
};

var comprehendmedical = new AWS.ComprehendMedical();

Version:

  • 2018-10-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ComprehendMedical(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ComprehendMedical object

var comprehendmedical = new AWS.ComprehendMedical({apiVersion: '2018-10-30'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ComprehendMedical.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ComprehendMedical.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ComprehendMedical.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

describeEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeEntitiesDetectionV2Job operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
comprehendmedical.describeEntitiesDetectionV2Job(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 StartEntitiesDetectionV2Job 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.

          • S3Bucketrequired — (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.

            Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

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

          • S3Bucketrequired — (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.

describePHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describePHIDetectionJob operation

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.

          • S3Bucketrequired — (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.

            Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

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

          • S3Bucketrequired — (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.

detectEntities(params = {}, callback) ⇒ AWS.Request

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

Service Reference:

Examples:

Calling the detectEntities operation

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. Each string must contain fewer than 20,000 bytes of characters.

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"
        • Type — (String)

          Describes the specific type of entity with category of entities.

          Possible values include:
          • "NAME"
          • "DOSAGE"
          • "ROUTE_OR_MODE"
          • "FORM"
          • "FREQUENCY"
          • "DURATION"
          • "GENERIC_NAME"
          • "BRAND_NAME"
          • "STRENGTH"
          • "RATE"
          • "ACUITY"
          • "TEST_NAME"
          • "TEST_VALUE"
          • "TEST_UNITS"
          • "PROCEDURE_NAME"
          • "TREATMENT_NAME"
          • "DATE"
          • "AGE"
          • "CONTACT_POINT"
          • "EMAIL"
          • "IDENTIFIER"
          • "URL"
          • "ADDRESS"
          • "PROFESSION"
          • "SYSTEM_ORGAN_SITE"
          • "DIRECTION"
          • "QUALITY"
          • "QUANTITY"
        • 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"
          • 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"
            • "DOSAGE"
            • "ROUTE_OR_MODE"
            • "FORM"
            • "FREQUENCY"
            • "DURATION"
            • "GENERIC_NAME"
            • "BRAND_NAME"
            • "STRENGTH"
            • "RATE"
            • "ACUITY"
            • "TEST_NAME"
            • "TEST_VALUE"
            • "TEST_UNITS"
            • "PROCEDURE_NAME"
            • "TREATMENT_NAME"
            • "DATE"
            • "AGE"
            • "CONTACT_POINT"
            • "EMAIL"
            • "IDENTIFIER"
            • "URL"
            • "ADDRESS"
            • "PROFESSION"
            • "SYSTEM_ORGAN_SITE"
            • "DIRECTION"
            • "QUALITY"
            • "QUANTITY"
          • 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 extracted as this attribute.

          • 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"
            • 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 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"
        • 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"
            • "DOSAGE"
            • "ROUTE_OR_MODE"
            • "FORM"
            • "FREQUENCY"
            • "DURATION"
            • "GENERIC_NAME"
            • "BRAND_NAME"
            • "STRENGTH"
            • "RATE"
            • "ACUITY"
            • "TEST_NAME"
            • "TEST_VALUE"
            • "TEST_UNITS"
            • "PROCEDURE_NAME"
            • "TREATMENT_NAME"
            • "DATE"
            • "AGE"
            • "CONTACT_POINT"
            • "EMAIL"
            • "IDENTIFIER"
            • "URL"
            • "ADDRESS"
            • "PROFESSION"
            • "SYSTEM_ORGAN_SITE"
            • "DIRECTION"
            • "QUALITY"
            • "QUANTITY"
          • 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 extracted as this attribute.

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

detectEntitiesV2(params = {}, callback) ⇒ AWS.Request

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. It does not return the Quality or Quantity entities.

Service Reference:

Examples:

Calling the detectEntitiesV2 operation

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. Each string must contain fewer than 20,000 bytes of characters.

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"
        • Type — (String)

          Describes the specific type of entity with category of entities.

          Possible values include:
          • "NAME"
          • "DOSAGE"
          • "ROUTE_OR_MODE"
          • "FORM"
          • "FREQUENCY"
          • "DURATION"
          • "GENERIC_NAME"
          • "BRAND_NAME"
          • "STRENGTH"
          • "RATE"
          • "ACUITY"
          • "TEST_NAME"
          • "TEST_VALUE"
          • "TEST_UNITS"
          • "PROCEDURE_NAME"
          • "TREATMENT_NAME"
          • "DATE"
          • "AGE"
          • "CONTACT_POINT"
          • "EMAIL"
          • "IDENTIFIER"
          • "URL"
          • "ADDRESS"
          • "PROFESSION"
          • "SYSTEM_ORGAN_SITE"
          • "DIRECTION"
          • "QUALITY"
          • "QUANTITY"
        • 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"
          • 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"
            • "DOSAGE"
            • "ROUTE_OR_MODE"
            • "FORM"
            • "FREQUENCY"
            • "DURATION"
            • "GENERIC_NAME"
            • "BRAND_NAME"
            • "STRENGTH"
            • "RATE"
            • "ACUITY"
            • "TEST_NAME"
            • "TEST_VALUE"
            • "TEST_UNITS"
            • "PROCEDURE_NAME"
            • "TREATMENT_NAME"
            • "DATE"
            • "AGE"
            • "CONTACT_POINT"
            • "EMAIL"
            • "IDENTIFIER"
            • "URL"
            • "ADDRESS"
            • "PROFESSION"
            • "SYSTEM_ORGAN_SITE"
            • "DIRECTION"
            • "QUALITY"
            • "QUANTITY"
          • 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 extracted as this attribute.

          • 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"
            • 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 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"
        • 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"
            • "DOSAGE"
            • "ROUTE_OR_MODE"
            • "FORM"
            • "FREQUENCY"
            • "DURATION"
            • "GENERIC_NAME"
            • "BRAND_NAME"
            • "STRENGTH"
            • "RATE"
            • "ACUITY"
            • "TEST_NAME"
            • "TEST_VALUE"
            • "TEST_UNITS"
            • "PROCEDURE_NAME"
            • "TREATMENT_NAME"
            • "DATE"
            • "AGE"
            • "CONTACT_POINT"
            • "EMAIL"
            • "IDENTIFIER"
            • "URL"
            • "ADDRESS"
            • "PROFESSION"
            • "SYSTEM_ORGAN_SITE"
            • "DIRECTION"
            • "QUALITY"
            • "QUANTITY"
          • 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 extracted as this attribute.

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

detectPHI(params = {}, callback) ⇒ AWS.Request

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

Service Reference:

Examples:

Calling the detectPHI operation

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. Each string must contain fewer than 20,000 bytes of characters.

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"
        • Type — (String)

          Describes the specific type of entity with category of entities.

          Possible values include:
          • "NAME"
          • "DOSAGE"
          • "ROUTE_OR_MODE"
          • "FORM"
          • "FREQUENCY"
          • "DURATION"
          • "GENERIC_NAME"
          • "BRAND_NAME"
          • "STRENGTH"
          • "RATE"
          • "ACUITY"
          • "TEST_NAME"
          • "TEST_VALUE"
          • "TEST_UNITS"
          • "PROCEDURE_NAME"
          • "TREATMENT_NAME"
          • "DATE"
          • "AGE"
          • "CONTACT_POINT"
          • "EMAIL"
          • "IDENTIFIER"
          • "URL"
          • "ADDRESS"
          • "PROFESSION"
          • "SYSTEM_ORGAN_SITE"
          • "DIRECTION"
          • "QUALITY"
          • "QUANTITY"
        • 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"
          • 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"
            • "DOSAGE"
            • "ROUTE_OR_MODE"
            • "FORM"
            • "FREQUENCY"
            • "DURATION"
            • "GENERIC_NAME"
            • "BRAND_NAME"
            • "STRENGTH"
            • "RATE"
            • "ACUITY"
            • "TEST_NAME"
            • "TEST_VALUE"
            • "TEST_UNITS"
            • "PROCEDURE_NAME"
            • "TREATMENT_NAME"
            • "DATE"
            • "AGE"
            • "CONTACT_POINT"
            • "EMAIL"
            • "IDENTIFIER"
            • "URL"
            • "ADDRESS"
            • "PROFESSION"
            • "SYSTEM_ORGAN_SITE"
            • "DIRECTION"
            • "QUALITY"
            • "QUANTITY"
          • 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 extracted as this attribute.

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

listEntitiesDetectionV2Jobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEntitiesDetectionV2Jobs operation

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.

          • S3Bucketrequired — (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.

            Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

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

          • S3Bucketrequired — (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.

listPHIDetectionJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPHIDetectionJobs operation

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.

          • S3Bucketrequired — (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.

            Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

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

          • S3Bucketrequired — (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.

startEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startEntitiesDetectionV2Job operation

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)

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

      • S3Bucketrequired — (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.

        Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

      • S3Key — (String)

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

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Bucketrequired — (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 DescribeEntitiesDetectionV2Job operation.

Returns:

  • (AWS.Request)

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

startPHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startPHIDetectionJob operation

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.

      • S3Bucketrequired — (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.

        Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

      • S3Key — (String)

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

    • OutputDataConfig — (map)

      Specifies where to send the output files.

      • S3Bucketrequired — (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.

stopEntitiesDetectionV2Job(params = {}, callback) ⇒ AWS.Request

Stops a medical entities detection job in progress.

Service Reference:

Examples:

Calling the stopEntitiesDetectionV2Job operation

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.

stopPHIDetectionJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the stopPHIDetectionJob operation

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.