# AWS CLI を使用した HealthLake の例 次のコード例は、HealthLake で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-fhir-datastore` 次のコード例は、`create-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **例 1: SigV4 対応の HealthLake データストアを作成する** 次の `create-fhir-datastore` の例では、AWS HealthLake で新しいデータストアを作成する方法を示します。 ``` aws healthlake create-fhir-datastore \ --datastore-type-version R4 \ --datastore-name "FhirTestDatastore" ``` 出力: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "CREATING", "DatastoreId": "(Data store ID)" } ``` **例 2: SMART on FHIR 対応の HealthLake データストアを作成する** 次の `create-fhir-datastore` の例では、AWS HealthLake で新しい SMART on FHIR 対応のデータストアを作成する方法を示します。 ``` aws healthlake create-fhir-datastore \ --datastore-name "your-data-store-name" \ --datastore-type-version R4 \ --preload-data-config PreloadDataType="SYNTHEA" \ --sse-configuration '{ "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:your-account-id:key/your-key-id" } }' \ --identity-provider-configuration file://identity_provider_configuration.json ``` `identity_provider_configuration.json` の内容: ``` { "AuthorizationStrategy": "SMART_ON_FHIR_V1", "FineGrainedAuthorizationEnabled": true, "IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name", "Metadata": "{\"issuer\":\"https://ehr.example.com\", \"jwks_uri\":\"https://ehr.example.com/.well-known/jwks.json\",\"authorization_endpoint\":\"https://ehr.example.com/auth/authorize\",\"token_endpoint\":\"https://ehr.token.com/auth/token\",\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"foo\"],\"grant_types_supported\":[\"client_credential\",\"foo\"],\"registration_endpoint\":\"https://ehr.example.com/auth/register\",\"scopes_supported\":[\"openId\",\"profile\",\"launch\"],\"response_types_supported\":[\"code\"],\"management_endpoint\":\"https://ehr.example.com/user/manage\",\"introspection_endpoint\":\"https://ehr.example.com/user/introspect\",\"revocation_endpoint\":\"https://ehr.example.com/user/revoke\",\"code_challenge_methods_supported\":[\"S256\"],\"capabilities\":[\"launch-ehr\",\"sso-openid-connect\",\"client-public\"]}" } ``` 出力: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "CREATING", "DatastoreId": "(Data store ID)" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/create-fhir-datastore.html)」を参照してください。 ### `delete-fhir-datastore` 次のコード例は、`delete-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **FHIR Data Store を削除するには** 次の `delete-fhir-datastore` の例では、AWS HealthLake でデータストアとそのすべてのコンテンツを削除する方法を示します。 ``` aws healthlake delete-fhir-datastore \ --datastore-id (Data store ID) ``` 出力: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "DELETING", "DatastoreId": "(Data store ID)" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「FHIR データストアの作成とモニタリング 」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/delete-fhir-datastore.html)」を参照してください。 ### `describe-fhir-datastore` 次のコード例は、`describe-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **FHIR データストアの詳細を取得するには** 次の `describe-fhir-datastore` の例では、AWS HealthLake でデータストアのプロパティを見つける方法を示します。 ``` aws healthlake describe-fhir-datastore \ --datastore-id "1f2f459836ac6c513ce899f9e4f66a59" ``` 出力: ``` { "DatastoreProperties": { "PreloadDataConfig": { "PreloadDataType": "SYNTHEA" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } }, "DatastoreName": "Demo", "DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-datastore.html)」を参照してください。 ### `describe-fhir-export-job` 次のコード例は、`describe-fhir-export-job` を使用する方法を示しています。 **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)」を参照してください。 ### `describe-fhir-import-job` 次のコード例は、`describe-fhir-import-job` を使用する方法を示しています。 **AWS CLI** **FHIR インポートジョブを記述するには** 次の `describe-fhir-import-job` の例では、AWS HealthLake を使用して FHIR インポートジョブのプロパティを学習する方法を示します。 ``` aws healthlake describe-fhir-import-job \ --datastore-id (Data store ID) \ --job-id c145fbb27b192af392f8ce6e7838e34f ``` 出力: ``` { "ImportJobProperties": { "InputDataConfig": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/" { "arrayitem2": 2 } }, "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)", "JobStatus": "COMPLETED", "JobId": "c145fbb27b192af392f8ce6e7838e34f", "SubmitTime": 1606272542.161, "EndTime": 1606272609.497, "DatastoreId": "(Data store ID)" } } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-import-job.html)」を参照してください。 ### `list-fhir-datastores` 次のコード例は、`list-fhir-datastores` を使用する方法を示しています。 **AWS CLI** **FHIR データストアを一覧表示するには** 次の `list-fhir-datastores` の例では、AWS HealthLake でコマンドを使用する方法と、データストアのステータスに基づいてユーザーが結果をフィルタリングする方法を示します。 ``` aws healthlake list-fhir-datastores \ --filter DatastoreStatus=ACTIVE ``` 出力: ``` { "DatastorePropertiesList": [ { "PreloadDataConfig": { "PreloadDataType": "SYNTHEA" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } }, "DatastoreName": "Demo", "DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } ] } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-datastores.html)」を参照してください。 ### `list-fhir-export-jobs` 次のコード例は、`list-fhir-export-jobs` を使用する方法を示しています。 **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)」を参照してください。 ### `list-fhir-import-jobs` 次のコード例は、`list-fhir-import-jobs` を使用する方法を示しています。 **AWS CLI** **すべての FHIR インポートジョブを一覧表示するには** 次の `list-fhir-import-jobs` の例は、コマンドを使用して、アカウントに関連付けられているすべてのインポートジョブのリストを表示する方法を示しています。 ``` aws healthlake list-fhir-import-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-IMPORT" \ --job-status SUBMITTED \ -max-results (Integer between 1 and 500) ``` 出力: ``` { "ImportJobPropertiesList": [ { "JobId": "c0fddbf76f238297632d4aebdbfc9ddf", "JobStatus": "COMPLETED", "SubmitTime": "2024-11-20T10:08:46.813000-05:00", "EndTime": "2024-11-20T10:10:09.093000-05:00", "DatastoreId": "(Data store ID)", "InputDataConfig": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/" }, "JobOutputDataConfig": { "S3Configuration": { "S3Uri": "s3://(Bucket Name)/import/6407b9ae4c2def3cb6f1a46a0c599ec0-FHIR_IMPORT-c0fddbf76f238297632d4aebdbfc9ddf/", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/b7f645cb-e564-4981-8672-9e012d1ff1a0" } }, "JobProgressReport": { "TotalNumberOfScannedFiles": 1, "TotalSizeOfScannedFilesInMB": 0.001798, "TotalNumberOfImportedFiles": 1, "TotalNumberOfResourcesScanned": 1, "TotalNumberOfResourcesImported": 1, "TotalNumberOfResourcesWithCustomerError": 0, "TotalNumberOfFilesReadWithCustomerError": 0, "Throughput": 0.0 }, "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)" } ] } ``` 詳細については、AWS HealthLake デベロッパーガイドの「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-examples.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-import-jobs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **データストアのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定したデータストアに関連付けられているタグを一覧表示します。 ``` aws healthlake list-tags-for-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" ``` 出力: ``` { "tags": { "key": "value", "key1": "value1" } } ``` 詳細については、AWS HealthLake デベロッパーガイドの「[AWS HealthLake でのリソースのタグ付け](https://docs.aws.amazon.com/healthlake/latest/devguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.html)」を参照してください。 ### `start-fhir-export-job` 次のコード例は、`start-fhir-export-job` を使用する方法を示しています。 **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)」を参照してください。 ### `start-fhir-import-job` 次のコード例は、`start-fhir-import-job` を使用する方法を示しています。 **AWS CLI** **FHIR インポートジョブを開始するには** 次の `start-fhir-import-job` の例は、AWS HealthLake を使用して FHIR インポートジョブを開始する方法を示しています。 ``` aws healthlake start-fhir-import-job \ --input-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \ --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": "c145fbb27b192af392f8ce6e7838e34f" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-import-job.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **データストアにタグを追加するには** 次の `tag-resource` の例では、データストアにタグを追加する方法を示します。 ``` aws healthlake tag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \ --tags '[{"Key": "key1", "Value": "value1"}]' ``` このコマンドでは何も出力されません。 詳細については、*AWS HealthLake デベロッパーガイド*の「[データストアへのタグの追加](https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **データストアからタグを削除するには** 次の `untag-resource` の例では、データストアからタグを削除する方法を示します。 ``` aws healthlake untag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \ --tag-keys '["key1"]' ``` このコマンドでは何も出力されません。 詳細については、*AWS HealthLake デベロッパーガイド*の「[データストアからのタグの削除](https://docs.aws.amazon.com/healthlake/latest/devguide/remove-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/untag-resource.html)」を参照してください。