Healthlake
This page documents function available when using the Healthlake module, created with @service Healthlake.
Index
Main.Healthlake.create_fhirdatastoreMain.Healthlake.delete_fhirdatastoreMain.Healthlake.describe_fhirdatastoreMain.Healthlake.describe_fhirexport_jobMain.Healthlake.describe_fhirimport_jobMain.Healthlake.list_fhirdatastoresMain.Healthlake.list_fhirexport_jobsMain.Healthlake.list_fhirimport_jobsMain.Healthlake.list_tags_for_resourceMain.Healthlake.start_fhirexport_jobMain.Healthlake.start_fhirimport_jobMain.Healthlake.tag_resourceMain.Healthlake.untag_resource
Documentation
Main.Healthlake.create_fhirdatastore — Methodcreate_fhirdatastore(datastore_type_version)
create_fhirdatastore(datastore_type_version, params::Dict{String,<:Any})Creates a Data Store that can ingest and export FHIR formatted data.
Arguments
datastore_type_version: The FHIR version of the Data Store. The only supported version is R4.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Optional user provided token used for ensuring idempotency."DatastoreName": The user generated name for the Data Store."IdentityProviderConfiguration": The configuration of the identity provider that you want to use for your Data Store."PreloadDataConfig": Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea."SseConfiguration": The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store."Tags": Resource tags that are applied to a Data Store when it is created.
Main.Healthlake.delete_fhirdatastore — Methoddelete_fhirdatastore(datastore_id)
delete_fhirdatastore(datastore_id, params::Dict{String,<:Any})Deletes a Data Store.
Arguments
datastore_id: The AWS-generated ID for the Data Store to be deleted.
Main.Healthlake.describe_fhirdatastore — Methoddescribe_fhirdatastore(datastore_id)
describe_fhirdatastore(datastore_id, params::Dict{String,<:Any})Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
Arguments
datastore_id: The AWS-generated Data Store ID.
Main.Healthlake.describe_fhirexport_job — Methoddescribe_fhirexport_job(datastore_id, job_id)
describe_fhirexport_job(datastore_id, job_id, params::Dict{String,<:Any})Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Arguments
datastore_id: The AWS generated ID for the Data Store from which files are being exported from for an export job.job_id: The AWS generated ID for an export job.
Main.Healthlake.describe_fhirimport_job — Methoddescribe_fhirimport_job(datastore_id, job_id)
describe_fhirimport_job(datastore_id, job_id, params::Dict{String,<:Any})Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
Arguments
datastore_id: The AWS-generated ID of the Data Store.job_id: The AWS-generated job ID.
Main.Healthlake.list_fhirdatastores — Methodlist_fhirdatastores()
list_fhirdatastores(params::Dict{String,<:Any})Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filter": Lists all filters associated with a FHIR Data Store request."MaxResults": The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call."NextToken": Fetches the next page of Data Stores when results are paginated.
Main.Healthlake.list_fhirexport_jobs — Methodlist_fhirexport_jobs(datastore_id)
list_fhirexport_jobs(datastore_id, params::Dict{String,<:Any})Lists all FHIR export jobs associated with an account and their statuses.
Arguments
datastore_id: This parameter limits the response to the export job with the specified Data Store ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"JobName": This parameter limits the response to the export job with the specified job name."JobStatus": This parameter limits the response to the export jobs with the specified job status."MaxResults": This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user."NextToken": A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query."SubmittedAfter": This parameter limits the response to FHIR export jobs submitted after a user specified date."SubmittedBefore": This parameter limits the response to FHIR export jobs submitted before a user specified date.
Main.Healthlake.list_fhirimport_jobs — Methodlist_fhirimport_jobs(datastore_id)
list_fhirimport_jobs(datastore_id, params::Dict{String,<:Any})Lists all FHIR import jobs associated with an account and their statuses.
Arguments
datastore_id: This parameter limits the response to the import job with the specified Data Store ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"JobName": This parameter limits the response to the import job with the specified job name."JobStatus": This parameter limits the response to the import job with the specified job status."MaxResults": This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user."NextToken": A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query."SubmittedAfter": This parameter limits the response to FHIR import jobs submitted after a user specified date."SubmittedBefore": This parameter limits the response to FHIR import jobs submitted before a user specified date.
Main.Healthlake.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Returns a list of all existing tags associated with a Data Store.
Arguments
resource_arn: The Amazon Resource Name(ARN) of the Data Store for which tags are being added.
Main.Healthlake.start_fhirexport_job — Methodstart_fhirexport_job(client_token, data_access_role_arn, datastore_id, output_data_config)
start_fhirexport_job(client_token, data_access_role_arn, datastore_id, output_data_config, params::Dict{String,<:Any})Begins a FHIR export job.
Arguments
client_token: An optional user provided token used for ensuring idempotency.data_access_role_arn: The Amazon Resource Name used during the initiation of the job.datastore_id: The AWS generated ID for the Data Store from which files are being exported for an export job.output_data_config: The output data configuration that was supplied when the export job was created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"JobName": The user generated name for an export job.
Main.Healthlake.start_fhirimport_job — Methodstart_fhirimport_job(client_token, data_access_role_arn, datastore_id, input_data_config, job_output_data_config)
start_fhirimport_job(client_token, data_access_role_arn, datastore_id, input_data_config, job_output_data_config, params::Dict{String,<:Any})Begins a FHIR Import job.
Arguments
client_token: Optional user provided token used for ensuring idempotency.data_access_role_arn: The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.datastore_id: The AWS-generated Data Store ID.input_data_config: The input properties of the FHIR Import job in the StartFHIRImport job request.job_output_data_config:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"JobName": The name of the FHIR Import job in the StartFHIRImport job request.
Main.Healthlake.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds a user specified key and value tag to a Data Store.
Arguments
resource_arn: The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to.tags: The user specified key and value pair tags being added to a Data Store.
Main.Healthlake.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from a Data Store.
Arguments
resource_arn: "The Amazon Resource Name(ARN) of the Data Store for which tags are being removedtag_keys: The keys for the tags to be removed from the Healthlake Data Store.