fhir_datastores

Creates, updates, deletes or gets a fhir_datastore resource or lists fhir_datastores in a region

Overview

Name	fhir_datastores
Type	Resource
Description	HealthLake FHIR Datastore
Id	aws.healthlake.fhir_datastores

Fields

Name	Datatype	Description
created_at	object	The time that a Data Store was created.
datastore_arn	string	The Amazon Resource Name used in the creation of the Data Store.
datastore_endpoint	string	The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
datastore_id	string	The AWS-generated ID number for the Data Store.
datastore_name	string	The user-generated name for the Data Store.
datastore_status	string	The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
datastore_type_version	string	The FHIR version. Only R4 version data is supported.
preload_data_config	object	The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
sse_configuration	object	The server-side encryption key configuration for a customer provided encryption key.
identity_provider_configuration	object	The identity provider configuration for the datastore
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DatastoreTypeVersion, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all fhir_datastores in a region.

SELECT
region,
created_at,
datastore_arn,
datastore_endpoint,
datastore_id,
datastore_name,
datastore_status,
datastore_type_version,
preload_data_config,
sse_configuration,
identity_provider_configuration,
tags
FROM aws.healthlake.fhir_datastores
WHERE region = 'us-east-1';

Gets all properties from an individual fhir_datastore.

SELECT
region,
created_at,
datastore_arn,
datastore_endpoint,
datastore_id,
datastore_name,
datastore_status,
datastore_type_version,
preload_data_config,
sse_configuration,
identity_provider_configuration,
tags
FROM aws.healthlake.fhir_datastores
WHERE region = 'us-east-1' AND data__Identifier = '<DatastoreId>';

INSERT example

Use the following StackQL query and manifest file to create a new fhir_datastore resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.healthlake.fhir_datastores (
 DatastoreTypeVersion,
 region
)
SELECT 
'{{ DatastoreTypeVersion }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.healthlake.fhir_datastores (
 DatastoreName,
 DatastoreTypeVersion,
 PreloadDataConfig,
 SseConfiguration,
 IdentityProviderConfiguration,
 Tags,
 region
)
SELECT 
 '{{ DatastoreName }}',
 '{{ DatastoreTypeVersion }}',
 '{{ PreloadDataConfig }}',
 '{{ SseConfiguration }}',
 '{{ IdentityProviderConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fhir_datastore
    props:
      - name: DatastoreName
        value: '{{ DatastoreName }}'
      - name: DatastoreTypeVersion
        value: '{{ DatastoreTypeVersion }}'
      - name: PreloadDataConfig
        value:
          PreloadDataType: '{{ PreloadDataType }}'
      - name: SseConfiguration
        value:
          KmsEncryptionConfig:
            CmkType: '{{ CmkType }}'
            KmsKeyId: '{{ KmsKeyId }}'
      - name: IdentityProviderConfiguration
        value:
          AuthorizationStrategy: '{{ AuthorizationStrategy }}'
          FineGrainedAuthorizationEnabled: '{{ FineGrainedAuthorizationEnabled }}'
          Metadata: '{{ Metadata }}'
          IdpLambdaArn: '{{ IdpLambdaArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.healthlake.fhir_datastores
WHERE data__Identifier = '<DatastoreId>'
AND region = 'us-east-1';

Permissions

To operate on the fhir_datastores resource, the following permissions are required:

Create

healthlake:CreateFHIRDatastore,
healthlake:DescribeFHIRDatastore,
iam:PassRole,
kms:DescribeKey,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt,
iam:GetRole,
iam:CreateServiceLinkedRole,
ram:GetResourceShareInvitations,
ram:AcceptResourceShareInvitation,
glue:CreateDatabase,
glue:DeleteDatabase,
lambda:InvokeFunction,
healthlake:TagResource,
healthlake:UntagResource,
healthlake:ListTagsForResource

Read

healthlake:DescribeFHIRDatastore,
healthlake:ListTagsForResource

Update

healthlake:TagResource,
healthlake:UntagResource,
healthlake:ListTagsForResource,
healthlake:DescribeFHIRDatastore,
iam:PassRole,
iam:GetRole,
iam:CreateServiceLinkedRole

Delete

healthlake:DeleteFHIRDatastore,
healthlake:DescribeFHIRDatastore,
iam:PassRole,
iam:GetRole,
iam:CreateServiceLinkedRole,
ram:GetResourceShareInvitations,
ram:AcceptResourceShareInvitation,
glue:CreateDatabase,
glue:DeleteDatabase

List

healthlake:ListFHIRDatastores