AWS.HealthLake — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.HealthLake

Overview

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

Service Description

AWS 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();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

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.

Property Details

endpoint ⇒ AWS.Endpoint

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

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

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, when the data store was created, data store type version, and the data store's 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 specified key and value tag to a data store.

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

Removes tags from a data store.