The Amazon HealthLake API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• DatastoreFilter (p. 43)
• DatastoreProperties (p. 44)
• ExportJobProperties (p. 46)
• ImportJobProperties (p. 48)
• InputDataConfig (p. 50)
• KmsEncryptionConfig (p. 51)
• OutputDataConfig (p. 52)
• PreloadDataConfig (p. 53)
• S3Configuration (p. 54)
• SseConfiguration (p. 55)
• Tag (p. 56)
DatastoreFilter
DatastoreFilter
The filters applied to Data Store query.
Contents
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.
Type: Timestamp Required: No 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.
Type: Timestamp Required: No DatastoreName
Allows the user to filter Data Store results by name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No DatastoreStatus
Allows the user to filter Data Store results by status.
Type: String
Valid Values: CREATING | ACTIVE | DELETING | DELETED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreProperties
DatastoreProperties
Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.
Contents
CreatedAt
The time that a Data Store was created.
Type: Timestamp Required: No DatastoreArn
The Amazon Resource Name used in the creation of the Data Store.
Type: String
Pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:
[0-9]{12}:datastore/.+?
Required: Yes 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.
Type: String
Length Constraints: Maximum length of 10000.
Pattern: [\P{M}\p{M}]{0,10000}
Required: Yes DatastoreId
The AWS-generated ID number for the Data Store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes DatastoreName
The user-generated name for the Data Store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No
See Also
DatastoreStatus
The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
Type: String
Valid Values: CREATING | ACTIVE | DELETING | DELETED Required: Yes
DatastoreTypeVersion
The FHIR version. Only R4 version data is supported.
Type: String Valid Values: R4 Required: Yes PreloadDataConfig
The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
Type: PreloadDataConfig (p. 53) object Required: No
SseConfiguration
The server-side encryption key configuration for a customer provided encryption key (CMK).
Type: SseConfiguration (p. 55) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExportJobProperties
ExportJobProperties
The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Contents
DataAccessRoleArn
The Amazon Resource Name used during the initiation of the job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Required: No DatastoreId
The AWS generated ID for the Data Store from which files are being exported for an export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes EndTime
The time an export job completed.
Type: Timestamp Required: No JobId
The AWS generated ID for an export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes JobName
The user generated name for an export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No
See Also
JobStatus
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED
Required: Yes Message
An explanation of any errors that may have occurred during the export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No OutputDataConfig
The output data configuration that was supplied when the export job was created.
Type: OutputDataConfig (p. 52) object Required: Yes
SubmitTime
The time an export job was initiated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ImportJobProperties
ImportJobProperties
Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.
Contents
DataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Required: No DatastoreId
The datastore id used when the Import job was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes EndTime
The time that the Import job was completed.
Type: Timestamp Required: No InputDataConfig
The input data configuration that was supplied when the Import job was created.
Type: InputDataConfig (p. 50) object Required: Yes
JobId
The AWS-generated id number for the Import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: Yes JobName
The user-generated name for an Import job.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No JobOutputDataConfig
The output data configuration that was supplied when the export job was created.
Type: OutputDataConfig (p. 52) object Required: No
JobStatus
The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED | FAILED
Required: Yes Message
An explanation of any errors that may have occurred during the FHIR import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No SubmitTime
The time that the Import job was submitted for processing.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InputDataConfig
InputDataConfig
The input properties for an import job.
Contents
S3Uri
The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KmsEncryptionConfig
KmsEncryptionConfig
The customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.
Contents
CmkType
The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
Type: String
Valid Values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY Required: Yes
KmsKeyId
The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 400.
Pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+)) Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OutputDataConfig
OutputDataConfig
The output data configuration that was supplied when the export job was created.
Contents
S3Configuration
The output data configuration that was supplied when the export job was created.
Type: S3Configuration (p. 54) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PreloadDataConfig
PreloadDataConfig
The input properties for the preloaded Data Store. Only data preloaded from Synthea is supported.
Contents
PreloadDataType
The type of preloaded data. Only Synthea preloaded data is supported.
Type: String
Valid Values: SYNTHEA Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3