文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 AWS SDK 範例
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
使用 的 HealthLake 範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 HealthLake 來執行動作和實作常見案例。
Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境中查看內容中的動作。
每個範例都包含完整原始程式碼的連結,您可以在其中找到如何在內容中設定和執行程式碼的指示。
主題
動作
下列程式碼範例示範如何使用 create-fhir-datastore
。
- AWS CLI
-
範例 1:建立SigV4-enabled 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:在啟用 FHIR 的 HealthLake 資料存放區上建立 SMART
下列
create-fhir-datastore
範例示範如何在啟用 FHIR 的資料存放區 in AWS HealthLake 上建立新的 SMART。aws healthlake create-fhir-datastore \ --datastore-name
"your-data-store-name"
\ --datastore-type-versionR4
\ --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-configurationfile://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 資料存放區。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 CreateFHIRDatastore
。
-
下列程式碼範例示範如何使用 delete-fhir-datastore
。
- AWS CLI
-
刪除 FHIR 資料存放區
下列
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 資料存放區 <https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html>。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 DeleteFHIRDatastore
。
-
下列程式碼範例示範如何使用 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:<AWS Account ID>:datastore/<Data store ID>", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Data store ID>/r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "<Data store ID>", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } }
如需詳細資訊,請參閱 AWS HealthLake 開發人員指南中的建立和監控 FHIR 資料存放區。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 DescribeFHIRDatastore
。
-
下列程式碼範例示範如何使用 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-id9b9a51943afaedd0a8c0c26c49135a31
輸出:
{ "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 資料存放區匯出檔案。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 DescribeFHIRExportJob
。
-
下列程式碼範例示範如何使用 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-idc145fbb27b192af392f8ce6e7838e34f
輸出:
{ "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 資料存放區。
-
如需 API 詳細資訊,請參閱《 AWS CLI 命令參考》中的 DescribeFHIRImportJob
。
-
下列程式碼範例示範如何使用 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:<AWS Account ID>:datastore/<Data store ID>", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Data store ID>/r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "<Data store ID>", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } ] }
如需詳細資訊,請參閱 AWS HealthLake 開發人員指南中的建立和監控 FHIR 資料存放區。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 ListFHIRDatastores
。
-
下列程式碼範例示範如何使用 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-statusSUBMITTED
\ --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 資料存放區匯出檔案。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 ListFHIRExportJobs
。
-
下列程式碼範例示範如何使用 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-statusSUBMITTED
\-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 資料存放區。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 ListFHIRImportJobs
。
-
下列程式碼範例示範如何使用 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 開發人員指南》中的在HealthLake 中標記資源。 AWS HealthLake
-
如需 API 詳細資訊,請參閱《AWS CLI 命令參考》中的 ListTagsForResource
。
-
下列程式碼範例示範如何使用 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-arnarn:aws:iam::(AWS
Account
ID):role/(Role
Name)
輸出:
{ "DatastoreId": "(Data store ID)", "JobStatus": "SUBMITTED", "JobId": "9b9a51943afaedd0a8c0c26c49135a31" }
如需詳細資訊,請參閱 AWS HealthLake 開發人員指南中的從 FHIR 資料存放區匯出檔案。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 StartFHIRExportJob
。
-
下列程式碼範例示範如何使用 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 資料存放區。
-
如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 StartFHIRImportJob
。
-
下列程式碼範例示範如何使用 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"}]
'此命令不會產生輸出。
如需詳細資訊,請參閱 HealthLake 開發人員指南中的將標籤新增至資料存放區。 AWS HealthLake
-
如需 API 詳細資訊,請參閱《AWS CLI 命令參考》中的 TagResource
。
-
下列程式碼範例示範如何使用 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 開發人員指南中的從資料存放區移除標籤。
-
如需 API 詳細資訊,請參閱《AWS CLI 命令參考》中的 UntagResource
。
-