Table of Contents
A low-level client representing Amazon HealthLake
Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their data in a consistent fashion in the cloud.
import boto3
client = boto3.client('healthlake')
These are the available methods:
Check if an operation can be paginated.
Creates a datastore that can ingest and export FHIR data.
See also: AWS API Documentation
Request Syntax
response = client.create_fhir_datastore(
DatastoreName='string',
DatastoreTypeVersion='R4',
PreloadDataConfig={
'PreloadDataType': 'SYNTHEA'
},
ClientToken='string'
)
[REQUIRED]
The FHIR version of the datastore. The only supported version is R4.
Optional parameter to preload data upon creation of the datastore. Currently, the only supported preloaded data is synthetic data generated from Synthea.
The type of preloaded data. Only Synthea preloaded data is supported.
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'DatastoreEndpoint': 'string'
}
Response Structure
(dict) --
DatastoreId (string) --
The AWS-generated datastore id. This id is in the output from the initial datastore creation call.
DatastoreArn (string) --
The datastore ARN is generated during the creation of the datastore and can be found in the output from the initial datastore creation call.
DatastoreStatus (string) --
The status of the FHIR datastore. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
DatastoreEndpoint (string) --
The AWS endpoint for the created datastore. For preview, only US-east-1 endpoints are supported.
Exceptions
Deletes a datastore.
See also: AWS API Documentation
Request Syntax
response = client.delete_fhir_datastore(
DatastoreId='string'
)
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'DatastoreEndpoint': 'string'
}
Response Structure
The AWS-generated ID for the datastore to be deleted.
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
The status of the datastore that the user has requested to be deleted.
The AWS endpoint for the datastore the user has requested to be deleted.
Exceptions
Gets the properties associated with the FHIR datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_fhir_datastore(
DatastoreId='string'
)
{
'DatastoreProperties': {
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'CreatedAt': datetime(2015, 1, 1),
'DatastoreTypeVersion': 'R4',
'DatastoreEndpoint': 'string',
'PreloadDataConfig': {
'PreloadDataType': 'SYNTHEA'
}
}
}
Response Structure
All properties associated with a datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.
The AWS-generated ID number for the datastore.
The Amazon Resource Name used in the creation of the datastore.
The user-generated name for the datastore.
The status of the datastore. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
The time that a datastore was created.
The FHIR version. Only R4 version data is supported.
The AWS endpoint for the datastore. Each datastore will have it's own endpoint with datastore ID in the endpoint URL.
The preloaded data configuration for the datastore. Only data preloaded from Synthea is supported.
The type of preloaded data. Only Synthea preloaded data is supported.
Exceptions
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the datastore.
See also: AWS API Documentation
Request Syntax
response = client.describe_fhir_import_job(
DatastoreId='string',
JobId='string'
)
[REQUIRED]
The AWS-generated ID of the datastore.
[REQUIRED]
The AWS-generated job ID.
dict
Response Syntax
{
'ImportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DatastoreId': 'string',
'InputDataConfig': {
'S3Uri': 'string'
},
'DataAccessRoleArn': 'string',
'Message': 'string'
}
}
Response Structure
(dict) --
ImportJobProperties (dict) --
The properties of the Import job request, including the ID, ARN, name, and the status of the datastore.
JobId (string) --
The AWS-generated id number for the Import job.
JobName (string) --
The user-generated name for an Import job.
JobStatus (string) --
The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.
SubmitTime (datetime) --
The time that the Import job was submitted for processing.
EndTime (datetime) --
The time that the Import job was completed.
DatastoreId (string) --
The datastore id used when the Import job was created.
InputDataConfig (dict) --
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.
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.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists all FHIR datastores that are in the user’s account, regardless of datastore status.
See also: AWS API Documentation
Request Syntax
response = client.list_fhir_datastores(
Filter={
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'CreatedBefore': datetime(2015, 1, 1),
'CreatedAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Lists all filters associated with a FHIR datastore request.
Allows the user to filter datastore results by name.
Allows the user to filter datastore results by status.
A filter that allows the user to set cutoff dates for records. All datastores created before the specified date will be included in the results.
A filter that allows the user to set cutoff dates for records. All datastores created after the specified date will be included in the results.
dict
Response Syntax
{
'DatastorePropertiesList': [
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'CreatedAt': datetime(2015, 1, 1),
'DatastoreTypeVersion': 'R4',
'DatastoreEndpoint': 'string',
'PreloadDataConfig': {
'PreloadDataType': 'SYNTHEA'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DatastorePropertiesList (list) --
All properties associated with the listed datastores.
(dict) --
Displays the properties of the datastore, including the ID, Arn, name, and the status of the datastore.
DatastoreId (string) --
The AWS-generated ID number for the datastore.
DatastoreArn (string) --
The Amazon Resource Name used in the creation of the datastore.
DatastoreName (string) --
The user-generated name for the datastore.
DatastoreStatus (string) --
The status of the datastore. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
CreatedAt (datetime) --
The time that a datastore was created.
DatastoreTypeVersion (string) --
The FHIR version. Only R4 version data is supported.
DatastoreEndpoint (string) --
The AWS endpoint for the datastore. Each datastore will have it's own endpoint with datastore ID in the endpoint URL.
PreloadDataConfig (dict) --
The preloaded data configuration for the datastore. Only data preloaded from Synthea is supported.
PreloadDataType (string) --
The type of preloaded data. Only Synthea preloaded data is supported.
NextToken (string) --
Pagination token that can be used to retrieve the next page of results.
Exceptions
Begins a FHIR Import job.
See also: AWS API Documentation
Request Syntax
response = client.start_fhir_import_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string'
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string'
)
[REQUIRED]
The input properties of the FHIR Import job in the StartFHIRImport job request.
The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
[REQUIRED]
The AWS-generated datastore ID.
[REQUIRED]
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
[REQUIRED]
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'DatastoreId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The AWS-generated job ID.
JobStatus (string) --
The status of an import job.
DatastoreId (string) --
The AWS-generated datastore ID.
Exceptions
The available paginators are: