fhir_datastores

Creates, updates, deletes, gets or lists a fhir_datastores resource.

Overview

Name	fhir_datastores
Type	Resource
Id	aws.healthlake.fhir_datastores

Fields

The following fields are returned by SELECT queries:

describe_fhir_datastore

Name	Datatype	Description
analytics_configuration	object	The analytics configuration for the data store.
created_at	string (date-time)	The time the data store was created.
datastore_arn	string	The Amazon Resource Name (ARN) used in the creation of the data store. (pattern: <code>arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?</code>)
datastore_endpoint	string	A general-purpose string value. (pattern: <code>[\P{M}\p{M}]{0,10000}</code>)
datastore_id	string	The data store identifier. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
datastore_name	string	The data store name. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
datastore_status	string	The data store status. (CREATING, ACTIVE, DELETING, DELETED, CREATE_FAILED, UPDATING, UPDATE_FAILED)
datastore_type_version	string	The FHIR release version supported by the data store. Current support is for version R4. (R4)
error_cause	object	The error cause for the current data store operation.
identity_provider_configuration	object	The identity provider selected during data store creation.
nlp_configuration	object	The natural language processing (NLP) configuration for the data store.
preload_data_config	object	The preloaded Synthea data configuration for the data store.
profile_configuration	object	The profile configuration for the data store.
sse_configuration	object	The server-side encryption key configuration for a customer provided encryption key.

list_fhir_datastores

Name	Datatype	Description
datastore_properties_list	array	The properties associated with all listed data stores.
next_token	string	The pagination token used to retrieve the next page of results. (pattern: <code>\p{ASCII}{0,8192}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fhir_datastore	select	region		Get properties for a FHIR-enabled data store.
list_fhir_datastores	select	region		List all FHIR-enabled data stores in a user’s account, regardless of data store status.
create_fhir_datastore	insert	region, DatastoreTypeVersion		Create a FHIR-enabled data store.
update_fhir_datastore	update	region, DatastoreId		Update the properties of a FHIR-enabled data store.
delete_fhir_datastore	delete	region		Delete a FHIR-enabled data store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_fhir_datastore

Get properties for a FHIR-enabled data store.

SELECT
analytics_configuration,
created_at,
datastore_arn,
datastore_endpoint,
datastore_id,
datastore_name,
datastore_status,
datastore_type_version,
error_cause,
identity_provider_configuration,
nlp_configuration,
preload_data_config,
profile_configuration,
sse_configuration
FROM aws.healthlake.fhir_datastores
WHERE region = '{{ region }}' -- required
;

list_fhir_datastores

List all FHIR-enabled data stores in a user’s account, regardless of data store status.

SELECT
datastore_properties_list,
next_token
FROM aws.healthlake.fhir_datastores
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_fhir_datastore

Create a FHIR-enabled data store.

INSERT INTO aws.healthlake.fhir_datastores (
DatastoreName,
DatastoreTypeVersion,
SseConfiguration,
PreloadDataConfig,
ClientToken,
Tags,
IdentityProviderConfiguration,
AnalyticsConfiguration,
NlpConfiguration,
ProfileConfiguration,
region
)
SELECT 
'{{ DatastoreName }}',
'{{ DatastoreTypeVersion }}' /* required */,
'{{ SseConfiguration }}',
'{{ PreloadDataConfig }}',
'{{ ClientToken }}',
'{{ Tags }}',
'{{ IdentityProviderConfiguration }}',
'{{ AnalyticsConfiguration }}',
'{{ NlpConfiguration }}',
'{{ ProfileConfiguration }}',
'{{ region }}'
RETURNING
datastore_arn,
datastore_endpoint,
datastore_id,
datastore_status
;

Manifest

# Description fields are for documentation purposes
- name: fhir_datastores
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the fhir_datastores resource.
  - name: DatastoreName
    value: "{{ DatastoreName }}"
    description: |
      The data store name (user-generated).
  - name: DatastoreTypeVersion
    value: "{{ DatastoreTypeVersion }}"
    description: |
      The FHIR release version supported by the data store. Current support is for version R4.
    valid_values: ['R4']
  - name: SseConfiguration
    description: |
      The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    value:
      KmsEncryptionConfig:
        CmkType: "{{ CmkType }}"
        KmsKeyId: "{{ KmsKeyId }}"
  - name: PreloadDataConfig
    description: |
      An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.
    value:
      PreloadDataType: "{{ PreloadDataType }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      An optional user-provided token to ensure API idempotency.
  - name: Tags
    description: |
      The resource tags applied to a data store when it is created.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: IdentityProviderConfiguration
    description: |
      The identity provider configuration to use for the data store.
    value:
      AuthorizationStrategy: "{{ AuthorizationStrategy }}"
      FineGrainedAuthorizationEnabled: {{ FineGrainedAuthorizationEnabled }}
      Metadata: "{{ Metadata }}"
      IdpLambdaArn: "{{ IdpLambdaArn }}"
  - name: AnalyticsConfiguration
    description: |
      The analytics configuration for the data store.
    value:
      Status: "{{ Status }}"
  - name: NlpConfiguration
    description: |
      The natural language processing (NLP) configuration for the data store.
    value:
      Status: "{{ Status }}"
  - name: ProfileConfiguration
    description: |
      The profile configuration for the data store.
    value:
      DefaultProfiles:
        - "{{ DefaultProfiles }}"

UPDATE examples

update_fhir_datastore

Update the properties of a FHIR-enabled data store.

UPDATE aws.healthlake.fhir_datastores
SET 
DatastoreId = '{{ DatastoreId }}',
DatastoreName = '{{ DatastoreName }}',
AnalyticsConfiguration = '{{ AnalyticsConfiguration }}',
NlpConfiguration = '{{ NlpConfiguration }}',
ProfileConfiguration = '{{ ProfileConfiguration }}',
IdentityProviderConfiguration = '{{ IdentityProviderConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND DatastoreId = '{{ DatastoreId }}' --required
RETURNING
datastore_properties;

DELETE examples

delete_fhir_datastore

Delete a FHIR-enabled data store.

DELETE FROM aws.healthlake.fhir_datastores
WHERE region = '{{ region }}' --required
;