Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDataTransformationProfile

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.

Request Syntax


{
   "ProfileId": "string",
   "ProfileVersion": number
}

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.

ProfileId

The unique identifier of the profile to retrieve.

Type: String

Length Constraints: Fixed length of 32.

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

Required: Yes

ProfileVersion

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

Type: Integer

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

Required: No

Response Syntax


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

ChangeDescription

A description of what changed in this version.

Type: String

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

LastUpdatedAt

The timestamp when this version was last updated.

Type: Timestamp

ProfileDescription

The description of the profile.

Type: String

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

ProfileId

The unique identifier of the profile.

Type: String

Length Constraints: Fixed length of 32.

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

ProfileMapping

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

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.

ProfileName

The name of the 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 version number of the retrieved profile.

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

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