Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PublishDataTransformationProfile

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.

Request Syntax


{
   "ChangeDescription": "string",
   "FromExistingVersion": number,
   "ProfileId": "string",
   "SourceFormat": "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 or why this version is being published.

Type: String

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

Required: No

FromExistingVersion

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.

Type: Integer

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

Required: No

ProfileId

The unique identifier of the profile to publish.

Type: String

Length Constraints: Fixed length of 32.

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

Required: Yes

SourceFormat

The source data format of the profile.

Type: String

Valid Values: CCDA | CSV

Required: Yes

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

Type: String

Length Constraints: Fixed length of 32.

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

ProfileName

The name of the published 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

Version

The new version number that was created.

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

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