Amazon HealthLake

{'ProvenanceEnabled': 'boolean'}

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',
    ProfileId='string',
    InputFormat='string',
    DriftDetectionEnabled=True|False,
    ProvenanceEnabled=True|False
)

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.

type ProfileId:

string

param ProfileId:

A bounded-length string value.

type InputFormat:

string

param InputFormat:

A bounded-length string value.

type DriftDetectionEnabled:

boolean

param DriftDetectionEnabled:

A boolean value.

type ProvenanceEnabled:

boolean

param ProvenanceEnabled:

Specifies whether to enable provenance for 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.