Skip to content
AWS for Query.Farm

aws.healthlake.describe_fhir_datastore

Example SQL Queries

SELECT * FROM
aws.healthlake.describe_fhir_datastore
WHERE
"datastore_id" = 'VALUE';

Description

Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

Table Definition

Column NameColumn Data Type
datastore_id Required Input Column

The AWS-generated data store ID.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
datastore_properties

All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

STRUCT(
    "datastore_id" VARCHAR,
    "datastore_arn" VARCHAR,
    "datastore_name" VARCHAR,
    "datastore_status" VARCHAR,
    "created_at" TIMESTAMP_S,
    "datastore_type_version" VARCHAR,
    "datastore_endpoint" VARCHAR,
    "sse_configuration" STRUCT(
        "kms_encryption_config" STRUCT(
            "cmk_type" VARCHAR,
            "kms_key_id" VARCHAR
        )
    ),
    "preload_data_config" STRUCT(
        "preload_data_type" VARCHAR
    ),
    "identity_provider_configuration" STRUCT(
        "authorization_strategy" VARCHAR,
        "fine_grained_authorization_enabled" BOOLEAN,
        "metadata" VARCHAR,
        "idp_lambda_arn" VARCHAR
    ),
    "error_cause" STRUCT(
        "error_message" VARCHAR,
        "error_category" VARCHAR
    )
)
Show child fields
datastore_properties.created_at

The time that a data store was created.

datastore_properties.datastore_arn

The Amazon Resource Name used in the creation of the data store.

datastore_properties.datastore_endpoint

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_properties.datastore_id

The AWS-generated ID number for the data store.

datastore_properties.datastore_name

The user-generated name for the data store.

datastore_properties.datastore_status

The status of the data store.

datastore_properties.datastore_type_version

The FHIR version. Only R4 version data is supported.

datastore_properties.error_cause

The error cause for the current data store operation.

Show child fields
datastore_properties.error_cause.error_category

The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.

datastore_properties.error_cause.error_message

The text of the error message.

datastore_properties.identity_provider_configuration

The identity provider that you selected when you created the data store.

Show child fields
datastore_properties.identity_provider_configuration.authorization_strategy

The authorization strategy that you selected when you created the data store.

datastore_properties.identity_provider_configuration.fine_grained_authorization_enabled

If you enabled fine-grained authorization when you created the data store.

datastore_properties.identity_provider_configuration.idp_lambda_arn

The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.

datastore_properties.identity_provider_configuration.metadata

The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

authorization_endpoint: The URL to the OAuth2 authorization endpoint.

grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

token_endpoint: The URL to the OAuth2 token endpoint.

capabilities: An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

datastore_properties.preload_data_config

The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

Show child fields
datastore_properties.preload_data_config.preload_data_type

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

datastore_properties.sse_configuration

The server-side encryption key configuration for a customer provided encryption key (CMK).

Show child fields
datastore_properties.sse_configuration.kms_encryption_config

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

Show child fields
datastore_properties.sse_configuration.kms_encryption_config.cmk_type

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

datastore_properties.sse_configuration.kms_encryption_config.kms_key_id

The KMS encryption key id/alias used to encrypt the data store contents at rest.