Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateFHIRDatastore

Create a FHIR-enabled data store.

Request Syntax


{
   "ClientToken": "string",
   "DatastoreName": "string",
   "DatastoreTypeVersion": "string",
   "IdentityProviderConfiguration": { 
      "AuthorizationStrategy": "string",
      "FineGrainedAuthorizationEnabled": boolean,
      "IdpLambdaArn": "string",
      "Metadata": "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

An optional user-provided token to ensure API idempotency.

Type: String

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

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

Required: No

DatastoreName

The data store name (user-generated).

Type: String

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

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

Required: No

DatastoreTypeVersion

The FHIR release version supported by the data store. Current support is for version R4.

Type: String

Valid Values: R4

Required: Yes

IdentityProviderConfiguration

The identity provider configuration to use for the data store.

Type: IdentityProviderConfiguration object

Required: No

PreloadDataConfig

An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.

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

The resource tags 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 Amazon Resource Name (ARN) for the data store.

Type: String

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

DatastoreEndpoint

The AWS endpoint created for the data store.

Type: String

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

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

DatastoreId

The data store identifier.

Type: String

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

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

DatastoreStatus

The data store status.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED | CREATE_FAILED

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

An unknown internal error occurred 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