{ "version":"2.0", "metadata":{ "apiVersion":"2017-07-01", "auth":["aws.auth#sigv4"], "endpointPrefix":"healthlake", "jsonVersion":"1.0", "protocol":"json", "protocols":["json"], "serviceAbbreviation":"HealthLake", "serviceFullName":"Amazon HealthLake", "serviceId":"HealthLake", "signatureVersion":"v4", "signingName":"healthlake", "targetPrefix":"HealthLake", "uid":"healthlake-2017-07-01" }, "operations":{ "CreateDataTransformationProfile":{ "name":"CreateDataTransformationProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataTransformationProfileRequest"}, "output":{"shape":"CreateDataTransformationProfileResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.

", "endpoint":{"hostPrefix":"datatransformation."} }, "CreateFHIRDatastore":{ "name":"CreateFHIRDatastore", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFHIRDatastoreRequest"}, "output":{"shape":"CreateFHIRDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Create a FHIR-enabled data store.

" }, "DeleteDataTransformationProfile":{ "name":"DeleteDataTransformationProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDataTransformationProfileRequest"}, "output":{"shape":"DeleteDataTransformationProfileResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.

", "endpoint":{"hostPrefix":"datatransformation."}, "idempotent":true }, "DeleteFHIRDatastore":{ "name":"DeleteFHIRDatastore", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFHIRDatastoreRequest"}, "output":{"shape":"DeleteFHIRDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Delete a FHIR-enabled data store.

" }, "DescribeDataTransformationJob":{ "name":"DescribeDataTransformationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDataTransformationJobRequest"}, "output":{"shape":"DescribeDataTransformationJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Describes a data transformation job, including its current status, configuration, and progress information.

", "endpoint":{"hostPrefix":"datatransformation."}, "readonly":true }, "DescribeFHIRDatastore":{ "name":"DescribeFHIRDatastore", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFHIRDatastoreRequest"}, "output":{"shape":"DescribeFHIRDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Get properties for a FHIR-enabled data store.

" }, "DescribeFHIRExportJob":{ "name":"DescribeFHIRExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFHIRExportJobRequest"}, "output":{"shape":"DescribeFHIRExportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Get FHIR export job properties.

" }, "DescribeFHIRImportJob":{ "name":"DescribeFHIRImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFHIRImportJobRequest"}, "output":{"shape":"DescribeFHIRImportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Get the import job properties to learn more about the job or job progress.

" }, "GetDataTransformationProfile":{ "name":"GetDataTransformationProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataTransformationProfileRequest"}, "output":{"shape":"GetDataTransformationProfileResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.

", "endpoint":{"hostPrefix":"datatransformation."}, "readonly":true }, "ListDataTransformationJobs":{ "name":"ListDataTransformationJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDataTransformationJobsRequest"}, "output":{"shape":"ListDataTransformationJobsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "endpoint":{"hostPrefix":"datatransformation."}, "readonly":true }, "ListDataTransformationProfileVersions":{ "name":"ListDataTransformationProfileVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDataTransformationProfileVersionsRequest"}, "output":{"shape":"ListDataTransformationProfileVersionsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "endpoint":{"hostPrefix":"datatransformation."}, "readonly":true }, "ListDataTransformationProfiles":{ "name":"ListDataTransformationProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDataTransformationProfilesRequest"}, "output":{"shape":"ListDataTransformationProfilesResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

", "endpoint":{"hostPrefix":"datatransformation."}, "readonly":true }, "ListFHIRDatastores":{ "name":"ListFHIRDatastores", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFHIRDatastoresRequest"}, "output":{"shape":"ListFHIRDatastoresResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

List all FHIR-enabled data stores in a user’s account, regardless of data store status.

" }, "ListFHIRExportJobs":{ "name":"ListFHIRExportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFHIRExportJobsRequest"}, "output":{"shape":"ListFHIRExportJobsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists all FHIR export jobs associated with an account and their statuses.

" }, "ListFHIRImportJobs":{ "name":"ListFHIRImportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFHIRImportJobsRequest"}, "output":{"shape":"ListFHIRImportJobsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

List all FHIR import jobs associated with an account and their statuses.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns a list of all existing tags associated with a data store.

" }, "PublishDataTransformationProfile":{ "name":"PublishDataTransformationProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PublishDataTransformationProfileRequest"}, "output":{"shape":"PublishDataTransformationProfileResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.

", "endpoint":{"hostPrefix":"datatransformation."} }, "StartDataTransformationJob":{ "name":"StartDataTransformationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartDataTransformationJobRequest"}, "output":{"shape":"StartDataTransformationJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.

", "endpoint":{"hostPrefix":"datatransformation."}, "idempotent":true }, "StartFHIRExportJob":{ "name":"StartFHIRExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartFHIRExportJobRequest"}, "output":{"shape":"StartFHIRExportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"FailedDependencyException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Start a FHIR export job.

" }, "StartFHIRImportJob":{ "name":"StartFHIRImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartFHIRImportJobRequest"}, "output":{"shape":"StartFHIRImportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"FailedDependencyException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Add a user-specifed key and value tag to a data store.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Remove a user-specifed key and value tag from a data store.

" }, "UpdateDataTransformationProfile":{ "name":"UpdateDataTransformationProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDataTransformationProfileRequest"}, "output":{"shape":"UpdateDataTransformationProfileResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.

", "endpoint":{"hostPrefix":"datatransformation."}, "idempotent":true }, "UpdateFHIRDatastore":{ "name":"UpdateFHIRDatastore", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateFHIRDatastoreRequest"}, "output":{"shape":"UpdateFHIRDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Update the properties of a FHIR-enabled data store.

" }, "UpdateProfileWithAgent":{ "name":"UpdateProfileWithAgent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProfileWithAgentRequest"}, "output":{"shape":"UpdateProfileWithAgentResponse"}, "errors":[ {"shape":"NotImplementedOperationException"}, {"shape":"ConversationNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AgentMessageOutOfContextException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"UnsupportedMIMETypeException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

", "endpoint":{"hostPrefix":"datatransformation."} } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

Access is denied. Your account is not authorized to perform this operation.

", "exception":true }, "AgentInputMessage":{ "type":"structure", "required":[ "Body", "Type" ], "members":{ "Body":{ "shape":"AgentMessageString", "documentation":"

The text of your message to the agent.

" }, "Type":{ "shape":"AgentInputMessageType", "documentation":"

The type of input message, which determines how the agent processes your request. Valid values:

" } }, "documentation":"

Represents a message sent to the agent during chat-based profile customization.

" }, "AgentInputMessageType":{ "type":"string", "enum":[ "normal", "confirmation_response" ] }, "AgentMessageOutOfContextException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

The agent message does not fit within the current conversation context. Start a new conversation or provide a message that relates to the current profile customization session.

", "exception":true }, "AgentMessageString":{ "type":"string", "max":40960, "min":1, "sensitive":true }, "AgentOutputMessage":{ "type":"structure", "required":[ "Body", "Type" ], "members":{ "Body":{ "shape":"AgentMessageString", "documentation":"

The text of the agent's response.

" }, "Type":{ "shape":"AgentOutputMessageType", "documentation":"

The type of output message, which indicates how to interpret the agent's response.

" }, "OptionsList":{ "shape":"DataTransformationChatOptionsList", "documentation":"

A list of selectable options presented when the response type is options.

" } }, "documentation":"

Represents a response message from the agent during chat-based profile customization.

" }, "AgentOutputMessageType":{ "type":"string", "enum":[ "INITIAL_GREETING", "normal", "confirmation", "complete", "error", "options", "choices" ] }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1, "pattern":"arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\\d{12}:(datastore\\/fhir\\/.{32}|dataTransformationProfile\\/[a-f0-9]{32})" }, "AnalyticsConfiguration":{ "type":"structure", "members":{ "Status":{ "shape":"AnalyticsStatus", "documentation":"

The status of the analytics configuration.

" } }, "documentation":"

The analytics configuration for a data store.

" }, "AnalyticsStatus":{ "type":"string", "enum":[ "ENABLED", "ENABLING", "DISABLED", "DISABLING", "PAUSING", "PAUSED" ] }, "AuthorizationStrategy":{ "type":"string", "enum":[ "SMART_ON_FHIR_V1", "SMART_ON_FHIR", "AWS_AUTH" ] }, "Boolean":{ "type":"boolean", "box":true }, "BoundedLengthString":{ "type":"string", "documentation":"

A bounded-length string value.

", "max":5000, "min":1, "pattern":"[\\P{M}\\p{M}]{1,5000}" }, "BoundedString":{ "type":"string", "max":2048, "min":1 }, "ChangeDescription":{ "type":"string", "max":1000, "min":0 }, "ClientToken":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "ClientTokenString":{ "type":"string", "documentation":"

A client-provided idempotency token.

", "max":64, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "CmkType":{ "type":"string", "enum":[ "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY" ] }, "ConfigurationMetadata":{"type":"string"}, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

The data store is in a transition state and the user requested action cannot be performed.

", "exception":true }, "ConversationIdString":{ "type":"string", "max":36, "min":1 }, "ConversationNotFoundException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified conversation identifier does not exist. Verify the conversation ID or omit it to start a new conversation.

", "exception":true }, "CreateDataTransformationProfileRequest":{ "type":"structure", "required":[ "SourceFormat", "Source", "ProfileName" ], "members":{ "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).

" }, "Source":{ "shape":"CreateDataTransformationProfileSource", "documentation":"

The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

A human-readable description of the profile's purpose.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

A name for the data transformation profile.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to associate with the profile at creation time.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", "idempotencyToken":true } }, "documentation":"

The request parameters for the CreateDataTransformationProfile operation.

" }, "CreateDataTransformationProfileResponse":{ "type":"structure", "required":[ "ProfileId", "Version", "SourceFormat", "TargetFormat", "ProfileName", "LastUpdatedAt" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the created profile.

" }, "Version":{ "shape":"ProfileVersion", "documentation":"

The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format of the profile.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format. Always FHIR_R4.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the created profile.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when the profile was last updated.

" } }, "documentation":"

The response from the CreateDataTransformationProfile operation.

" }, "CreateDataTransformationProfileSource":{ "type":"structure", "members":{ "StarterProfile":{ "shape":"StarterProfileSource", "documentation":"

Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).

" }, "ExistingVersionedProfileId":{ "shape":"ExistingVersionedProfileSource", "documentation":"

Creates the profile by cloning an existing profile at a specific version.

" }, "ProfileMapping":{ "shape":"ProfileMappingSource", "documentation":"

Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows.

" }, "SampleData":{ "shape":"SampleDataSource", "documentation":"

Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV).

" } }, "documentation":"

The source for initial content when creating a data transformation profile. Specify exactly one variant: a built-in starter profile, an existing profile version to clone, raw profile content, or a sample data file.

", "union":true }, "CreateFHIRDatastoreRequest":{ "type":"structure", "required":["DatastoreTypeVersion"], "members":{ "DatastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name (user-generated).

" }, "DatastoreTypeVersion":{ "shape":"FHIRVersion", "documentation":"

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

" }, "SseConfiguration":{ "shape":"SseConfiguration", "documentation":"

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

" }, "PreloadDataConfig":{ "shape":"PreloadDataConfig", "documentation":"

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

" }, "ClientToken":{ "shape":"ClientTokenString", "documentation":"

An optional user-provided token to ensure API idempotency.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

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

" }, "IdentityProviderConfiguration":{ "shape":"IdentityProviderConfiguration", "documentation":"

The identity provider configuration to use for the data store.

" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfiguration", "documentation":"

The analytics configuration for the data store.

" }, "NlpConfiguration":{ "shape":"NlpConfiguration", "documentation":"

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

" }, "ProfileConfiguration":{ "shape":"ProfileConfiguration", "documentation":"

The profile configuration for the data store.

" } } }, "CreateFHIRDatastoreResponse":{ "type":"structure", "required":[ "DatastoreId", "DatastoreArn", "DatastoreStatus", "DatastoreEndpoint" ], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "DatastoreArn":{ "shape":"DatastoreArn", "documentation":"

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

" }, "DatastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" }, "DatastoreEndpoint":{ "shape":"BoundedLengthString", "documentation":"

The AWS endpoint created for the data store.

" } } }, "DataTransformationChatOptionString":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "DataTransformationChatOptionsList":{ "type":"list", "member":{"shape":"DataTransformationChatOptionString"} }, "DataTransformationIamRoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" }, "DataTransformationJobId":{ "type":"string", "max":32, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "DataTransformationJobName":{ "type":"string", "max":64, "min":1, "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*" }, "DataTransformationNextToken":{ "type":"string", "max":2048, "min":1 }, "DataTransformationProfileSummary":{ "type":"structure", "required":[ "ProfileId", "Version", "SourceFormat", "TargetFormat" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile.

" }, "Version":{ "shape":"ProfileVersion", "documentation":"

The latest version number of the profile.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format that this profile converts from.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format of the profile.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the profile.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

A description of the profile's purpose.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when the profile was last updated.

" } }, "documentation":"

Contains summary information about a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.

" }, "DataTransformationProfileSummaryList":{ "type":"list", "member":{"shape":"DataTransformationProfileSummary"} }, "DataTransformationProfileVersionSummary":{ "type":"structure", "required":[ "ProfileId", "Version", "SourceFormat", "TargetFormat" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile.

" }, "Version":{ "shape":"ProfileVersion", "documentation":"

The version number.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format that this profile converts from.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format of the profile.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the profile.

" }, "ChangeDescription":{ "shape":"ChangeDescription", "documentation":"

A description of what changed in this version.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when this version was last updated.

" } }, "documentation":"

Contains summary information about a specific version of a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.

" }, "DataTransformationProfileVersionSummaryList":{ "type":"list", "member":{"shape":"DataTransformationProfileVersionSummary"} }, "DataTransformationS3Configuration":{ "type":"structure", "required":[ "S3Uri", "KmsKeyId" ], "members":{ "S3Uri":{ "shape":"DataTransformationS3Uri", "documentation":"

The Amazon S3 URI where AWS HealthLake writes the converted output files.

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.

" } }, "documentation":"

The Amazon S3 output configuration for a data transformation job, including the output location and encryption settings.

" }, "DataTransformationS3Uri":{ "type":"string", "max":2048, "min":8, "pattern":"s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9](/.+)?" }, "DataTransformationTagKey":{ "type":"string", "documentation":"

The key of the tag. Tag keys are case-sensitive and must be unique per resource.

", "max":128, "min":1 }, "DataTransformationTagValue":{ "type":"string", "documentation":"

The value of the tag. Tag values are case-sensitive and can be empty strings.

", "max":256, "min":0 }, "DatastoreArn":{ "type":"string", "documentation":"

The ARN of a data store.

", "pattern":"arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?" }, "DatastoreFilter":{ "type":"structure", "members":{ "DatastoreName":{ "shape":"DatastoreName", "documentation":"

Filter data store results by name.

" }, "DatastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

Filter data store results by status.

" }, "CreatedBefore":{ "shape":"HealthLakeTimestamp", "documentation":"

Filter to set cutoff dates for records. All data stores created before the specified date are included in the results.

" }, "CreatedAfter":{ "shape":"HealthLakeTimestamp", "documentation":"

Filter to set cutoff dates for records. All data stores created after the specified date are included in the results.

" } }, "documentation":"

The filters applied to a data store query.

" }, "DatastoreId":{ "type":"string", "documentation":"

The identifier of a data store.

", "max":32, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)" }, "DatastoreName":{ "type":"string", "documentation":"

The name of a data store.

", "max":256, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)" }, "DatastoreProperties":{ "type":"structure", "required":[ "DatastoreId", "DatastoreArn", "DatastoreStatus", "DatastoreTypeVersion", "DatastoreEndpoint" ], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "DatastoreArn":{ "shape":"DatastoreArn", "documentation":"

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

" }, "DatastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name.

" }, "DatastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" }, "CreatedAt":{ "shape":"HealthLakeTimestamp", "documentation":"

The time the data store was created.

" }, "DatastoreTypeVersion":{ "shape":"FHIRVersion", "documentation":"

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

" }, "DatastoreEndpoint":{ "shape":"HealthLakeString", "documentation":"

The AWS endpoint for the data store.

" }, "SseConfiguration":{ "shape":"SseConfiguration", "documentation":"

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

" }, "PreloadDataConfig":{ "shape":"PreloadDataConfig", "documentation":"

The preloaded Synthea data configuration for the data store.

" }, "IdentityProviderConfiguration":{ "shape":"IdentityProviderConfiguration", "documentation":"

The identity provider selected during data store creation.

" }, "ErrorCause":{ "shape":"ErrorCause", "documentation":"

The error cause for the current data store operation.

" }, "NlpConfiguration":{ "shape":"NlpConfiguration", "documentation":"

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

" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfiguration", "documentation":"

The analytics configuration for the data store.

" }, "ProfileConfiguration":{ "shape":"ProfileConfiguration", "documentation":"

The profile configuration for the data store.

" } }, "documentation":"

The data store properties.

" }, "DatastorePropertiesList":{ "type":"list", "member":{"shape":"DatastoreProperties"} }, "DatastoreStatus":{ "type":"string", "documentation":"

The status of a data store.

", "enum":[ "CREATING", "ACTIVE", "DELETING", "DELETED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED" ] }, "DateTime":{"type":"timestamp"}, "DefaultProfiles":{ "type":"list", "member":{"shape":"HealthLakeString"} }, "DeleteDataTransformationProfileRequest":{ "type":"structure", "required":["ProfileId"], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile to delete.

" } }, "documentation":"

The request parameters for the DeleteDataTransformationProfile operation.

" }, "DeleteDataTransformationProfileResponse":{ "type":"structure", "required":[ "ProfileId", "DeletionTime" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the deleted profile.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the deleted profile.

" }, "DeletionTime":{ "shape":"DateTime", "documentation":"

The timestamp when the profile was deleted.

" } }, "documentation":"

The response from the DeleteDataTransformationProfile operation.

" }, "DeleteFHIRDatastoreRequest":{ "type":"structure", "required":["DatastoreId"], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The AWS-generated identifier for the data store to be deleted.

" } } }, "DeleteFHIRDatastoreResponse":{ "type":"structure", "required":[ "DatastoreId", "DatastoreArn", "DatastoreStatus", "DatastoreEndpoint" ], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The AWS-generated ID for the deleted data store.

" }, "DatastoreArn":{ "shape":"DatastoreArn", "documentation":"

The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

" }, "DatastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" }, "DatastoreEndpoint":{ "shape":"BoundedLengthString", "documentation":"

The AWS endpoint of the data store to be deleted.

" } } }, "DescribeDataTransformationJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"DataTransformationJobId", "documentation":"

The unique identifier of the data transformation job to describe.

" } }, "documentation":"

The request parameters for the DescribeDataTransformationJob operation.

" }, "DescribeDataTransformationJobResponse":{ "type":"structure", "required":["TransformationJobProperties"], "members":{ "TransformationJobProperties":{ "shape":"TransformationJobProperties", "documentation":"

The properties of the data transformation job, including status, configuration, and progress information.

" } }, "documentation":"

The response from the DescribeDataTransformationJob operation.

" }, "DescribeFHIRDatastoreRequest":{ "type":"structure", "required":["DatastoreId"], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" } } }, "DescribeFHIRDatastoreResponse":{ "type":"structure", "required":["DatastoreProperties"], "members":{ "DatastoreProperties":{ "shape":"DatastoreProperties", "documentation":"

The data store properties.

" } } }, "DescribeFHIRExportJobRequest":{ "type":"structure", "required":[ "DatastoreId", "JobId" ], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier from which FHIR data is being exported from.

" }, "JobId":{ "shape":"JobId", "documentation":"

The export job identifier.

" } } }, "DescribeFHIRExportJobResponse":{ "type":"structure", "required":["ExportJobProperties"], "members":{ "ExportJobProperties":{ "shape":"ExportJobProperties", "documentation":"

The export job properties.

" } } }, "DescribeFHIRImportJobRequest":{ "type":"structure", "required":[ "DatastoreId", "JobId" ], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "JobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" } } }, "DescribeFHIRImportJobResponse":{ "type":"structure", "required":["ImportJobProperties"], "members":{ "ImportJobProperties":{ "shape":"ImportJobProperties", "documentation":"

The import job properties.

" } } }, "EncryptionKeyID":{ "type":"string", "documentation":"

The identifier of an encryption key.

", "max":400, "min":1, "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:/_-]+))" }, "ErrorCategory":{ "type":"string", "enum":[ "RETRYABLE_ERROR", "NON_RETRYABLE_ERROR" ] }, "ErrorCause":{ "type":"structure", "members":{ "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message text for ErrorCause.

" }, "ErrorCategory":{ "shape":"ErrorCategory", "documentation":"

The error category for ErrorCause.

" } }, "documentation":"

The error information for CreateFHIRDatastore and DeleteFHIRDatastore actions.

" }, "ErrorMessage":{ "type":"string", "max":4096, "min":1 }, "ExistingVersionedProfileSource":{ "type":"structure", "required":[ "ProfileId", "Version" ], "members":{ "ProfileId":{ "shape":"String", "documentation":"

The unique identifier of the existing profile to clone from.

" }, "Version":{ "shape":"Integer", "documentation":"

The version number of the existing profile to clone from.

" } }, "documentation":"

Identifies an existing data transformation profile and version to clone when creating a new profile.

" }, "ExportJobProperties":{ "type":"structure", "required":[ "JobId", "JobStatus", "SubmitTime", "DatastoreId", "OutputDataConfig" ], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The export job identifier.

" }, "JobName":{ "shape":"JobName", "documentation":"

The export job name.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The export job status.

" }, "SubmitTime":{ "shape":"HealthLakeTimestamp", "documentation":"

The time the export job was initiated.

" }, "EndTime":{ "shape":"HealthLakeTimestamp", "documentation":"

The time the export job completed.

" }, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier from which files are being exported.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

The output data configuration supplied when the export job was created.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) used during the initiation of the export job.

" }, "Message":{ "shape":"Message", "documentation":"

An explanation of any errors that might have occurred during the export job.

" } }, "documentation":"

The properties of a FHIR export job.

" }, "ExportJobPropertiesList":{ "type":"list", "member":{"shape":"ExportJobProperties"} }, "FHIRVersion":{ "type":"string", "documentation":"

The FHIR version supported by the data store.

", "enum":["R4"] }, "FailedDependencyException":{ "type":"structure", "members":{ "Message":{ "shape":"HealthLakeString", "documentation":"

A message describing the error.

" } }, "documentation":"

A dependent service failed to fulfill the request.

", "exception":true }, "GenericDouble":{ "type":"double", "documentation":"

A double-precision floating-point number.

", "box":true }, "GenericLong":{ "type":"long", "documentation":"

A long integer value.

", "box":true }, "GetDataTransformationProfileRequest":{ "type":"structure", "required":["ProfileId"], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile to retrieve.

" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.

" } }, "documentation":"

The request parameters for the GetDataTransformationProfile operation.

" }, "GetDataTransformationProfileResponse":{ "type":"structure", "required":[ "ProfileId", "Version", "SourceFormat", "TargetFormat", "ProfileMapping", "LastUpdatedAt" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile.

" }, "Version":{ "shape":"ProfileVersion", "documentation":"

The version number of the retrieved profile.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format of the profile.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format of the profile.

" }, "ProfileMapping":{ "shape":"ProfileMapping", "documentation":"

The profile content as a map of file paths to content strings.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the profile.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

The description of the profile.

" }, "ChangeDescription":{ "shape":"ChangeDescription", "documentation":"

A description of what changed in this version.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when this version was last updated.

" } }, "documentation":"

The response from the GetDataTransformationProfile operation.

" }, "HealthLakeBoolean":{ "type":"boolean", "documentation":"

A boolean value.

" }, "HealthLakeString":{ "type":"string", "documentation":"

A general-purpose string value.

", "max":10000, "min":0, "pattern":"[\\P{M}\\p{M}]{0,10000}" }, "HealthLakeTimestamp":{ "type":"timestamp", "documentation":"

A timestamp value.

" }, "IamRoleArn":{ "type":"string", "documentation":"

The IAM role ARN for data access.

", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" }, "IdentityProviderConfiguration":{ "type":"structure", "required":["AuthorizationStrategy"], "members":{ "AuthorizationStrategy":{ "shape":"AuthorizationStrategy", "documentation":"

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

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

" }, "FineGrainedAuthorizationEnabled":{ "shape":"HealthLakeBoolean", "documentation":"

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

" }, "Metadata":{ "shape":"ConfigurationMetadata", "documentation":"

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":{ "shape":"LambdaArn", "documentation":"

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

" } }, "documentation":"

The identity provider configuration selected when the data store was created.

" }, "ImportJobProperties":{ "type":"structure", "required":[ "JobId", "JobStatus", "SubmitTime", "DatastoreId", "InputDataConfig" ], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" }, "JobName":{ "shape":"JobName", "documentation":"

The import job name.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The import job status.

" }, "SubmitTime":{ "shape":"HealthLakeTimestamp", "documentation":"

The time the import job was submitted for processing.

" }, "EndTime":{ "shape":"HealthLakeTimestamp", "documentation":"

The time the import job was completed.

" }, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

The input data configuration supplied when the import job was created.

" }, "JobOutputDataConfig":{"shape":"OutputDataConfig"}, "JobProgressReport":{ "shape":"JobProgressReport", "documentation":"

Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.

" }, "Message":{ "shape":"Message", "documentation":"

An explanation of any errors that might have occurred during the FHIR import job.

" }, "ValidationLevel":{ "shape":"ValidationLevel", "documentation":"

The validation level of the import job.

" } }, "documentation":"

The import job properties.

" }, "ImportJobPropertiesList":{ "type":"list", "member":{"shape":"ImportJobProperties"} }, "InputDataConfig":{ "type":"structure", "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"

The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

" } }, "documentation":"

The import job input properties.

", "union":true }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

An unknown internal error occurred in the service.

", "exception":true, "fault":true }, "JobId":{ "type":"string", "documentation":"

The unique identifier of a job.

", "max":32, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)" }, "JobName":{ "type":"string", "documentation":"

The human-readable name of a job.

", "max":64, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)" }, "JobProgressReport":{ "type":"structure", "members":{ "TotalNumberOfScannedFiles":{ "shape":"GenericLong", "documentation":"

The number of files scanned from the S3 input bucket.

" }, "TotalSizeOfScannedFilesInMB":{ "shape":"GenericDouble", "documentation":"

The size (in MB) of files scanned from the S3 input bucket.

" }, "TotalNumberOfImportedFiles":{ "shape":"GenericLong", "documentation":"

The number of files imported.

" }, "TotalNumberOfResourcesScanned":{ "shape":"GenericLong", "documentation":"

The number of resources scanned from the S3 input bucket.

" }, "TotalNumberOfResourcesImported":{ "shape":"GenericLong", "documentation":"

The number of resources imported.

" }, "TotalNumberOfResourcesWithCustomerError":{ "shape":"GenericLong", "documentation":"

The number of resources that failed due to customer error.

" }, "TotalNumberOfFilesReadWithCustomerError":{ "shape":"GenericLong", "documentation":"

The number of files that failed to be read from the S3 input bucket due to customer error.

" }, "TotalNumberOfScannedNonFhirFiles":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR files scanned from the S3 input bucket.

" }, "TotalSizeOfScannedNonFhirFilesInMB":{ "shape":"GenericDouble", "documentation":"

The size (in MB) of non-FHIR files scanned from the S3 input bucket.

" }, "TotalNumberOfImportedNonFhirFiles":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR files imported.

" }, "TotalNumberOfNonFhirResourcesScanned":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR resources scanned from the S3 input bucket.

" }, "TotalNumberOfNonFhirResourcesImported":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR resources imported.

" }, "TotalNumberOfNonFhirResourcesWithCustomerError":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR resources that failed due to customer error.

" }, "TotalNumberOfNonFhirFilesReadWithCustomerError":{ "shape":"GenericLong", "documentation":"

The number of non-FHIR files that failed to be read from the S3 input bucket due to customer error.

" }, "Throughput":{ "shape":"GenericDouble", "documentation":"

The transaction rate the import job is processed at.

" }, "TotalFilesConverted":{ "shape":"GenericLong", "documentation":"

Number of CCDA files successfully transformed during the import's transformation phase. Populated only for import jobs that use the two-Step-Function (transformation + ingestion) flow; null for legacy single-SF imports and for pure FHIR imports that skip transformation.

" }, "TotalResourcesGenerated":{ "shape":"GenericLong", "documentation":"

Number of FHIR resources produced by the transformation phase. Populated only for import jobs that use the two-Step-Function flow; null for legacy single-SF imports and for pure FHIR imports.

" } }, "documentation":"

The progress report for the import job.

" }, "JobStatus":{ "type":"string", "documentation":"

The status of a job.

", "enum":[ "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED", "CANCEL_SUBMITTED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETED", "CANCEL_FAILED" ] }, "KmsEncryptionConfig":{ "type":"structure", "required":["CmkType"], "members":{ "CmkType":{ "shape":"CmkType", "documentation":"

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

" }, "KmsKeyId":{ "shape":"EncryptionKeyID", "documentation":"

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

" } }, "documentation":"

The customer-managed-key (CMK) used when creating a data store. If a customer-owned key is not specified, an AWS-owned key is used for encryption.

" }, "KmsKeyId":{ "type":"string", "max":2048, "min":1 }, "LambdaArn":{ "type":"string", "max":256, "min":49, "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?" }, "ListDataTransformationJobsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token from a previous response. Pass this value to retrieve the next page of results.

" }, "JobStatus":{ "shape":"TransformationJobStatus", "documentation":"

Filters the results to include only jobs with the specified status.

" }, "JobName":{ "shape":"DataTransformationJobName", "documentation":"

Filters the results to include only jobs with the specified name.

" }, "SubmittedAfter":{ "shape":"DateTime", "documentation":"

Filters the results to include only jobs submitted at or after this timestamp.

" }, "SubmittedBefore":{ "shape":"DateTime", "documentation":"

Filters the results to include only jobs submitted at or before this timestamp.

" } }, "documentation":"

The request parameters for the ListDataTransformationJobs operation.

" }, "ListDataTransformationJobsResponse":{ "type":"structure", "required":["Items"], "members":{ "Items":{ "shape":"TransformationJobSummaryList", "documentation":"

The list of data transformation job summaries.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token to use in the next request. If this value is null, there are no more results.

" } }, "documentation":"

The response from the ListDataTransformationJobs operation.

" }, "ListDataTransformationProfileVersionsRequest":{ "type":"structure", "required":["ProfileId"], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile whose versions to list.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token from a previous response. Pass this value to retrieve the next page of results.

" } }, "documentation":"

The request parameters for the ListDataTransformationProfileVersions operation.

" }, "ListDataTransformationProfileVersionsResponse":{ "type":"structure", "required":["Items"], "members":{ "Items":{ "shape":"DataTransformationProfileVersionSummaryList", "documentation":"

The list of data transformation profile version summaries.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token to use in the next request. If this value is null, there are no more results.

" } }, "documentation":"

The response from the ListDataTransformationProfileVersions operation.

" }, "ListDataTransformationProfilesRequest":{ "type":"structure", "required":["SourceFormat"], "members":{ "SourceFormat":{ "shape":"SourceFormat", "documentation":"

Filters the results by source data format.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token from a previous response. Pass this value to retrieve the next page of results.

" } }, "documentation":"

The request parameters for the ListDataTransformationProfiles operation.

" }, "ListDataTransformationProfilesResponse":{ "type":"structure", "required":["Items"], "members":{ "Items":{ "shape":"DataTransformationProfileSummaryList", "documentation":"

The list of data transformation profile summaries.

" }, "NextToken":{ "shape":"DataTransformationNextToken", "documentation":"

The pagination token to use in the next request. If this value is null, there are no more results.

" } }, "documentation":"

The response from the ListDataTransformationProfiles operation.

" }, "ListFHIRDatastoresRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"DatastoreFilter", "documentation":"

List all filters associated with a FHIR data store request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token used to retrieve the next page of data stores when results are paginated.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

The maximum number of data stores returned on a page.

" } } }, "ListFHIRDatastoresResponse":{ "type":"structure", "required":["DatastorePropertiesList"], "members":{ "DatastorePropertiesList":{ "shape":"DatastorePropertiesList", "documentation":"

The properties associated with all listed data stores.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token used to retrieve the next page of results.

" } } }, "ListFHIRExportJobsRequest":{ "type":"structure", "required":["DatastoreId"], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

Limits the response to the export job with the specified data store ID.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A pagination token used to identify the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.

" }, "JobName":{ "shape":"JobName", "documentation":"

Limits the response to the export job with the specified job name.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

Limits the response to export jobs with the specified job status.

" }, "SubmittedBefore":{ "shape":"HealthLakeTimestamp", "documentation":"

Limits the response to FHIR export jobs submitted before a user- specified date.

" }, "SubmittedAfter":{ "shape":"HealthLakeTimestamp", "documentation":"

Limits the response to FHIR export jobs submitted after a user-specified date.

" } } }, "ListFHIRExportJobsResponse":{ "type":"structure", "required":["ExportJobPropertiesList"], "members":{ "ExportJobPropertiesList":{ "shape":"ExportJobPropertiesList", "documentation":"

The properties of listed FHIR export jobs.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token used to identify the next page of results to return.

" } } }, "ListFHIRImportJobsRequest":{ "type":"structure", "required":["DatastoreId"], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

Limits the response to the import job with the specified data store ID.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token used to identify the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.

" }, "JobName":{ "shape":"JobName", "documentation":"

Limits the response to the import job with the specified job name.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

Limits the response to the import job with the specified job status.

" }, "SubmittedBefore":{ "shape":"HealthLakeTimestamp", "documentation":"

Limits the response to FHIR import jobs submitted before a user- specified date.

" }, "SubmittedAfter":{ "shape":"HealthLakeTimestamp", "documentation":"

Limits the response to FHIR import jobs submitted after a user-specified date.

" } } }, "ListFHIRImportJobsResponse":{ "type":"structure", "required":["ImportJobPropertiesList"], "members":{ "ImportJobPropertiesList":{ "shape":"ImportJobPropertiesList", "documentation":"

The properties for listed import jobs.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token used to identify the next page of results to return.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the data store to which tags are being added.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

Returns a list of tags associated with a data store.

" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsInteger":{ "type":"integer", "documentation":"

The maximum number of results to return per page.

", "box":true, "max":500, "min":1 }, "Message":{ "type":"string", "documentation":"

A message associated with a job or error.

", "max":2048, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)" }, "NextToken":{ "type":"string", "documentation":"

An opaque pagination token.

", "max":8192, "min":0, "pattern":"\\p{ASCII}{0,8192}" }, "NlpConfiguration":{ "type":"structure", "members":{ "Status":{ "shape":"NlpStatus", "documentation":"

The status of the NLP configuration.

" } }, "documentation":"

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

" }, "NlpStatus":{ "type":"string", "enum":[ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] }, "NotImplementedOperationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

The requested operation is not yet available. Check the service documentation for a list of supported operations.

", "exception":true, "fault":true }, "OutputDataConfig":{ "type":"structure", "members":{ "S3Configuration":{ "shape":"S3Configuration", "documentation":"

The output data configuration supplied when the export job was created.

" } }, "documentation":"

The output data configuration supplied when the export job was created.

", "union":true }, "PreloadDataConfig":{ "type":"structure", "required":["PreloadDataType"], "members":{ "PreloadDataType":{ "shape":"PreloadDataType", "documentation":"

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

" } }, "documentation":"

The input properties for the preloaded (Synthea) data store.

" }, "PreloadDataType":{ "type":"string", "documentation":"

The type of preloaded data.

", "enum":["SYNTHEA"] }, "ProfileConfiguration":{ "type":"structure", "members":{ "DefaultProfiles":{ "shape":"DefaultProfiles", "documentation":"

The list of default profiles for the data store.

" } }, "documentation":"

The profile configuration for a data store.

" }, "ProfileDescription":{ "type":"string", "max":1000, "min":0 }, "ProfileIdString":{ "type":"string", "max":32, "min":32, "pattern":"[a-f0-9]{32}" }, "ProfileMapping":{ "type":"map", "key":{"shape":"ProfileMappingKey"}, "value":{"shape":"ProfileMappingValue"}, "max":500, "min":1, "sensitive":true }, "ProfileMappingKey":{ "type":"string", "max":500, "min":1 }, "ProfileMappingSource":{ "type":"structure", "required":["ProfileMapping"], "members":{ "ProfileMapping":{ "shape":"StringMap", "documentation":"

The content as a map of file paths to profile strings.

" } }, "documentation":"

Contains raw content to use as the source when creating a data transformation profile directly from a mapping.

", "sensitive":true }, "ProfileMappingValue":{ "type":"string", "max":102400, "min":0 }, "ProfileNameString":{ "type":"string", "max":256, "min":1 }, "ProfileVersion":{ "type":"integer", "box":true, "max":99, "min":0 }, "PublishDataTransformationProfileRequest":{ "type":"structure", "required":[ "ProfileId", "SourceFormat" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile to publish.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format of the profile.

" }, "FromExistingVersion":{ "shape":"ProfileVersion", "documentation":"

The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.

" }, "ChangeDescription":{ "shape":"ChangeDescription", "documentation":"

A description of what changed or why this version is being published.

" } }, "documentation":"

The request parameters for the PublishDataTransformationProfile operation.

" }, "PublishDataTransformationProfileResponse":{ "type":"structure", "required":[ "ProfileId", "Version", "SourceFormat", "TargetFormat", "LastUpdatedAt" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the published profile.

" }, "Version":{ "shape":"ProfileVersion", "documentation":"

The new version number that was created.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format of the profile.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format of the profile.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the published profile.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when the profile was last updated.

" } }, "documentation":"

The response from the PublishDataTransformationProfile operation.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

The requested data store was not found.

", "exception":true }, "S3Configuration":{ "type":"structure", "required":[ "S3Uri", "KmsKeyId" ], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"

The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

" }, "KmsKeyId":{ "shape":"EncryptionKeyID", "documentation":"

The Key Management Service (KMS) key ID used to access the S3 bucket.

" } }, "documentation":"

The configuration of the S3 bucket for either an import or export job. This includes assigning access permissions.

" }, "S3Uri":{ "type":"string", "documentation":"

The S3 URI for data import or export.

", "max":1024, "min":0, "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" }, "SampleDataS3Uri":{ "type":"string", "max":1024, "min":1, "pattern":"s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9](/.*)?" }, "SampleDataSource":{ "type":"structure", "required":["S3Uri"], "members":{ "S3Uri":{ "shape":"SampleDataS3Uri", "documentation":"

The Amazon S3 URI of the sample data file.

" } }, "documentation":"

Identifies a sample data file in Amazon S3 to use as the source when creating a data transformation profile. Valid only when the source format is Comma-separated values (CSV).

" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{ "shape":"HealthLakeString", "documentation":"

A message describing the error.

" } }, "documentation":"

The request exceeds the service quota.

", "exception":true }, "SourceFormat":{ "type":"string", "enum":[ "CCDA", "CSV" ] }, "SseConfiguration":{ "type":"structure", "required":["KmsEncryptionConfig"], "members":{ "KmsEncryptionConfig":{ "shape":"KmsEncryptionConfig", "documentation":"

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

" } }, "documentation":"

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

" }, "StartDataTransformationJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "ClientToken", "ProfileId" ], "members":{ "InputDataConfig":{ "shape":"TransformationInputDataConfig", "documentation":"

The Amazon S3 location and format of the source files to transform.

" }, "OutputDataConfig":{ "shape":"TransformationOutputDataConfig", "documentation":"

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

" }, "DataAccessRoleArn":{ "shape":"DataTransformationIamRoleArn", "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

" }, "JobName":{ "shape":"DataTransformationJobName", "documentation":"

A descriptive name for the data transformation job.

" }, "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the data transformation profile to use for conversion.

" }, "DriftDetectionEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

" }, "ProvenanceEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

" } }, "documentation":"

The request parameters for the StartDataTransformationJob operation.

" }, "StartDataTransformationJobResponse":{ "type":"structure", "required":[ "JobId", "JobStatus" ], "members":{ "JobId":{ "shape":"DataTransformationJobId", "documentation":"

The unique identifier assigned to the data transformation job.

" }, "JobStatus":{ "shape":"TransformationJobStatus", "documentation":"

The initial status of the data transformation job.

" } }, "documentation":"

The response from the StartDataTransformationJob operation.

" }, "StartFHIRExportJobRequest":{ "type":"structure", "required":[ "OutputDataConfig", "DatastoreId", "DataAccessRoleArn" ], "members":{ "JobName":{ "shape":"JobName", "documentation":"

The export job name.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

The output data configuration supplied when the export job was started.

" }, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier from which files are being exported.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) used during initiation of the export job.

" }, "ClientToken":{ "shape":"ClientTokenString", "documentation":"

An optional user provided token used for ensuring API idempotency.

", "idempotencyToken":true } } }, "StartFHIRExportJobResponse":{ "type":"structure", "required":[ "JobId", "JobStatus" ], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The export job identifier.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The export job status.

" }, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier from which files are being exported.

" } } }, "StartFHIRImportJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "JobOutputDataConfig", "DatastoreId", "DataAccessRoleArn" ], "members":{ "JobName":{ "shape":"JobName", "documentation":"

The import job name.

" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

The input properties for the import job request.

" }, "JobOutputDataConfig":{"shape":"OutputDataConfig"}, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

" }, "ClientToken":{ "shape":"ClientTokenString", "documentation":"

The optional user-provided token used for ensuring API idempotency.

", "idempotencyToken":true }, "ValidationLevel":{ "shape":"ValidationLevel", "documentation":"

The validation level of the import job.

" }, "ProfileId":{"shape":"BoundedLengthString"}, "InputFormat":{"shape":"BoundedLengthString"}, "DriftDetectionEnabled":{"shape":"HealthLakeBoolean"} } }, "StartFHIRImportJobResponse":{ "type":"structure", "required":[ "JobId", "JobStatus" ], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The import job status.

" }, "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" } } }, "StarterProfileSource":{ "type":"structure", "required":["StarterProfileName"], "members":{ "StarterProfileName":{ "shape":"String", "documentation":"

The name of the built-in starter profile.

" } }, "documentation":"

Identifies a built-in starter profile to use as the source when creating a data transformation profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).

" }, "String":{"type":"string"}, "StringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key portion of a tag. Tag keys are case sensitive.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value portion of a tag. Tag values are case-sensitive.

" } }, "documentation":"

A label consisting of a user-defined key and value. The form for tags is {\"Key\", \"Value\"}

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"DataTransformationTagKey"}, "value":{"shape":"DataTransformationTagValue"}, "documentation":"

A map of tag keys to tag values associated with the resource.

", "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.

" }, "Tags":{ "shape":"TagList", "documentation":"

The user-specified key and value pair tags being added to a data store.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TargetFormat":{ "type":"string", "enum":["FHIR_R4"] }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

The user has exceeded their maximum number of allowed calls to the given API.

", "exception":true }, "TransformationInputDataConfig":{ "type":"structure", "required":["S3Uri"], "members":{ "S3Uri":{ "shape":"DataTransformationS3Uri", "documentation":"

The Amazon S3 URI of the input data to transform.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The format of the source data files (C-CDA or CSV).

" } }, "documentation":"

The Amazon S3 location and source format configuration for input data in a transformation job.

" }, "TransformationJobProgressReport":{ "type":"structure", "required":[ "TotalFilesScanned", "TotalFilesConverted", "TotalFilesFailed", "TotalResourcesGenerated" ], "members":{ "TotalFilesScanned":{ "shape":"Long", "documentation":"

The total number of source files scanned by the job.

" }, "TotalFilesConverted":{ "shape":"Long", "documentation":"

The total number of source files successfully converted.

" }, "TotalFilesFailed":{ "shape":"Long", "documentation":"

The total number of source files that failed conversion.

" }, "TotalResourcesGenerated":{ "shape":"Long", "documentation":"

The total number of FHIR R4 resources generated across all converted files.

" } }, "documentation":"

Contains progress metrics for a data transformation job, including counts of files scanned, converted, and failed.

" }, "TransformationJobProperties":{ "type":"structure", "required":[ "JobId", "JobStatus", "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "SubmitTime" ], "members":{ "JobId":{ "shape":"DataTransformationJobId", "documentation":"

The unique identifier of the data transformation job.

" }, "JobStatus":{ "shape":"TransformationJobStatus", "documentation":"

The current status of the data transformation job.

" }, "InputDataConfig":{ "shape":"TransformationInputDataConfig", "documentation":"

The Amazon S3 location and format of the source files for this job.

" }, "OutputDataConfig":{ "shape":"TransformationOutputDataConfig", "documentation":"

The Amazon S3 location and encryption configuration for the converted output.

" }, "DataAccessRoleArn":{ "shape":"DataTransformationIamRoleArn", "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files.

" }, "SubmitTime":{ "shape":"DateTime", "documentation":"

The timestamp when the job was submitted.

" }, "JobName":{ "shape":"DataTransformationJobName", "documentation":"

The name of the data transformation job.

" }, "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the data transformation profile used for this job.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the data transformation profile used for this job.

" }, "ProfileVersion":{ "shape":"Integer", "documentation":"

The version number of the data transformation profile used for this job.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The timestamp when the job completed or failed.

" }, "DriftDetectionEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

" }, "ProvenanceEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.

" }, "Message":{ "shape":"BoundedString", "documentation":"

An informational message about the job, such as an error description if the job failed.

" }, "JobProgressReport":{ "shape":"TransformationJobProgressReport", "documentation":"

The progress report for the data transformation job, including counts of files processed and resources generated.

" } }, "documentation":"

Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling DescribeDataTransformationJob.

" }, "TransformationJobStatus":{ "type":"string", "enum":[ "SUBMITTED", "QUEUED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED" ] }, "TransformationJobSummary":{ "type":"structure", "required":[ "JobId", "JobStatus", "SubmitTime" ], "members":{ "JobId":{ "shape":"DataTransformationJobId", "documentation":"

The unique identifier of the job.

" }, "JobStatus":{ "shape":"TransformationJobStatus", "documentation":"

The current status of the job.

" }, "SubmitTime":{ "shape":"DateTime", "documentation":"

The timestamp when the job was submitted.

" }, "JobName":{ "shape":"DataTransformationJobName", "documentation":"

The name of the job.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The timestamp when the job completed.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format for this job.

" } }, "documentation":"

Contains summary information about a data transformation job. To retrieve full job details, call DescribeDataTransformationJob.

" }, "TransformationJobSummaryList":{ "type":"list", "member":{"shape":"TransformationJobSummary"} }, "TransformationOutputDataConfig":{ "type":"structure", "required":["S3Configuration"], "members":{ "S3Configuration":{ "shape":"DataTransformationS3Configuration", "documentation":"

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

" } }, "documentation":"

The Amazon S3 output location and encryption configuration for a transformation job.

" }, "UnauthorizedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.

", "exception":true }, "UnsupportedMIMETypeException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

The content type in your request is not supported. Use a supported content type for this operation.

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the data store from which tags are being removed.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The keys for the tags to be removed from the data store.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateDataTransformationProfileRequest":{ "type":"structure", "required":[ "ProfileId", "ProfileMapping" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile to update.

" }, "ProfileMapping":{ "shape":"ProfileMapping", "documentation":"

The new profile content for the DRAFT version. This is a full replacement of all profile files.

" }, "ChangeDescription":{ "shape":"ChangeDescription", "documentation":"

A description of what changed in this update.

" } }, "documentation":"

The request parameters for the UpdateDataTransformationProfile operation.

" }, "UpdateDataTransformationProfileResponse":{ "type":"structure", "required":[ "ProfileId", "SourceFormat", "TargetFormat", "LastUpdatedAt" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the updated profile.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format of the profile.

" }, "TargetFormat":{ "shape":"TargetFormat", "documentation":"

The target output format of the profile.

" }, "ProfileName":{ "shape":"ProfileNameString", "documentation":"

The name of the updated profile.

" }, "LastUpdatedAt":{ "shape":"DateTime", "documentation":"

The timestamp when the profile was last updated.

" } }, "documentation":"

The response from the UpdateDataTransformationProfile operation.

" }, "UpdateFHIRDatastoreRequest":{ "type":"structure", "required":["DatastoreId"], "members":{ "DatastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "DatastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name.

" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfiguration", "documentation":"

The analytics configuration for the data store.

" }, "NlpConfiguration":{ "shape":"NlpConfiguration", "documentation":"

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

" }, "ProfileConfiguration":{ "shape":"ProfileConfiguration", "documentation":"

The profile configuration for the data store.

" }, "IdentityProviderConfiguration":{ "shape":"IdentityProviderConfiguration", "documentation":"

The identity provider configuration for the data store.

" } } }, "UpdateFHIRDatastoreResponse":{ "type":"structure", "required":["DatastoreProperties"], "members":{ "DatastoreProperties":{ "shape":"DatastoreProperties", "documentation":"

The data store properties.

" } } }, "UpdateProfileWithAgentRequest":{ "type":"structure", "required":[ "ProfileId", "SourceFormat", "InputMessage" ], "members":{ "ProfileId":{ "shape":"ProfileIdString", "documentation":"

The unique identifier of the profile to update via the agent.

" }, "SourceFormat":{ "shape":"SourceFormat", "documentation":"

The source data format for the transformation.

" }, "InputMessage":{ "shape":"AgentInputMessage", "documentation":"

The message to send to the agent.

" }, "ConversationId":{ "shape":"ConversationIdString", "documentation":"

The conversation identifier for multi-turn interactions. Omit to start a new conversation.

" } }, "documentation":"

The request parameters for the UpdateProfileWithAgent operation.

" }, "UpdateProfileWithAgentResponse":{ "type":"structure", "required":[ "AgentResponse", "ConversationId" ], "members":{ "AgentResponse":{ "shape":"AgentOutputMessage", "documentation":"

The response message from the agent.

" }, "ConversationId":{ "shape":"ConversationIdString", "documentation":"

The conversation identifier to use for follow-up messages in this conversation.

" } }, "documentation":"

The response from the UpdateProfileWithAgent operation.

" }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"HealthLakeString"} }, "documentation":"

The user input parameter was invalid.

", "exception":true }, "ValidationLevel":{ "type":"string", "documentation":"

The level of FHIR validation to apply.

", "enum":[ "strict", "structure-only", "minimal" ] } }, "documentation":"

This is the AWS HealthLake API Reference. For an introduction to the service, see What is AWS HealthLake? in the AWS HealthLake Developer Guide.

" }