Amazon HealthLake

2025/08/28 - Amazon HealthLake - 3 updated api methods

Changes  Add ValidationLevel parameter to StartFHIRImportJob API, allowing users to specify a FHIR validation level for their asynchronous import jobs.

DescribeFHIRImportJob (updated) Link ¶
Changes (response) 
{'ImportJobProperties': {'ValidationLevel': 'strict | structure-only | '
                                            'minimal'}}

Get the import job properties to learn more about the job or job progress.

See also: AWS API Documentation

Request Syntax

client.describe_fhir_import_job(
    DatastoreId='string',
    JobId='string'
)
type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The data store identifier.

type JobId:

string

param JobId:

[REQUIRED]

The import job identifier.

rtype:

dict

returns:

Response Syntax

{
    'ImportJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'DatastoreId': 'string',
        'InputDataConfig': {
            'S3Uri': 'string'
        },
        'JobOutputDataConfig': {
            'S3Configuration': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            }
        },
        'JobProgressReport': {
            'TotalNumberOfScannedFiles': 123,
            'TotalSizeOfScannedFilesInMB': 123.0,
            'TotalNumberOfImportedFiles': 123,
            'TotalNumberOfResourcesScanned': 123,
            'TotalNumberOfResourcesImported': 123,
            'TotalNumberOfResourcesWithCustomerError': 123,
            'TotalNumberOfFilesReadWithCustomerError': 123,
            'Throughput': 123.0
        },
        'DataAccessRoleArn': 'string',
        'Message': 'string',
        'ValidationLevel': 'strict'|'structure-only'|'minimal'
    }
}

Response Structure

  • (dict) --

    • ImportJobProperties (dict) --

      The import job properties.

      • JobId (string) --

        The import job identifier.

      • JobName (string) --

        The import job name.

      • JobStatus (string) --

        The import job status.

      • SubmitTime (datetime) --

        The time the import job was submitted for processing.

      • EndTime (datetime) --

        The time the import job was completed.

      • DatastoreId (string) --

        The data store identifier.

      • InputDataConfig (dict) --

        The input data configuration supplied when the import job was created.

        • S3Uri (string) --

          The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

      • JobOutputDataConfig (dict) --

        The output data configuration supplied when the export job was created.

        • S3Configuration (dict) --

          The output data configuration supplied when the export job was created.

          • S3Uri (string) --

            The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

          • KmsKeyId (string) --

            The Key Management Service (KMS) key ID used to access the S3 bucket.

      • JobProgressReport (dict) --

        Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.

        • TotalNumberOfScannedFiles (integer) --

          The number of files scanned from the S3 input bucket.

        • TotalSizeOfScannedFilesInMB (float) --

          The size (in MB) of files scanned from the S3 input bucket.

        • TotalNumberOfImportedFiles (integer) --

          The number of files imported.

        • TotalNumberOfResourcesScanned (integer) --

          The number of resources scanned from the S3 input bucket.

        • TotalNumberOfResourcesImported (integer) --

          The number of resources imported.

        • TotalNumberOfResourcesWithCustomerError (integer) --

          The number of resources that failed due to customer error.

        • TotalNumberOfFilesReadWithCustomerError (integer) --

          The number of files that failed to be read from the S3 input bucket due to customer error.

        • Throughput (float) --

          The transaction rate the import job is processed at.

      • DataAccessRoleArn (string) --

        The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.

      • Message (string) --

        An explanation of any errors that might have occurred during the FHIR import job.

      • ValidationLevel (string) --

        The validation level of the import job.

ListFHIRImportJobs (updated) Link ¶
Changes (response) 
{'ImportJobPropertiesList': {'ValidationLevel': 'strict | structure-only | '
                                                'minimal'}}

List all FHIR import jobs associated with an account and their statuses.

See also: AWS API Documentation

Request Syntax

client.list_fhir_import_jobs(
    DatastoreId='string',
    NextToken='string',
    MaxResults=123,
    JobName='string',
    JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
    SubmittedBefore=datetime(2015, 1, 1),
    SubmittedAfter=datetime(2015, 1, 1)
)
type DatastoreId:

string

param DatastoreId:

[REQUIRED]

Limits the response to the import job with the specified data store ID.

type NextToken:

string

param NextToken:

The pagination token used to identify the next page of results to return.

type MaxResults:

integer

param MaxResults:

Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.

type JobName:

string

param JobName:

Limits the response to the import job with the specified job name.

type JobStatus:

string

param JobStatus:

Limits the response to the import job with the specified job status.

type SubmittedBefore:

datetime

param SubmittedBefore:

Limits the response to FHIR import jobs submitted before a user- specified date.

type SubmittedAfter:

datetime

param SubmittedAfter:

Limits the response to FHIR import jobs submitted after a user-specified date.

rtype:

dict

returns:

Response Syntax

{
    'ImportJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'DatastoreId': 'string',
            'InputDataConfig': {
                'S3Uri': 'string'
            },
            'JobOutputDataConfig': {
                'S3Configuration': {
                    'S3Uri': 'string',
                    'KmsKeyId': 'string'
                }
            },
            'JobProgressReport': {
                'TotalNumberOfScannedFiles': 123,
                'TotalSizeOfScannedFilesInMB': 123.0,
                'TotalNumberOfImportedFiles': 123,
                'TotalNumberOfResourcesScanned': 123,
                'TotalNumberOfResourcesImported': 123,
                'TotalNumberOfResourcesWithCustomerError': 123,
                'TotalNumberOfFilesReadWithCustomerError': 123,
                'Throughput': 123.0
            },
            'DataAccessRoleArn': 'string',
            'Message': 'string',
            'ValidationLevel': 'strict'|'structure-only'|'minimal'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ImportJobPropertiesList (list) --

      The properties for listed import jobs.

      • (dict) --

        The import job properties.

        • JobId (string) --

          The import job identifier.

        • JobName (string) --

          The import job name.

        • JobStatus (string) --

          The import job status.

        • SubmitTime (datetime) --

          The time the import job was submitted for processing.

        • EndTime (datetime) --

          The time the import job was completed.

        • DatastoreId (string) --

          The data store identifier.

        • InputDataConfig (dict) --

          The input data configuration supplied when the import job was created.

          • S3Uri (string) --

            The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

        • JobOutputDataConfig (dict) --

          The output data configuration supplied when the export job was created.

          • S3Configuration (dict) --

            The output data configuration supplied when the export job was created.

            • S3Uri (string) --

              The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

            • KmsKeyId (string) --

              The Key Management Service (KMS) key ID used to access the S3 bucket.

        • JobProgressReport (dict) --

          Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.

          • TotalNumberOfScannedFiles (integer) --

            The number of files scanned from the S3 input bucket.

          • TotalSizeOfScannedFilesInMB (float) --

            The size (in MB) of files scanned from the S3 input bucket.

          • TotalNumberOfImportedFiles (integer) --

            The number of files imported.

          • TotalNumberOfResourcesScanned (integer) --

            The number of resources scanned from the S3 input bucket.

          • TotalNumberOfResourcesImported (integer) --

            The number of resources imported.

          • TotalNumberOfResourcesWithCustomerError (integer) --

            The number of resources that failed due to customer error.

          • TotalNumberOfFilesReadWithCustomerError (integer) --

            The number of files that failed to be read from the S3 input bucket due to customer error.

          • Throughput (float) --

            The transaction rate the import job is processed at.

        • DataAccessRoleArn (string) --

          The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.

        • Message (string) --

          An explanation of any errors that might have occurred during the FHIR import job.

        • ValidationLevel (string) --

          The validation level of the import job.

    • NextToken (string) --

      The pagination token used to identify the next page of results to return.

StartFHIRImportJob (updated) Link ¶
Changes (request) 
{'ValidationLevel': 'strict | structure-only | minimal'}

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

See also: AWS API Documentation

Request Syntax

client.start_fhir_import_job(
    JobName='string',
    InputDataConfig={
        'S3Uri': 'string'
    },
    JobOutputDataConfig={
        'S3Configuration': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        }
    },
    DatastoreId='string',
    DataAccessRoleArn='string',
    ClientToken='string',
    ValidationLevel='strict'|'structure-only'|'minimal'
)
type JobName:

string

param JobName:

The import job name.

type InputDataConfig:

dict

param InputDataConfig:

[REQUIRED]

The input properties for the import job request.

  • S3Uri (string) --

    The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

type JobOutputDataConfig:

dict

param JobOutputDataConfig:

[REQUIRED]

The output data configuration supplied when the export job was created.

  • S3Configuration (dict) --

    The output data configuration supplied when the export job was created.

    • S3Uri (string) -- [REQUIRED]

      The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

    • KmsKeyId (string) -- [REQUIRED]

      The Key Management Service (KMS) key ID used to access the S3 bucket.

type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The data store identifier.

type DataAccessRoleArn:

string

param DataAccessRoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

type ClientToken:

string

param ClientToken:

The optional user-provided token used for ensuring API idempotency.

This field is autopopulated if not provided.

type ValidationLevel:

string

param ValidationLevel:

The validation level of the import job.

rtype:

dict

returns:

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
    'DatastoreId': 'string'
}

Response Structure

  • (dict) --

    • JobId (string) --

      The import job identifier.

    • JobStatus (string) --

      The import job status.

    • DatastoreId (string) --

      The data store identifier.