AWS HealthLake Healthlake Data Transformation Profile API

openapi: 3.2.0
info:
  title: Amazon HealthLake Data Transformation Profile API
  version: '2017-07-01'
  description: Generated from AWS's published Smithy model for Amazon HealthLake. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://healthlake.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Transformation Profile
paths:
  /#CreateDataTransformationProfile:
    post:
      operationId: CreateDataTransformationProfile
      summary: Create Data Transformation Profile
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateDataTransformationProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ServiceQuotaExceededException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.CreateDataTransformationProfile
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateDataTransformationProfileRequest'
      tags:
      - Data Transformation Profile
  /#DeleteDataTransformationProfile:
    post:
      operationId: DeleteDataTransformationProfile
      summary: Delete Data Transformation Profile
      description: Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteDataTransformationProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.DeleteDataTransformationProfile
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteDataTransformationProfileRequest'
      tags:
      - Data Transformation Profile
  /#GetDataTransformationProfile:
    post:
      operationId: GetDataTransformationProfile
      summary: Get Data Transformation Profile
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetDataTransformationProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.GetDataTransformationProfile
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetDataTransformationProfileRequest'
      tags:
      - Data Transformation Profile
  /#ListDataTransformationProfiles:
    post:
      operationId: ListDataTransformationProfiles
      summary: List Data Transformation Profiles
      description: Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListDataTransformationProfilesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.ListDataTransformationProfiles
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListDataTransformationProfilesRequest'
      tags:
      - Data Transformation Profile
  /#UpdateDataTransformationProfile:
    post:
      operationId: UpdateDataTransformationProfile
      summary: Update Data Transformation Profile
      description: Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateDataTransformationProfileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.UpdateDataTransformationProfile
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateDataTransformationProfileRequest'
      tags:
      - Data Transformation Profile
components:
  schemas:
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the error.
    UpdateDataTransformationProfileResponse:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the updated profile.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format of the profile.
        TargetFormat:
          type: string
          enum:
          - FHIR_R4
          description: The target output format of the profile.
        ProfileName:
          type: string
          description: The name of the updated profile.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the profile was last updated.
      required:
      - ProfileId
      - SourceFormat
      - TargetFormat
      - LastUpdatedAt
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    DataTransformationProfileSummary:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the profile.
        Version:
          type: integer
          description: The latest version number of the profile.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format that this profile converts from.
        TargetFormat:
          type: string
          enum:
          - FHIR_R4
          description: The target output format of the profile.
        ProfileName:
          type: string
          description: The name of the profile.
        ProfileDescription:
          type: string
          description: A description of the profile's purpose.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the profile was last updated.
      required:
      - ProfileId
      - Version
      - SourceFormat
      - TargetFormat
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    SampleDataSource:
      type: object
      properties:
        S3Uri:
          type: string
          description: The Amazon S3 URI of the sample data file.
      required:
      - S3Uri
    DeleteDataTransformationProfileRequest:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the profile to delete.
      required:
      - ProfileId
    DeleteDataTransformationProfileResponse:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the deleted profile.
        ProfileName:
          type: string
          description: The name of the deleted profile.
        DeletionTime:
          type: string
          format: date-time
          description: The timestamp when the profile was deleted.
      required:
      - ProfileId
      - DeletionTime
    CreateDataTransformationProfileSource:
      type: object
      properties:
        StarterProfile:
          $ref: '#/components/schemas/StarterProfileSource'
        ExistingVersionedProfileId:
          $ref: '#/components/schemas/ExistingVersionedProfileSource'
        ProfileMapping:
          $ref: '#/components/schemas/ProfileMappingSource'
        SampleData:
          $ref: '#/components/schemas/SampleDataSource'
      description: Exactly one member is set.
    CreateDataTransformationProfileResponse:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the created profile.
        Version:
          type: integer
          description: The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format of the profile.
        TargetFormat:
          type: string
          enum:
          - FHIR_R4
          description: The target output format. Always FHIR_R4.
        ProfileName:
          type: string
          description: The name of the created profile.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when the profile was last updated.
      required:
      - ProfileId
      - Version
      - SourceFormat
      - TargetFormat
      - ProfileName
      - LastUpdatedAt
    CreateDataTransformationProfileRequest:
      type: object
      properties:
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).
        Source:
          $ref: '#/components/schemas/CreateDataTransformationProfileSource'
        KmsKeyId:
          type: string
          description: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key identifier used to encrypt the profile content at rest.
        ProfileDescription:
          type: string
          description: A human-readable description of the profile's purpose.
        ProfileName:
          type: string
          description: A name for the data transformation profile.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to associate with the profile at creation time.
        ClientToken:
          type: string
          description: 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.
      required:
      - SourceFormat
      - Source
      - ProfileName
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    ExistingVersionedProfileSource:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the existing profile to clone from.
        Version:
          type: integer
          description: The version number of the existing profile to clone from.
      required:
      - ProfileId
      - Version
    UpdateDataTransformationProfileRequest:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the profile to update.
        ProfileMapping:
          type: object
          additionalProperties:
            type: string
          description: The new profile content for the DRAFT version. This is a full replacement of all profile files.
        ChangeDescription:
          type: string
          description: A description of what changed in this update.
      required:
      - ProfileId
      - ProfileMapping
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListDataTransformationProfilesResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/DataTransformationProfileSummary'
          description: The list of data transformation profile summaries.
        NextToken:
          type: string
          description: The pagination token to use in the next request. If this value is null, there are no more results.
      required:
      - Items
    GetDataTransformationProfileRequest:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the profile to retrieve.
        ProfileVersion:
          type: integer
          description: The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.
      required:
      - ProfileId
    ProfileMappingSource:
      type: object
      properties:
        ProfileMapping:
          type: object
          additionalProperties:
            type: string
          description: The content as a map of file paths to profile strings.
      required:
      - ProfileMapping
    StarterProfileSource:
      type: object
      properties:
        StarterProfileName:
          type: string
          description: The name of the built-in starter profile.
      required:
      - StarterProfileName
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ListDataTransformationProfilesRequest:
      type: object
      properties:
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: Filters the results by source data format.
        MaxResults:
          type: integer
          description: The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.
        NextToken:
          type: string
          description: The pagination token from a previous response. Pass this value to retrieve the next page of results.
      required:
      - SourceFormat
    GetDataTransformationProfileResponse:
      type: object
      properties:
        ProfileId:
          type: string
          description: The unique identifier of the profile.
        Version:
          type: integer
          description: The version number of the retrieved profile.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format of the profile.
        TargetFormat:
          type: string
          enum:
          - FHIR_R4
          description: The target output format of the profile.
        ProfileMapping:
          type: object
          additionalProperties:
            type: string
          description: The profile content as a map of file paths to content strings.
        ProfileName:
          type: string
          description: The name of the profile.
        ProfileDescription:
          type: string
          description: The description of the profile.
        ChangeDescription:
          type: string
          description: A description of what changed in this version.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp when this version was last updated.
      required:
      - ProfileId
      - Version
      - SourceFormat
      - TargetFormat
      - ProfileMapping
      - LastUpdatedAt
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: healthlake
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/healthlake/service/2017-07-01/healthlake-2017-07-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)