Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateDataTransformationProfile

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

Request Syntax


{
   "ChangeDescription": "string",
   "ProfileId": "string",
   "ProfileMapping": { 
      "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.

ChangeDescription

A description of what changed in this update.

Type: String

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

Required: No

ProfileId

The unique identifier of the profile to update.

Type: String

Length Constraints: Fixed length of 32.

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

Required: Yes

ProfileMapping

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

Type: String to string map

Map Entries: Maximum number of 500 items.

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

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

Required: Yes

Response Syntax


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

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 updated profile.

Type: String

Length Constraints: Fixed length of 32.

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

ProfileName

The name of the updated 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 of the profile.

Type: String

Valid Values: FHIR_R4

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

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

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