HealthLake / Client / create_data_transformation_profile

create_data_transformation_profile

HealthLake.Client.create_data_transformation_profile(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_data_transformation_profile(
    SourceFormat='CCDA'|'CSV',
    Source={
        'StarterProfile': {
            'StarterProfileName': 'string'
        },
        'ExistingVersionedProfileId': {
            'ProfileId': 'string',
            'Version': 123
        },
        'ProfileMapping': {
            'ProfileMapping': {
                'string': 'string'
            }
        },
        'SampleData': {
            'S3Uri': 'string'
        }
    },
    KmsKeyId='string',
    ProfileDescription='string',
    ProfileName='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

Parameters:

• SourceFormat (string) –

  [REQUIRED]

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

• Source (dict) –

  [REQUIRED]

  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.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: StarterProfile, ExistingVersionedProfileId, ProfileMapping, SampleData.

  • StarterProfile (dict) –

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

    • StarterProfileName (string) – [REQUIRED]

      The name of the built-in starter profile.

  • ExistingVersionedProfileId (dict) –

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

    • ProfileId (string) – [REQUIRED]

      The unique identifier of the existing profile to clone from.

    • Version (integer) – [REQUIRED]

      The version number of the existing profile to clone from.

  • ProfileMapping (dict) –

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

    • ProfileMapping (dict) – [REQUIRED]

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

      • (string) –

        • (string) –

  • SampleData (dict) –

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

    • S3Uri (string) – [REQUIRED]

      The Amazon S3 URI of the sample data file.

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

• ProfileDescription (string) – A human-readable description of the profile’s purpose.

• ProfileName (string) –

  [REQUIRED]

  A name for the data transformation profile.

• Tags (dict) –

  The tags to associate with the profile at creation time.

  • (string) –

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

    • (string) –

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

• ClientToken (string) –

  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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileId': 'string',
    'Version': 123,
    'SourceFormat': 'CCDA'|'CSV',
    'TargetFormat': 'FHIR_R4',
    'ProfileName': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  The response from the CreateDataTransformationProfile operation.

  • ProfileId (string) –

    The unique identifier of the created profile.

  • Version (integer) –

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

  • SourceFormat (string) –

    The source data format of the profile.

  • TargetFormat (string) –

    The target output format. Always FHIR_R4.

  • ProfileName (string) –

    The name of the created profile.

  • LastUpdatedAt (datetime) –

    The timestamp when the profile was last updated.

Exceptions

• HealthLake.Client.exceptions.ServiceQuotaExceededException

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.AccessDeniedException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ConflictException

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.InternalServerException