Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDataTransformationProfile

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.

Request Syntax


{
   "ClientToken": "string",
   "KmsKeyId": "string",
   "ProfileDescription": "string",
   "ProfileName": "string",
   "Source": { ... },
   "SourceFormat": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: No

KmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ProfileDescription

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

ProfileName

A name for the data transformation profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Source

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.

Type: CreateDataTransformationProfileSource object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

SourceFormat

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

Type: String

Valid Values: CCDA | CSV

Required: Yes

Tags

The tags to associate with the profile at creation time.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


{
   "LastUpdatedAt": number,
   "ProfileId": "string",
   "ProfileName": "string",
   "SourceFormat": "string",
   "TargetFormat": "string",
   "Version": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LastUpdatedAt

The timestamp when the profile was last updated.

Type: Timestamp

ProfileId

The unique identifier of the created profile.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [a-f0-9]{32}

ProfileName

The name of the created profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

SourceFormat

The source data format of the profile.

Type: String

Valid Values: CCDA | CSV

TargetFormat

The target output format. Always FHIR_R4.

Type: String

Valid Values: FHIR_R4

Version

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 99.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

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

HTTP Status Code: 400

InternalServerException

An unknown internal error occurred in the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested data store was not found.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeds the service quota.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400