Amazon HealthLake

{'AnalyticsConfiguration': {'Status': 'ENABLED | ENABLING | DISABLED | '
                                      'DISABLING | PAUSING | PAUSED'},
 'NlpConfiguration': {'Status': 'ENABLED | DISABLED | ENABLING | DISABLING'},
 'ProfileConfiguration': {'DefaultProfiles': ['string']}}

Create a FHIR-enabled data store.

See also: AWS API Documentation

Request Syntax

client.create_fhir_datastore(
    DatastoreName='string',
    DatastoreTypeVersion='R4',
    SseConfiguration={
        'KmsEncryptionConfig': {
            'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
            'KmsKeyId': 'string'
        }
    },
    PreloadDataConfig={
        'PreloadDataType': 'SYNTHEA'
    },
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IdentityProviderConfiguration={
        'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
        'FineGrainedAuthorizationEnabled': True|False,
        'Metadata': 'string',
        'IdpLambdaArn': 'string'
    },
    AnalyticsConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
    },
    NlpConfiguration={
        'Status': 'ENABLED'|'DISABLED'|'ENABLING'|'DISABLING'
    },
    ProfileConfiguration={
        'DefaultProfiles': [
            'string',
        ]
    }
)

type DatastoreName:

string

param DatastoreName:

The data store name (user-generated).

type DatastoreTypeVersion:

string

param DatastoreTypeVersion:

[REQUIRED]

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

type SseConfiguration:

dict

param SseConfiguration:

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

• KmsEncryptionConfig (dict) -- [REQUIRED]

  The Key Management Service (KMS) encryption configuration used to provide details for data encryption.

  • CmkType (string) -- [REQUIRED]

    The type of customer-managed-key (CMK) used for encryption.

  • KmsKeyId (string) --

    The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

type PreloadDataConfig:

dict

param PreloadDataConfig:

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

• PreloadDataType (string) -- [REQUIRED]

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

type ClientToken:

string

param ClientToken:

An optional user-provided token to ensure API idempotency.

This field is autopopulated if not provided.

type Tags:

list

param Tags:

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

• (dict) --

  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 a tag. Tag values are case-sensitive.

type IdentityProviderConfiguration:

dict

param IdentityProviderConfiguration:

The identity provider configuration to use for the data store.

• AuthorizationStrategy (string) -- [REQUIRED]

  The authorization strategy selected when the HealthLake data store is created.

• FineGrainedAuthorizationEnabled (boolean) --

  The parameter to enable SMART on FHIR fine-grained authorization for the data store.

• Metadata (string) --

  The JSON metadata elements 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.

• IdpLambdaArn (string) --

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

type AnalyticsConfiguration:

dict

param AnalyticsConfiguration:

The analytics configuration for the data store.

• Status (string) --

  The status of the analytics configuration.

type NlpConfiguration:

dict

param NlpConfiguration:

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

• Status (string) --

  The status of the NLP configuration.

type ProfileConfiguration:

dict

param ProfileConfiguration:

The profile configuration for the data store.

• DefaultProfiles (list) --

  The list of default profiles for the data store.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
    'DatastoreEndpoint': 'string'
}

Response Structure

• (dict) --

  • DatastoreId (string) --

    The data store identifier.

  • DatastoreArn (string) --

    The Amazon Resource Name (ARN) for the data store.

  • DatastoreStatus (string) --

    The data store status.

  • DatastoreEndpoint (string) --

    The AWS endpoint created for the data store.