HealthLake / Client / create_fhir_datastore



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

See also: AWS API Documentation

Request Syntax

response = client.create_fhir_datastore(
        'KmsEncryptionConfig': {
            'KmsKeyId': 'string'
        'PreloadDataType': 'SYNTHEA'
            'Key': 'string',
            'Value': 'string'
  • 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.

  • SseConfiguration (dict) –

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

    • KmsEncryptionConfig (dict) – [REQUIRED]

      The KMS encryption configuration used to provide details for data encryption.

      • CmkType (string) – [REQUIRED]

        The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

      • KmsKeyId (string) –

        The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

  • PreloadDataConfig (dict) –

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

    • PreloadDataType (string) – [REQUIRED]

      The type of preloaded data. Only Synthea preloaded data is supported.

  • ClientToken (string) –

    Optional user provided token used for ensuring idempotency.

    This field is autopopulated if not provided.

  • Tags (list) –

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

    • (dict) –

      A tag is a label consisting of a user-defined key and value. The form for tags is {“Key”, “Value”}

      • Key (string) – [REQUIRED]

        The key portion of a tag. Tag keys are case sensitive.

      • Value (string) – [REQUIRED]

        The value portion of tag. Tag values are case sensitive.

Return type:



Response Syntax

    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
    'DatastoreEndpoint': 'string'

Response Structure

  • (dict) –

    • 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’.

    • DatastoreEndpoint (string) –

      The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.


  • HealthLake.Client.exceptions.ValidationException

  • HealthLake.Client.exceptions.ThrottlingException

  • HealthLake.Client.exceptions.AccessDeniedException

  • HealthLake.Client.exceptions.InternalServerException