CreateFHIRDatastore - Amazon HealthLake

CreateFHIRDatastore

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

Request Syntax

{ "ClientToken": "string", "DatastoreName": "string", "DatastoreTypeVersion": "string", "PreloadDataConfig": { "PreloadDataType": "string" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "string", "KmsKeyId": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

Optional user provided token used for ensuring idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

DatastoreName

The user generated name for the Data Store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

DatastoreTypeVersion

The FHIR version of the Data Store. The only supported version is R4.

Type: String

Valid Values: R4

Required: Yes

PreloadDataConfig

Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea.

Type: PreloadDataConfig object

Required: No

SseConfiguration

The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.

Type: SseConfiguration object

Required: No

Tags

Resource tags that are applied to a Data Store when it is created.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

{ "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DatastoreArn

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.

Type: String

Pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?

DatastoreEndpoint

The AWS endpoint for the created Data Store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Pattern: [\P{M}\p{M}]{1,5000}

DatastoreId

The AWS-generated Data Store id. This id is in the output from the initial Data Store creation call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

DatastoreStatus

The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied. Your account is not authorized to perform this operation.

HTTP Status Code: 400

InternalServerException

Unknown error occurs in the service.

HTTP Status Code: 500

ThrottlingException

The user has exceeded their maximum number of allowed calls to the given API.

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: