翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# を使用した FHIR データのエクスポート AWS HealthLake
ネイティブ AWS HealthLake アクションを使用して、FHIR エクスポートジョブを開始、説明、一覧表示します。エクスポートジョブをキューに入れることができます。非同期エクスポートジョブは FIFO (先入れ先出し) 方式で処理されます。エクスポートジョブを開始するのと同じ方法でジョブをキューに入れることができます。進行中であれば、キューに入れられます。エクスポートジョブの進行中に FHIR リソースを作成、読み取り、更新、または削除できます。
**注記**
FHIR R4 `$export`オペレーションを使用して HealthLake データストアから FHIR データをエクスポートすることもできます。詳細については、「[FHIR を使用した HealthLake データのエクスポート `$export`](reference-fhir-operations-export.md)」を参照してください。
**Topics**
+ [エクスポートジョブの開始](exporting-fhir-data-start.md)
+ [エクスポートジョブのプロパティの取得](exporting-fhir-data-describe.md)
+ [エクスポートジョブの一覧表示](exporting-fhir-data-list.md)
# FHIR エクスポートジョブの開始
`StartFHIRExportJob` を使用して HealthLake データストアから FHIR エクスポートジョブを開始します。次のメニューでは、 の手順と、 AWS マネジメントコンソール および AWS CLI AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_StartFHIRExportJob.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_StartFHIRExportJob.html)」を参照してください。
**メモ**
HealthLake は、医療データ交換の [FHIR R4 仕様](https://hl7.org/fhir/R4/index.html)をサポートしています。したがって、すべてのヘルスデータは FHIR R4 形式でエクスポートされます。
**FHIR エクスポートジョブを開始するには**
アクセス設定に基づいてメニューを選択します AWS HealthLake。
## AWS CLI および SDKs
------
#### [ CLI ]
**AWS CLI**
**FHIR エクスポートジョブを開始するには**
次の`start-fhir-export-job`例は、 AWS HealthLake を使用して FHIR エクスポートジョブを開始する方法を示しています。
```
aws healthlake start-fhir-export-job \
--output-data-config '{"S3Configuration": {"S3Uri":"s3://(Bucket Name)/(Prefix Name)/","KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"}}' \
--datastore-id (Data store ID) \
--data-access-role-arn arn:aws:iam::(AWS Account ID):role/(Role Name)
```
出力:
```
{
"DatastoreId": "(Data store ID)",
"JobStatus": "SUBMITTED",
"JobId": "9b9a51943afaedd0a8c0c26c49135a31"
}
```
詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアからのファイルエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[StartFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-export-job.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def start_fhir_export_job(
self,
job_name: str,
datastore_id: str,
output_s3_uri: str,
kms_key_id: str,
data_access_role_arn: str,
) -> dict[str, str]:
"""
Starts a HealthLake export job.
:param job_name: The export job name.
:param datastore_id: The data store ID.
:param output_s3_uri: The output S3 URI.
:param kms_key_id: The KMS key ID associated with the output S3 bucket.
:param data_access_role_arn: The data access role ARN.
:return: The export job.
"""
try:
response = self.health_lake_client.start_fhir_export_job(
OutputDataConfig={
"S3Configuration": {"S3Uri": output_s3_uri, "KmsKeyId": kms_key_id}
},
DataAccessRoleArn=data_access_role_arn,
DatastoreId=datastore_id,
JobName=job_name,
)
return response
except ClientError as err:
logger.exception(
"Couldn't start export job. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[StartFHIRExportJob](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/StartFHIRExportJob)」を参照してください。
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples)での設定と実行の方法を確認してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples)での設定と実行の方法を確認してください。
```
TRY.
" iv_job_name = 'MyExportJob'
" iv_output_s3_uri = 's3://my-bucket/export/output/'
" iv_kms_key_id = 'arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012'
" iv_data_access_role_arn = 'arn:aws:iam::123456789012:role/HealthLakeExportRole'
oo_result = lo_hll->startfhirexportjob(
iv_jobname = iv_job_name
io_outputdataconfig = NEW /aws1/cl_hlloutputdataconfig(
io_s3configuration = NEW /aws1/cl_hlls3configuration(
iv_s3uri = iv_output_s3_uri
iv_kmskeyid = iv_kms_key_id
)
)
iv_dataaccessrolearn = iv_data_access_role_arn
iv_datastoreid = iv_datastore_id
).
DATA(lv_job_id) = oo_result->get_jobid( ).
MESSAGE |Export job started with ID { lv_job_id }.| TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllthrottlingex INTO DATA(lo_throttling_ex).
lv_error = |Throttling error: { lo_throttling_ex->av_err_code }-{ lo_throttling_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_throttling_ex.
CATCH /aws1/cx_hllaccessdeniedex INTO DATA(lo_access_ex).
lv_error = |Access denied: { lo_access_ex->av_err_code }-{ lo_access_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_access_ex.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[StartFHIRExportJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
**可用性の例**
必要なものが見つからなかった場合。このページの右側サイドバーにある**フィードバックを提供する**リンクを使用して、コード例をリクエストします。
## AWS コンソール
1. HealthLake コンソール[のデータストア](https://console.aws.amazon.com/healthlake/home#/list-datastores)ページにサインインします。
1. データストアを選択します。
1. **[エクスポート]** を選択します。
**エクスポート**ページが開きます。
1. **出力データ**セクションで、次の情報を入力します。
+ **Amazon S3 の出力データの場所**
+ **出力の暗号化**
1. **アクセス許可**セクションで、**既存の IAM サービスロールを使用する** を選択し、ロール**名メニューからロール**を選択するか**、IAM ロールの作成**を選択します。
1. **[エクスポートの開始]** を選択します。
**注記**
エクスポート中に、ページ上部のバナーで**ジョブ ID をコピー**を選択します。を使用してエクスポートジョブのプロパティを[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRExportJob.html#HealthLake-DescribeFHIRExportJob-request-JobId](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRExportJob.html#HealthLake-DescribeFHIRExportJob-request-JobId)リクエストできます AWS CLI。詳細については、「[FHIR エクスポートジョブのプロパティの取得](exporting-fhir-data-describe.md)」を参照してください。
# FHIR エクスポートジョブのプロパティの取得
を使用して`DescribeFHIRExportJob`、HealthLake データストアからエクスポートジョブのプロパティを取得します。以下のメニューでは、 の手順と、 AWS マネジメントコンソール および AWS CLI AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRExportJob.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRExportJob.html)」を参照してください。
**メモ**
HealthLake は、医療データ交換の [FHIR R4 仕様](https://hl7.org/fhir/R4/index.html)をサポートしています。したがって、すべてのヘルスデータは FHIR R4 形式でエクスポートされます。
**FHIR エクスポートジョブを記述するには**
アクセス設定に基づいてメニューを選択します AWS HealthLake。
## AWS CLI および SDKs
------
#### [ CLI ]
**AWS CLI**
**FHIR エクスポートジョブを記述するには**
次の`describe-fhir-export-job`例は、 AWS HealthLake で FHIR エクスポートジョブのプロパティを検索する方法を示しています。
```
aws healthlake describe-fhir-export-job \
--datastore-id (Data store ID) \
--job-id 9b9a51943afaedd0a8c0c26c49135a31
```
出力:
```
{
"ExportJobProperties": {
"DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
"JobStatus": "IN_PROGRESS",
"JobId": "9009813e9d69ba7cf79bcb3468780f16",
"SubmitTime": "2024-11-20T11:31:46.672000-05:00",
"EndTime": "2024-11-20T11:34:01.636000-05:00",
"OutputDataConfig": {
"S3Configuration": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
"KmsKeyId": "arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"
}
},
"DatastoreId": "(Data store ID)"
}
}
```
詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアからのファイルエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-export-job.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def describe_fhir_export_job(
self, datastore_id: str, job_id: str
) -> dict[str, any]:
"""
Describes a HealthLake export job.
:param datastore_id: The data store ID.
:param job_id: The export job ID.
:return: The export job description.
"""
try:
response = self.health_lake_client.describe_fhir_export_job(
DatastoreId=datastore_id, JobId=job_id
)
return response["ExportJobProperties"]
except ClientError as err:
logger.exception(
"Couldn't describe export job with ID %s. Here's why %s",
job_id,
err.response["Error"]["Message"],
)
raise
```
+ API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[DescribeFHIRExportJob](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRExportJob)」を参照してください。
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples)での設定と実行の方法を確認してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples)での設定と実行の方法を確認してください。
```
TRY.
" iv_datastore_id = 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
" iv_job_id = 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
oo_result = lo_hll->describefhirexportjob(
iv_datastoreid = iv_datastore_id
iv_jobid = iv_job_id
).
DATA(lo_export_job_properties) = oo_result->get_exportjobproperties( ).
IF lo_export_job_properties IS BOUND.
DATA(lv_job_status) = lo_export_job_properties->get_jobstatus( ).
MESSAGE |Export job status: { lv_job_status }.| TYPE 'I'.
ENDIF.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
DATA(lv_error) = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
lv_error = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[DescribeFHIRExportJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
**可用性の例**
必要なものが見つからなかった場合。このページの右側サイドバーにある**フィードバックを提供する**リンクを使用して、コード例をリクエストします。
## AWS コンソール
**注記**
FHIR エクスポートジョブ情報は HealthLake コンソールでは使用できません。代わりに、 AWS CLI で を使用して`DescribeFHIRExportJob`、 などのエクスポートジョブのプロパティをリクエストします[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ExportJobProperties.html#HealthLake-Type-ExportJobProperties-JobStatus](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ExportJobProperties.html#HealthLake-Type-ExportJobProperties-JobStatus)。詳細については、このページ AWS CLI の例を参照してください。
# FHIR エクスポートジョブの一覧表示
を使用して`ListFHIRExportJobs`、HealthLake データストアの FHIR エクスポートジョブを一覧表示します。次のメニューでは、 の手順と、 AWS マネジメントコンソール および AWS CLI SDK の AWS コード例を示します。 SDKs 詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRExportJobs.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRExportJobs.html)」を参照してください。
**メモ**
HealthLake は、医療データ交換の [FHIR R4 仕様](https://hl7.org/fhir/R4/index.html)をサポートしています。したがって、すべてのヘルスデータは FHIR R4 形式でエクスポートされます。
**FHIR エクスポートジョブを一覧表示するには**
アクセス設定に基づいてメニューを選択します AWS HealthLake。
## AWS CLI および SDKs
------
#### [ CLI ]
**AWS CLI**
**すべての FHIR エクスポートジョブを一覧表示するには**
次の `list-fhir-export-jobs` の例は、コマンドを使用して、アカウントに関連付けられたエクスポートジョブのリストを表示する方法を示しています。
```
aws healthlake list-fhir-export-jobs \
--datastore-id (Data store ID) \
--submitted-before (DATE like 2024-10-13T19:00:00Z)\
--submitted-after (DATE like 2020-10-13T19:00:00Z )\
--job-name "FHIR-EXPORT" \
--job-status SUBMITTED \
--max-results (Integer between 1 and 500)
```
出力:
```
{
"ExportJobPropertiesList": [
{
"ExportJobProperties": {
"OutputDataConfig": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
"S3Configuration": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
"KmsKeyId": "(KmsKey Id)"
}
},
"DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
"JobStatus": "COMPLETED",
"JobId": "c145fbb27b192af392f8ce6e7838e34f",
"JobName": "FHIR-EXPORT",
"SubmitTime": "2024-11-20T11:31:46.672000-05:00",
"EndTime": "2024-11-20T11:34:01.636000-05:00",
"DatastoreId": "(Data store ID)"
}
}
]
}
```
詳細については、 AWS HealthLake デベロッパーガイド[の「FHIR データストアからのファイルのエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-export-jobs.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def list_fhir_export_jobs(
self,
datastore_id: str,
job_name: str = None,
job_status: str = None,
submitted_before: datetime = None,
submitted_after: datetime = None,
) -> list[dict[str, any]]:
"""
Lists HealthLake export jobs satisfying the conditions.
:param datastore_id: The data store ID.
:param job_name: The export job name.
:param job_status: The export job status.
:param submitted_before: The export job submitted before the specified date.
:param submitted_after: The export job submitted after the specified date.
:return: A list of export jobs.
"""
try:
parameters = {"DatastoreId": datastore_id}
if job_name is not None:
parameters["JobName"] = job_name
if job_status is not None:
parameters["JobStatus"] = job_status
if submitted_before is not None:
parameters["SubmittedBefore"] = submitted_before
if submitted_after is not None:
parameters["SubmittedAfter"] = submitted_after
next_token = None
jobs = []
# Loop through paginated results.
while True:
if next_token is not None:
parameters["NextToken"] = next_token
response = self.health_lake_client.list_fhir_export_jobs(**parameters)
jobs.extend(response["ExportJobPropertiesList"])
if "NextToken" in response:
next_token = response["NextToken"]
else:
break
return jobs
except ClientError as err:
logger.exception(
"Couldn't list export jobs. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[ListFHIRExportJobs](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRExportJobs)」を参照してください。
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples)での設定と実行の方法を確認してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples)での設定と実行の方法を確認してください。
```
TRY.
" iv_datastore_id = 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
IF iv_submitted_after IS NOT INITIAL.
oo_result = lo_hll->listfhirexportjobs(
iv_datastoreid = iv_datastore_id
iv_submittedafter = iv_submitted_after
).
ELSE.
oo_result = lo_hll->listfhirexportjobs(
iv_datastoreid = iv_datastore_id
).
ENDIF.
DATA(lt_export_jobs) = oo_result->get_exportjobpropertieslist( ).
DATA(lv_job_count) = lines( lt_export_jobs ).
MESSAGE |Found { lv_job_count } export job(s).| TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
lv_error = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[ListFHIRExportJobs](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
**可用性の例**
必要なものが見つからなかった場合。このページの右側サイドバーにある**フィードバックを提供する**リンクを使用して、コード例をリクエストします。
## AWS コンソール
**注記**
FHIR エクスポートジョブ情報は HealthLake コンソールでは使用できません。代わりに、 AWS CLI と を使用してすべての FHIR エクスポートジョブ`ListFHIRExportJobs`を一覧表示します。詳細については、このページ AWS CLI の例を参照してください。