Skip to content

Create a FHIR-enabled data store

Description

Create a FHIR-enabled data store.

Usage

healthlake_create_fhir_datastore(DatastoreName, DatastoreTypeVersion,
  SseConfiguration, PreloadDataConfig, ClientToken, Tags,
  IdentityProviderConfiguration, AnalyticsConfiguration, NlpConfiguration,
  ProfileConfiguration, BackupConfiguration)

Arguments

  • DatastoreName

The data store name (user-generated).

  • DatastoreTypeVersion

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

  • SseConfiguration

The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.

  • PreloadDataConfig

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

  • ClientToken

An optional user-provided token to ensure API idempotency.

  • Tags

The resource tags applied to a data store when it is created.

  • IdentityProviderConfiguration

The identity provider configuration to use for the data store.

  • AnalyticsConfiguration

The analytics configuration for the data store.

  • NlpConfiguration

The natural language processing (NLP) configuration for the data store.

  • ProfileConfiguration

The profile configuration for the data store.

  • BackupConfiguration

The backup configuration for the data store.

Value

A list with the following syntax:

list(
  DatastoreId = "string",
  DatastoreArn = "string",
  DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"CREATE_FAILED"|"UPDATING"|"UPDATE_FAILED",
  DatastoreEndpoint = "string"
)

Request syntax

svc$create_fhir_datastore(
  DatastoreName = "string",
  DatastoreTypeVersion = "R4",
  SseConfiguration = list(
    KmsEncryptionConfig = list(
      CmkType = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
      KmsKeyId = "string"
    )
  ),
  PreloadDataConfig = list(
    PreloadDataType = "SYNTHEA"
  ),
  ClientToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  IdentityProviderConfiguration = list(
    AuthorizationStrategy = "SMART_ON_FHIR_V1"|"SMART_ON_FHIR"|"AWS_AUTH",
    FineGrainedAuthorizationEnabled = TRUE|FALSE,
    Metadata = "string",
    IdpLambdaArn = "string"
  ),
  AnalyticsConfiguration = list(
    Status = "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"|"PAUSING"|"PAUSED"
  ),
  NlpConfiguration = list(
    Status = "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"
  ),
  ProfileConfiguration = list(
    DefaultProfiles = list(
      "string"
    )
  ),
  BackupConfiguration = list(
    Status = "ENABLED"|"DISABLED",
    BackupType = "CONTINUOUS",
    RetentionPeriodInDays = 123,
    BackupTagsEnabled = TRUE|FALSE
  )
)