HealthLake / Client / describe_fhir_datastore

describe_fhir_datastore¶

HealthLake.Client.describe_fhir_datastore(**kwargs)¶

Get properties for a FHIR-enabled data store.

Request Syntax

response = client.describe_fhir_datastore(
    DatastoreId='string'
)

Parameters:

DatastoreId (string) –

[REQUIRED]

The data store identifier.

Return type:

dict

Returns:

Response Syntax

{
    'DatastoreProperties': {
        'DatastoreId': 'string',
        'DatastoreArn': 'string',
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'DatastoreTypeVersion': 'R4',
        'DatastoreEndpoint': 'string',
        'SseConfiguration': {
            'KmsEncryptionConfig': {
                'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
                'KmsKeyId': 'string'
            }
        },
        'PreloadDataConfig': {
            'PreloadDataType': 'SYNTHEA'
        },
        'IdentityProviderConfiguration': {
            'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
            'FineGrainedAuthorizationEnabled': True|False,
            'Metadata': 'string',
            'IdpLambdaArn': 'string'
        },
        'ErrorCause': {
            'ErrorMessage': 'string',
            'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
        }
    }
}

Response Structure

(dict) –
- DatastoreProperties (dict) –
  
  The data store properties.
  - DatastoreId (string) –
    
    The data store identifier.
  - DatastoreArn (string) –
    
    The Amazon Resource Name (ARN) used in the creation of the data store.
  - DatastoreName (string) –
    
    The data store name.
  - DatastoreStatus (string) –
    
    The data store status.
  - CreatedAt (datetime) –
    
    The time the data store was created.
  - DatastoreTypeVersion (string) –
    
    The FHIR release version supported by the data store. Current support is for version R4.
  - DatastoreEndpoint (string) –
    
    The AWS endpoint for the data store.
  - SseConfiguration (dict) –
    
    The server-side encryption key configuration for a customer provided encryption key.
    - KmsEncryptionConfig (dict) –
      
      The Key Management Service (KMS) encryption configuration used to provide details for data encryption.
      - CmkType (string) –
        
        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.
  - PreloadDataConfig (dict) –
    
    The preloaded Synthea data configuration for the data store.
    - PreloadDataType (string) –
      
      The type of preloaded data. Only Synthea preloaded data is supported.
  - IdentityProviderConfiguration (dict) –
    
    The identity provider selected during data store creation.
    - AuthorizationStrategy (string) –
      
      The authorization strategy selected when the HealthLake data store is created.
      Note
      HealthLake provides support for both SMART on FHIR V1 and V2 as described below.
      
      SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions.
      
      SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create, read, update, delete, and search permissions.
      
      AWS_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.
    - 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.
  - ErrorCause (dict) –
    
    The error cause for the current data store operation.
    - ErrorMessage (string) –
      
      The error message text for ErrorCause.
    - ErrorCategory (string) –
      
      The error category for ErrorCause.

Exceptions

HealthLake.Client.exceptions.ValidationException
HealthLake.Client.exceptions.ResourceNotFoundException
HealthLake.Client.exceptions.ThrottlingException
HealthLake.Client.exceptions.InternalServerException