String datastoreName
The user generated name for the data store.
String datastoreTypeVersion
The FHIR version of the data store. The only supported version is R4.
SseConfiguration sseConfiguration
The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
PreloadDataConfig preloadDataConfig
Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
String clientToken
Optional user provided token used for ensuring idempotency.
List<E> tags
Resource tags that are applied to a data store when it is created.
IdentityProviderConfiguration identityProviderConfiguration
The configuration of the identity provider that you want to use for your data store.
String datastoreId
The AWS-generated data store id. This id is in the output from the initial data store creation call.
String datastoreArn
The data store ARN is generated during the creation of the data store and can be found in the output from the initial data store creation call.
String datastoreStatus
The status of the FHIR data store.
String datastoreEndpoint
The AWS endpoint for the created data store.
String datastoreName
Allows the user to filter data store results by name.
String datastoreStatus
Allows the user to filter data store results by status.
Date createdBefore
A filter that allows the user to set cutoff dates for records. All data stores created before the specified date will be included in the results.
Date createdAfter
A filter that allows the user to set cutoff dates for records. All data stores created after the specified date will be included in the results.
String datastoreId
The AWS-generated ID number for the data store.
String datastoreArn
The Amazon Resource Name used in the creation of the data store.
String datastoreName
The user-generated name for the data store.
String datastoreStatus
The status of the data store.
Date createdAt
The time that a data store was created.
String datastoreTypeVersion
The FHIR version. Only R4 version data is supported.
String datastoreEndpoint
The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.
SseConfiguration sseConfiguration
The server-side encryption key configuration for a customer provided encryption key (CMK).
PreloadDataConfig preloadDataConfig
The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
IdentityProviderConfiguration identityProviderConfiguration
The identity provider that you selected when you created the data store.
ErrorCause errorCause
The error cause for the current data store operation.
String datastoreId
The AWS-generated ID for the data store to be deleted.
String datastoreId
The AWS-generated ID for the data store to be deleted.
String datastoreArn
The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
String datastoreStatus
The status of the data store that the user has requested to be deleted.
String datastoreEndpoint
The AWS endpoint for the data store the user has requested to be deleted.
String datastoreId
The AWS-generated data store ID.
DatastoreProperties datastoreProperties
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.
ExportJobProperties exportJobProperties
Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.
ImportJobProperties importJobProperties
The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.
String jobId
The AWS generated ID for an export job.
String jobName
The user generated name for an export job.
String jobStatus
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
Date submitTime
The time an export job was initiated.
Date endTime
The time an export job completed.
String datastoreId
The AWS generated ID for the data store from which files are being exported for an export job.
OutputDataConfig outputDataConfig
The output data configuration that was supplied when the export job was created.
String dataAccessRoleArn
The Amazon Resource Name used during the initiation of the job.
String message
An explanation of any errors that may have occurred during the export job.
String authorizationStrategy
The authorization strategy that you selected when you created the data store.
Boolean fineGrainedAuthorizationEnabled
If you enabled fine-grained authorization when you created the data store.
String 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.
String idpLambdaArn
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
String jobId
The AWS-generated id number for the Import job.
String jobName
The user-generated name for an Import job.
String jobStatus
The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
Date submitTime
The time that the Import job was submitted for processing.
Date endTime
The time that the Import job was completed.
String datastoreId
The datastore id used when the Import job was created.
InputDataConfig inputDataConfig
The input data configuration that was supplied when the Import job was created.
OutputDataConfig jobOutputDataConfig
JobProgressReport jobProgressReport
Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.
String message
An explanation of any errors that may have occurred during the FHIR import job.
String s3Uri
The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
Long totalNumberOfScannedFiles
The number of files scanned from input S3 bucket.
Double totalSizeOfScannedFilesInMB
The size (in MB) of the files scanned from the input S3 bucket.
Long totalNumberOfImportedFiles
The number of files imported so far.
Long totalNumberOfResourcesScanned
The number of resources scanned from the input S3 bucket.
Long totalNumberOfResourcesImported
The number of resources imported so far.
Long totalNumberOfResourcesWithCustomerError
The number of resources that failed due to customer error.
Long totalNumberOfFilesReadWithCustomerError
The number of files that failed to be read from the input S3 bucket due to customer error.
Double throughput
The throughput (in MB/sec) of the import job.
DatastoreFilter filter
Lists all filters associated with a FHIR data store request.
String nextToken
Fetches the next page of data stores when results are paginated.
Integer maxResults
The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.
String datastoreId
This parameter limits the response to the export job with the specified data store ID.
String nextToken
A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
Integer maxResults
This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
String jobName
This parameter limits the response to the export job with the specified job name.
String jobStatus
This parameter limits the response to the export jobs with the specified job status.
Date submittedBefore
This parameter limits the response to FHIR export jobs submitted before a user specified date.
Date submittedAfter
This parameter limits the response to FHIR export jobs submitted after a user specified date.
String datastoreId
This parameter limits the response to the import job with the specified data store ID.
String nextToken
A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
Integer maxResults
This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
String jobName
This parameter limits the response to the import job with the specified job name.
String jobStatus
This parameter limits the response to the import job with the specified job status.
Date submittedBefore
This parameter limits the response to FHIR import jobs submitted before a user specified date.
Date submittedAfter
This parameter limits the response to FHIR import jobs submitted after a user specified date.
List<E> importJobPropertiesList
The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.
String nextToken
A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
String resourceARN
The Amazon Resource Name(ARN) of the data store for which tags are being added.
S3Configuration s3Configuration
The output data configuration that was supplied when the export job was created.
String preloadDataType
The type of preloaded data. Only Synthea preloaded data is supported.
KmsEncryptionConfig kmsEncryptionConfig
The KMS encryption configuration used to provide details for data encryption.
String jobName
The user generated name for an export job.
OutputDataConfig outputDataConfig
The output data configuration that was supplied when the export job was created.
String datastoreId
The AWS generated ID for the data store from which files are being exported for an export job.
String dataAccessRoleArn
The Amazon Resource Name used during the initiation of the job.
String clientToken
An optional user provided token used for ensuring idempotency.
String jobId
The AWS generated ID for an export job.
String jobStatus
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
String datastoreId
The AWS generated ID for the data store from which files are being exported for an export job.
String jobName
The name of the FHIR Import job in the StartFHIRImport job request.
InputDataConfig inputDataConfig
The input properties of the FHIR Import job in the StartFHIRImport job request.
OutputDataConfig jobOutputDataConfig
String datastoreId
The AWS-generated data store ID.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
String clientToken
Optional user provided token used for ensuring idempotency.
Copyright © 2025. All rights reserved.