Class: AWS.HealthLake

var params = {
  DatastoreId: 'STRING_VALUE' /* required */
};
healthlake.deleteFHIRDatastore(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: {}) —
  • DatastoreId — (String)

    The AWS-generated ID for the data store to be deleted.

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:

    • DatastoreId — (String)

      The AWS-generated ID for the data store to be deleted.

    • DatastoreArn — (String)

      The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.

    • DatastoreStatus — (String)

      The status of the data store that the user has requested to be deleted.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "CREATE_FAILED"
    • DatastoreEndpoint — (String)

      The AWS endpoint for the data store the user has requested to be deleted.

Returns:

• (AWS.Request) —

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

var params = {
  DatastoreId: 'STRING_VALUE' /* required */
};
healthlake.describeFHIRDatastore(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: {}) —
  • DatastoreId — (String)

    The AWS-generated data store ID.

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:

    • DatastoreProperties — (map)

      All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

      • DatastoreId — required — (String)

        The AWS-generated ID number for the data store.

      • DatastoreArn — required — (String)

        The Amazon Resource Name used in the creation of the data store.

      • DatastoreName — (String)

        The user-generated name for the data store.

      • DatastoreStatus — required — (String)

        The status of the data store.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"
        • "CREATE_FAILED"
      • CreatedAt — (Date)

        The time that a data store was created.

      • DatastoreTypeVersion — required — (String)

        The FHIR version. Only R4 version data is supported.

        Possible values include:
        • "R4"
      • DatastoreEndpoint — required — (String)

        The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.

      • SseConfiguration — (map)

        The server-side encryption key configuration for a customer provided encryption key (CMK).

        • KmsEncryptionConfig — required — (map)

          The KMS encryption configuration used to provide details for data encryption.

          • CmkType — required — (String)

            The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

            Possible values include:
            • "CUSTOMER_MANAGED_KMS_KEY"
            • "AWS_OWNED_KMS_KEY"
          • KmsKeyId — (String)

            The KMS encryption key id/alias used to encrypt the data store contents at rest.

      • PreloadDataConfig — (map)

        The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

        • PreloadDataType — required — (String)

          The type of preloaded data. Only Synthea preloaded data is supported.

          Possible values include:
          • "SYNTHEA"
      • IdentityProviderConfiguration — (map)

        The identity provider that you selected when you created the data store.

        • AuthorizationStrategy — required — (String)

          The authorization strategy that you selected when you created the data store.

          Possible values include:
          • "SMART_ON_FHIR_V1"
          • "AWS_AUTH"
        • FineGrainedAuthorizationEnabled — (Boolean)

          If you enabled fine-grained authorization when you created the data store.

        • Metadata — (String)

          The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

          authorization_endpoint: The URL to the OAuth2 authorization endpoint.

          grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

          token_endpoint: The URL to the OAuth2 token endpoint.

          capabilities: An array of strings of the SMART capabilities that the authorization server supports.

          code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

        • IdpLambdaArn — (String)

          The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.

      • ErrorCause — (map)

        The error cause for the current data store operation.

        • ErrorMessage — (String)

          The text of the error message.

        • ErrorCategory — (String)

          The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.

          Possible values include:
          • "RETRYABLE_ERROR"
          • "NON_RETRYABLE_ERROR"

Returns:

• (AWS.Request) —

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

var params = {
  DatastoreId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
healthlake.describeFHIRExportJob(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: {}) —
  • DatastoreId — (String)

    The AWS generated ID for the data store from which files are being exported from for an export job.

  • JobId — (String)

    The AWS generated ID for an export 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:

    • ExportJobProperties — (map)

      Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.

      • JobId — required — (String)

        The AWS generated ID for an export job.

      • JobName — (String)

        The user generated name for an export job.

      • JobStatus — required — (String)

        The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED_WITH_ERRORS"
        • "COMPLETED"
        • "FAILED"
        • "CANCEL_SUBMITTED"
        • "CANCEL_IN_PROGRESS"
        • "CANCEL_COMPLETED"
        • "CANCEL_FAILED"
      • SubmitTime — required — (Date)

        The time an export job was initiated.

      • EndTime — (Date)

        The time an export job completed.

      • DatastoreId — required — (String)

        The AWS generated ID for the data store from which files are being exported for an export job.

      • OutputDataConfig — required — (map)

        The output data configuration that was supplied when the export job was created.

        • S3Configuration — (map)

          The output data configuration that was supplied when the export job was created.

          • S3Uri — required — (String)

            The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

          • KmsKeyId — required — (String)

            The KMS key ID used to access the S3 bucket.

      • DataAccessRoleArn — (String)

        The Amazon Resource Name used during the initiation of the job.

      • Message — (String)

        An explanation of any errors that may have occurred during the export job.

Returns:

• (AWS.Request) —

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

var params = {
  DatastoreId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
healthlake.describeFHIRImportJob(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: {}) —
  • DatastoreId — (String)

    The AWS-generated ID of the data store.

  • JobId — (String)

    The AWS-generated job ID.

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:

    • ImportJobProperties — (map)

      The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.

      • JobId — required — (String)

        The AWS-generated id number for the Import job.

      • JobName — (String)

        The user-generated name for an Import job.

      • JobStatus — required — (String)

        The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED_WITH_ERRORS"
        • "COMPLETED"
        • "FAILED"
        • "CANCEL_SUBMITTED"
        • "CANCEL_IN_PROGRESS"
        • "CANCEL_COMPLETED"
        • "CANCEL_FAILED"
      • SubmitTime — required — (Date)

        The time that the Import job was submitted for processing.

      • EndTime — (Date)

        The time that the Import job was completed.

      • DatastoreId — required — (String)

        The datastore id used when the Import job was created.

      • InputDataConfig — required — (map)

        The input data configuration that was supplied when the Import job was created.

        • S3Uri — (String)

          The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

      • JobOutputDataConfig — (map)

        The output data configuration that was supplied when the export job was created.

        • S3Configuration — (map)

          The output data configuration that was supplied when the export job was created.

          • S3Uri — required — (String)

            The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

          • KmsKeyId — required — (String)

            The KMS key ID used to access the S3 bucket.

      • JobProgressReport — (map)

        Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.

        • TotalNumberOfScannedFiles — (Integer)

          The number of files scanned from input S3 bucket.

        • TotalSizeOfScannedFilesInMB — (Float)

          The size (in MB) of the files scanned from the input S3 bucket.

        • TotalNumberOfImportedFiles — (Integer)

          The number of files imported so far.

        • TotalNumberOfResourcesScanned — (Integer)

          The number of resources scanned from the input S3 bucket.

        • TotalNumberOfResourcesImported — (Integer)

          The number of resources imported so far.

        • TotalNumberOfResourcesWithCustomerError — (Integer)

          The number of resources that failed due to customer error.

        • TotalNumberOfFilesReadWithCustomerError — (Integer)

          The number of files that failed to be read from the input S3 bucket due to customer error.

        • Throughput — (Float)

          The throughput (in MB/sec) of the import job.

      • DataAccessRoleArn — (String)

        The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.

      • Message — (String)

        An explanation of any errors that may have occurred during the FHIR import job.

Returns:

• (AWS.Request) —

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

var params = {
  Filter: {
    CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    DatastoreName: 'STRING_VALUE',
    DatastoreStatus: CREATING | ACTIVE | DELETING | DELETED | CREATE_FAILED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
healthlake.listFHIRDatastores(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)

    Lists all filters associated with a FHIR data store request.

    • DatastoreName — (String)

      Allows the user to filter data store results by name.

    • DatastoreStatus — (String)

      Allows the user to filter data store results by status.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "CREATE_FAILED"
    • CreatedBefore — (Date)

      A filter that allows the user to set cutoff dates for records. All data stores created before the specified date will be included in the results.

    • CreatedAfter — (Date)

      A filter that allows the user to set cutoff dates for records. All data stores created after the specified date will be included in the results.

  • NextToken — (String)

    Fetches the next page of data stores when results are paginated.

  • MaxResults — (Integer)

    The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.

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:

    • DatastorePropertiesList — (Array<map>)

      All properties associated with the listed data stores.

      • DatastoreId — required — (String)

        The AWS-generated ID number for the data store.