You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.HealthLake

Inherits:

AWS.Service

Object
AWS.Service
AWS.HealthLake

show all

Identifier:: healthlake

API Version:: 2017-07-01

Defined in:: (unknown)

Overview

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

Service Description

Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

Sending a Request Using HealthLake

var healthlake = new AWS.HealthLake();
healthlake.createFHIRDatastore(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 HealthLake object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var healthlake = new AWS.HealthLake({apiVersion: '2017-07-01'});

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

AWS.config.apiVersions = {
  healthlake: '2017-07-01',
  // other service API versions
};

var healthlake = new AWS.HealthLake();

Version:

2017-07-01

Constructor Summary collapse

new AWS.HealthLake(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

createFHIRDatastore(params = {}, callback) ⇒ AWS.Request
Creates a Data Store that can ingest and export FHIR formatted data.

.
deleteFHIRDatastore(params = {}, callback) ⇒ AWS.Request
Deletes a Data Store.
describeFHIRDatastore(params = {}, callback) ⇒ AWS.Request
Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

.
describeFHIRExportJob(params = {}, callback) ⇒ AWS.Request
Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

.
describeFHIRImportJob(params = {}, callback) ⇒ AWS.Request
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
listFHIRDatastores(params = {}, callback) ⇒ AWS.Request
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

.
listFHIRExportJobs(params = {}, callback) ⇒ AWS.Request
Lists all FHIR export jobs associated with an account and their statuses.
listFHIRImportJobs(params = {}, callback) ⇒ AWS.Request
Lists all FHIR import jobs associated with an account and their statuses.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns a list of all existing tags associated with a Data Store.
startFHIRExportJob(params = {}, callback) ⇒ AWS.Request
Begins a FHIR export job.

.
startFHIRImportJob(params = {}, callback) ⇒ AWS.Request
Begins a FHIR Import job.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds a user specifed key and value tag to a Data Store.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a Data Store.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.HealthLake(options = {}) ⇒ `Object`

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

Examples:

Constructing a HealthLake object

var healthlake = new AWS.HealthLake({apiVersion: '2017-07-01'});

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|AWS.Endpoint) —
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' or an Endpoint object.
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.HealthLake.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.HealthLake.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.HealthLake.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.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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. The function is only called for retryable errors.
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|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
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

endpoint ⇒ `AWS.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

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

Creates a Data Store that can ingest and export FHIR formatted data.

Service Reference:

CreateFHIRDatastore

Examples:

Calling the createFHIRDatastore operation

var params = {
  DatastoreTypeVersion: R4, /* required */
  ClientToken: 'STRING_VALUE',
  DatastoreName: 'STRING_VALUE',
  PreloadDataConfig: {
    PreloadDataType: SYNTHEA /* required */
  },
  SseConfiguration: {
    KmsEncryptionConfig: { /* required */
      CmkType: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY, /* required */
      KmsKeyId: 'STRING_VALUE'
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
healthlake.createFHIRDatastore(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: {}) —
- DatastoreName — (String)
  The user generated name for the Data Store.
- DatastoreTypeVersion — (String)
  The FHIR version of the Data Store. The only supported version is R4.
  Possible values include:
  - "R4"
- SseConfiguration — (map)
  The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.
  - 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 encyrption. 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)
  Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
  - PreloadDataType — required — (String)
    The type of preloaded data. Only Synthea preloaded data is supported.
    Possible values include:
    - "SYNTHEA"
- ClientToken — (String)
  Optional user provided token used for ensuring idempotency.
  If a token is not provided, the SDK will use a version 4 UUID.
- Tags — (Array<map>)
  Resource tags that are applied to a Data Store when it is created.
  - Key — required — (String)
    The key portion of a tag. Tag keys are case sensitive.
  - Value — required — (String)
    The value portion of tag. Tag values are case sensitive.

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 Data Store id. This id is in the output from the initial Data Store creation call.
  - DatastoreArn — (String)
    The datastore ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call.
  - DatastoreStatus — (String)
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    Possible values include:
    
    "CREATING"
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETED"
  - DatastoreEndpoint — (String)
    The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Deletes a Data Store.

Service Reference:

DeleteFHIRDatastore

Examples:

Calling the deleteFHIRDatastore operation

var params = {
  DatastoreId: 'STRING_VALUE'
};
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 Amazon 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"
  - 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.

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

Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

Service Reference:

DescribeFHIRDatastore

Examples:

Calling the describeFHIRDatastore operation

var params = {
  DatastoreId: 'STRING_VALUE'
};
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. This is part of the ‘CreateFHIRDatastore’ output.

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, created at, Data Store type version, and Data Store 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 statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
    Possible values include:
    
    "CREATING"
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETED"
    
    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 encyrption. 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"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

Service Reference:

DescribeFHIRExportJob

Examples:

Calling the describeFHIRExportJob operation

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

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

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

Service Reference:

DescribeFHIRImportJob

Examples:

Calling the describeFHIRImportJob operation

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, and the status 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, FAILED.
    Possible values include:
    
    "SUBMITTED"
    
    "IN_PROGRESS"
    
    "COMPLETED_WITH_ERRORS"
    
    "COMPLETED"
    
    "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 Amazon 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 Amazon HealthLake.
    
    KmsKeyId — required — (String)
    The KMS key ID used to access the S3 bucket.
    
    DataAccessRoleArn — (String)
    The Amazon Resource Name (ARN) that gives Amazon 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.

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

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

Service Reference:

ListFHIRDatastores

Examples:

Calling the listFHIRDatastores operation

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
  },
  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"
  - 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.
    
    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 statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
    Possible values include:
    
    "CREATING"
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETED"
    
    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 encyrption. 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"
  - NextToken — (String)
    Pagination token that can be used to retrieve the next page of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Lists all FHIR export jobs associated with an account and their statuses.

Service Reference:

ListFHIRExportJobs

Examples:

Calling the listFHIRExportJobs operation

var params = {
  DatastoreId: 'STRING_VALUE', /* required */
  JobName: 'STRING_VALUE',
  JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubmittedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SubmittedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
healthlake.listFHIRExportJobs(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)
  This parameter limits the response to the export job with the specified Data Store ID.
- NextToken — (String)
  A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
- MaxResults — (Integer)
  This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
- JobName — (String)
  This parameter limits the response to the export job with the specified job name.
- JobStatus — (String)
  This parameter limits the response to the export jobs with the specified job status.
  Possible values include:
  - "SUBMITTED"
  - "IN_PROGRESS"
  - "COMPLETED_WITH_ERRORS"
  - "COMPLETED"
  - "FAILED"
- SubmittedBefore — (Date)
  This parameter limits the response to FHIR export jobs submitted before a user specified date.
- SubmittedAfter — (Date)
  This parameter limits the response to FHIR export jobs submitted after a user specified date.

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:
  - ExportJobPropertiesList — (Array<map>)
    The properties of listed FHIR export jobs, 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"
    
    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 Amazon 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.
  - NextToken — (String)
    A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Lists all FHIR import jobs associated with an account and their statuses.

Service Reference:

ListFHIRImportJobs

Examples:

Calling the listFHIRImportJobs operation

var params = {
  DatastoreId: 'STRING_VALUE', /* required */
  JobName: 'STRING_VALUE',
  JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubmittedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SubmittedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
healthlake.listFHIRImportJobs(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)
  This parameter limits the response to the import job with the specified Data Store ID.
- NextToken — (String)
  A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
- MaxResults — (Integer)
  This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
- JobName — (String)
  This parameter limits the response to the import job with the specified job name.
- JobStatus — (String)
  This parameter limits the response to the import job with the specified job status.
  Possible values include:
  - "SUBMITTED"
  - "IN_PROGRESS"
  - "COMPLETED_WITH_ERRORS"
  - "COMPLETED"
  - "FAILED"
- SubmittedBefore — (Date)
  This parameter limits the response to FHIR import jobs submitted before a user specified date.
- SubmittedAfter — (Date)
  This parameter limits the response to FHIR import jobs submitted after a user specified date.

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:
  - ImportJobPropertiesList — (Array<map>)
    The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status 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, FAILED.
    Possible values include:
    
    "SUBMITTED"
    
    "IN_PROGRESS"
    
    "COMPLETED_WITH_ERRORS"
    
    "COMPLETED"
    
    "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 Amazon 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 Amazon HealthLake.
    
    KmsKeyId — required — (String)
    The KMS key ID used to access the S3 bucket.
    
    DataAccessRoleArn — (String)
    The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
    
    Message — (String)
    An explanation of any errors that may have occurred during the FHIR import job.
  - NextToken — (String)
    A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all existing tags associated with a Data Store.

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
healthlake.listTagsForResource(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: {}) —
- ResourceARN — (String)
  The Amazon Resource Name(ARN) of the Data Store for which tags are being added.

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:
  - Tags — (Array<map>)
    Returns a list of tags associated with a Data Store.
    
    Key — required — (String)
    The key portion of a tag. Tag keys are case sensitive.
    
    Value — required — (String)
    The value portion of tag. Tag values are case sensitive.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Begins a FHIR export job.

Service Reference:

StartFHIRExportJob

Examples:

Calling the startFHIRExportJob operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DatastoreId: 'STRING_VALUE', /* required */
  OutputDataConfig: { /* required */
    S3Configuration: {
      KmsKeyId: 'STRING_VALUE', /* required */
      S3Uri: 'STRING_VALUE' /* required */
    }
  },
  JobName: 'STRING_VALUE'
};
healthlake.startFHIRExportJob(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: {}) —
- JobName — (String)
  The user generated name for an export job.
- OutputDataConfig — (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 Amazon HealthLake.
    - KmsKeyId — required — (String)
      The KMS key ID used to access the S3 bucket.
- DatastoreId — (String)
  The AWS generated ID for the Data Store from which files are being exported for an export job.
- DataAccessRoleArn — (String)
  The Amazon Resource Name used during the initiation of the job.
- ClientToken — (String)
  An optional user provided token used for ensuring idempotency.
  If a token is not provided, the SDK will use a version 4 UUID.

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 AWS generated ID for an export job.
  - JobStatus — (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"
  - DatastoreId — (String)
    The AWS generated ID for the Data Store from which files are being exported for an export job.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Begins a FHIR Import job.

Service Reference:

StartFHIRImportJob

Examples:

Calling the startFHIRImportJob operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  DatastoreId: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE'
  },
  JobOutputDataConfig: { /* required */
    S3Configuration: {
      KmsKeyId: 'STRING_VALUE', /* required */
      S3Uri: 'STRING_VALUE' /* required */
    }
  },
  JobName: 'STRING_VALUE'
};
healthlake.startFHIRImportJob(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: {}) —
- JobName — (String)
  The name of the FHIR Import job in the StartFHIRImport job request.
- InputDataConfig — (map)
  The input properties of the FHIR Import job in the StartFHIRImport job request.
  - S3Uri — (String)
    The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon 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 Amazon HealthLake.
    - KmsKeyId — required — (String)
      The KMS key ID used to access the S3 bucket.
- DatastoreId — (String)
  The AWS-generated Data Store ID.
- DataAccessRoleArn — (String)
  The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
- ClientToken — (String)
  Optional user provided token used for ensuring idempotency.
  If a token is not provided, the SDK will use a version 4 UUID.

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 AWS-generated job ID.
  - JobStatus — (String)
    The status of an import job.
    Possible values include:
    
    "SUBMITTED"
    
    "IN_PROGRESS"
    
    "COMPLETED_WITH_ERRORS"
    
    "COMPLETED"
    
    "FAILED"
  - DatastoreId — (String)
    The AWS-generated Data Store ID.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Adds a user specifed key and value tag to a Data Store.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
healthlake.tagResource(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: {}) —
- ResourceARN — (String)
  The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to.
- Tags — (Array<map>)
  The user specified key and value pair tags being added to a Data Store.
  - Key — required — (String)
    The key portion of a tag. Tag keys are case sensitive.
  - Value — required — (String)
    The value portion of tag. Tag values are case sensitive.

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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Removes tags from a Data Store.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
healthlake.untagResource(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: {}) —
- ResourceARN — (String)
  "The Amazon Resource Name(ARN) of the Data Store for which tags are being removed
- TagKeys — (Array<String>)
  The keys for the tags to be removed from the Healthlake Data Store.

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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.HealthLake

Overview

Service Description

Sending a Request Using HealthLake

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

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

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

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

new AWS.HealthLake(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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

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

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