翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # を使用したデータストアの管理 AWS HealthLake では AWS HealthLake、FHIR R4 リソースのデータストアを作成および管理します。HealthLake データストアを作成すると、FHIR データリポジトリが RESTful API [エンドポイント](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints)を介して利用可能になります。Synthea オープンソースの FHIR R4 ヘルスデータをデータストアにインポート (プリロード) することを選択できます。詳細については、「[プリロードされたデータ型](reference-healthlake-preloaded-data-types.md)」を参照してください。 **[重要]** HealthLake は、FHIR 上の AWS SigV4 または SMART の 2 種類の FHIR データストア認可戦略をサポートしています。HealthLake FHIR データストアを作成する前に、いずれかの認可戦略を選択する必要があります。詳細については、「[データストア認可戦略](getting-started-concepts.md#concept-data-store-authorization-strategy)」を参照してください。 アクティブな HealthLake データストアの FHIR 関連の機能 (動作) を確認するには、その[機能ステートメント](reference-fhir-capability-statement.md)を取得します。 以下のトピックでは、HealthLake クラウドネイティブアクションを使用して、、 AWS SDKs AWS CLI、 を使用して FHIR データストアを作成、説明、一覧表示、タグ付け、削除する方法について説明します AWS マネジメントコンソール。 **Topics** + [データストアの作成](managing-data-stores-create.md) + [データストアのプロパティの取得](managing-data-stores-describe.md) + [データストアの一覧表示](managing-data-stores-list.md) + [データストアのタグ付け](managing-data-stores-tagging.md) + [データストアの削除](managing-data-stores-delete.md) # HealthLake データストアの作成 を使用して`CreateFHIRDatastore`、FHIR R4 仕様に準拠した AWS HealthLake データストアを作成します。HealthLake データストアは、FHIR データのインポート、管理、検索、エクスポートに使用されます。Synthea オープンソースの FHIR R4 ヘルスデータをデータストアにインポート (プリロード) することを選択できます。詳細については、「[プリロードされたデータ型](reference-healthlake-preloaded-data-types.md)」を参照してください。 **[重要]** HealthLake は、FHIR 上の AWS SigV4 または SMART の 2 種類の FHIR データストア認可戦略をサポートしています。HealthLake FHIR データストアを作成する前に、いずれかの認可戦略を選択する必要があります。詳細については、「[データストア認可戦略](getting-started-concepts.md#concept-data-store-authorization-strategy)」を参照してください。 HealthLake データストアを作成すると、FHIR データリポジトリが RESTful API [エンドポイント](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints)を介して利用可能になります。HealthLake データストアを作成したら、[その機能ステートメント](reference-fhir-capability-statement.md)をリクエストして、関連するすべての FHIR 関連の機能 (動作) を見つけることができます。 次のメニューでは、 AWS CLI および AWS SDKsの例と、 の手順を示します AWS マネジメントコンソール。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_CreateFHIRDatastore.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_CreateFHIRDatastore.html)」を参照してください。 **HealthLake データストアを作成するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ## AWS CLI および SDKs ------ #### [ CLI ] **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 で FHIR 対応データストアに新しい SMART を作成する方法を示しています。 ``` 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)」を参照してください。 ------ #### [ 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 create_fhir_datastore( self, datastore_name: str, sse_configuration: dict[str, any] = None, identity_provider_configuration: dict[str, any] = None, ) -> dict[str, str]: """ Creates a new HealthLake data store. When creating a SMART on FHIR data store, the following parameters are required: - sse_configuration: The server-side encryption configuration for a SMART on FHIR-enabled data store. - identity_provider_configuration: The identity provider configuration for a SMART on FHIR-enabled data store. :param datastore_name: The name of the data store. :param sse_configuration: The server-side encryption configuration for a SMART on FHIR-enabled data store. :param identity_provider_configuration: The identity provider configuration for a SMART on FHIR-enabled data store. :return: A dictionary containing the data store information. """ try: parameters = {"DatastoreName": datastore_name, "DatastoreTypeVersion": "R4"} if ( sse_configuration is not None and identity_provider_configuration is not None ): # Creating a SMART on FHIR-enabled data store parameters["SseConfiguration"] = sse_configuration parameters[ "IdentityProviderConfiguration" ] = identity_provider_configuration response = self.health_lake_client.create_fhir_datastore(**parameters) return response except ClientError as err: logger.exception( "Couldn't create data store %s. Here's why %s", datastore_name, err.response["Error"]["Message"], ) raise ``` 次のコードは、SMART on FHIR 対応 HealthLake データストアのパラメータの例を示しています。 ``` sse_configuration = { "KmsEncryptionConfig": {"CmkType": "AWS_OWNED_KMS_KEY"} } # TODO: Update the metadata to match your environment. 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", ], } # TODO: Update the IdpLambdaArn. identity_provider_configuration = { "AuthorizationStrategy": "SMART_ON_FHIR_V1", "FineGrainedAuthorizationEnabled": True, "IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name", "Metadata": json.dumps(metadata), } data_store = self.create_fhir_datastore( datastore_name, sse_configuration, identity_provider_configuration ) ``` + API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[CreateFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/CreateFHIRDatastore)」を参照してください。 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_name = 'MyHealthLakeDataStore' oo_result = lo_hll->createfhirdatastore( iv_datastorename = iv_datastore_name iv_datastoretypeversion = 'R4' ). MESSAGE 'Data store created successfully.' 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_hllinternalserverex INTO DATA(lo_internal_ex). lv_error = |Internal server error: { lo_internal_ex->av_err_code }-{ lo_internal_ex->av_err_msg }|. MESSAGE lv_error TYPE 'I'. RAISE EXCEPTION lo_internal_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. ENDTRY. ``` + API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[CreateFHIRDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。 ------ **可用性の例** 必要なものが見つからなかった場合。このページの右側サイドバーにある**フィードバックを提供する**リンクを使用して、コード例をリクエストします。 ## AWS コンソール **メモ** 次の手順では、[AWS SigV4](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) 認可を持つ HealthLake データストアを作成します。HealthLake コンソールは、FHIR データストアでの SMART の作成をサポートしていません。 **AWS SigV4 認可を使用して HealthLake データストアを作成するには** 1. HealthLake コンソールのデータ[ストアの作成](https://console.aws.amazon.com/healthlake/home#/create-datastore)ページにサインインします。 1. **データストアの作成**を選択します。 1. **データストア設定**セクションで、**データストア名**に名前を指定します。 1. (オプション) **データストア設定**セクションの**事前ロードサンプルデータ**で、チェックボックスを選択して Synthea データを事前ロードします。Synthea データはオープンソースのサンプルデータセットです。詳細については、「[HealthLake の Synthea プリロードされたデータ型](reference-healthlake-preloaded-data-types.md)」を参照してください。 1. **データストアの暗号化**セクションで、**AWS 所有キーを使用する (デフォルト)** または**別の AWS KMS キーを選択する (詳細)** を選択します。 1. **タグ - *オプション***セクションでは、データストアにタグを追加できます。データストアのタグ付けの詳細については、「」を参照してください[HealthLake データストアのタグ付け](managing-data-stores-tagging.md)。 1. **データストアの作成**を選択します。 データストアのステータスは、**データストア**ページで確認できます。 # HealthLake データストアのプロパティの取得 を使用して`DescribeFHIRDatastore`、 AWS HealthLake データストアのプロパティを取得します。以下のメニューでは、 の手順と、 AWS マネジメントコンソール および AWS CLI SDK の AWS コード例を示します。 SDKs 詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRDatastore.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRDatastore.html)」を参照してください。 **HealthLake データストアのプロパティを取得するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ## AWS CLI および SDKs ------ #### [ CLI ] **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)」を参照してください。 ------ #### [ 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_datastore(self, datastore_id: str) -> dict[str, any]: """ Describes a HealthLake data store. :param datastore_id: The data store ID. :return: The data store description. """ try: response = self.health_lake_client.describe_fhir_datastore( DatastoreId=datastore_id ) return response["DatastoreProperties"] except ClientError as err: logger.exception( "Couldn't describe data store with ID %s. Here's why %s", datastore_id, err.response["Error"]["Message"], ) raise ``` + API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DescribeFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRDatastore)」を参照してください。 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' oo_result = lo_hll->describefhirdatastore( iv_datastoreid = iv_datastore_id ). DATA(lo_datastore_properties) = oo_result->get_datastoreproperties( ). IF lo_datastore_properties IS BOUND. DATA(lv_datastore_name) = lo_datastore_properties->get_datastorename( ). DATA(lv_datastore_status) = lo_datastore_properties->get_datastorestatus( ). MESSAGE 'Data store described successfully.' 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 リファレンス*の「[DescribeFHIRDatastore](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. データストアを選択します。 **データストアの詳細**ページが開き、すべての HealthLake データストアプロパティを使用できます。 # HealthLake データストアの一覧表示 を使用して`ListFHIRDatastores`、データストアのステータスに関係なく、ユーザーのアカウント内のすべての HealthLake データストアを一覧表示します。次のメニューでは、 の手順と、 AWS マネジメントコンソール AWS CLI および AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRDatastores.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRDatastores.html)」を参照してください。 **すべての HealthLake データストアを一覧表示するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ## AWS CLI および SDKs ------ #### [ CLI ] **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)」を参照してください。 ------ #### [ 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_datastores(self) -> list[dict[str, any]]: """ Lists all HealthLake data stores. :return: A list of data store descriptions. """ try: next_token = None datastores = [] # Loop through paginated results. while True: parameters = {} if next_token is not None: parameters["NextToken"] = next_token response = self.health_lake_client.list_fhir_datastores(**parameters) datastores.extend(response["DatastorePropertiesList"]) if "NextToken" in response: next_token = response["NextToken"] else: break return datastores except ClientError as err: logger.exception( "Couldn't list data stores. Here's why %s", err.response["Error"]["Message"] ) raise ``` + API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[ListFHIRDatastores](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRDatastores)」を参照してください。 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. oo_result = lo_hll->listfhirdatastores( ). DATA(lt_datastores) = oo_result->get_datastorepropertieslist( ). DATA(lv_datastore_count) = lines( lt_datastores ). MESSAGE |Found { lv_datastore_count } data store(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_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. ENDTRY. ``` + API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[ListFHIRDatastores](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。 ------ **可用性の例** 必要なものが見つからなかった場合。このページの右側サイドバーにある**フィードバックを提供する**リンクを使用して、コード例をリクエストします。 ## AWS コンソール + HealthLake コンソール[のデータストア](https://console.aws.amazon.com/healthlake/home#/list-datastores)ページにサインインします。 すべての HealthLake データストアは**、データストア**セクションの下に表示されます。 # HealthLake データストアのタグ付け メタデータは、タグの形式で HealthLake データストアに割り当てることができます。各タグは、ユーザー定義のキーと値で構成されるラベルです。タグは、データストアの管理、識別、整理、検索、フィルタリングに役立ちます。 **[重要]** 保健情報 (PHI)、個人を特定できる情報 (PII)などの機密情報や秘匿性の高い情報はタグに格納しないでください。タグは、プライベートデータまたは機密データに使用することを目的としたものではありません。 以下のトピックでは、 AWS マネジメントコンソール、、 AWS CLIおよび AWS SDKs を使用して HealthLake タグ付けオペレーションを使用する方法について説明します。詳細については、[「 ガイド」の「 AWS リソースのタグ付け](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)」を参照してください。 *AWS 全般のリファレンス * **Topics** + [HealthLake データストアのタグ付け](#tagresource) + [HealthLake データストアのタグの一覧表示](#listtagsforresource) + [HealthLake データストアのタグ解除](#untagresource) ## HealthLake データストアのタグ付け `TagResource` を使用して HealthLake データストアにタグを付けます。以下のメニューでは、 の手順 AWS マネジメントコンソール と、 AWS CLI および AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_TagResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_TagResource.html.html)」を参照してください。 **HealthLake データストアにタグを付けるには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ### AWS CLI および SDKs ------ #### [ CLI ] **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)」を参照してください。 ------ #### [ 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 tag_resource(self, resource_arn: str, tags: list[dict[str, str]]) -> None: """ Tags a HealthLake resource. :param resource_arn: The resource ARN. :param tags: The tags to add to the resource. """ try: self.health_lake_client.tag_resource(ResourceARN=resource_arn, Tags=tags) except ClientError as err: logger.exception( "Couldn't tag resource %s. Here's why %s", resource_arn, err.response["Error"]["Message"], ) raise ``` + API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[TagResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/TagResource)」を参照してください。 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_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6' lo_hll->tagresource( iv_resourcearn = iv_resource_arn it_tags = it_tags ). MESSAGE 'Resource tagged successfully.' 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 リファレンス*の[TagResource](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. [**新しいタグを追加**] をクリックします。 1. **[キー]** を入力し、オプションで **[値]** を入力します。 1. **[保存]** を選択します。 ## HealthLake データストアのタグの一覧表示 `ListTagsForResource` を使用して HealthLake データストアのタグを一覧表示します。以下のメニューでは、 の手順 AWS マネジメントコンソール と、 AWS CLI および AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListTagsForResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListTagsForResource.html.html)」を参照してください。 **HealthLake データストアのタグを一覧表示するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ### AWS CLI および SDKs ------ #### [ CLI ] **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 でのリソースのタグ付け](https://docs.aws.amazon.com/healthlake/latest/devguide/tagging.html)」を参照してください。 AWS HealthLake + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.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_tags_for_resource(self, resource_arn: str) -> dict[str, str]: """ Lists the tags for a HealthLake resource. :param resource_arn: The resource ARN. :return: The tags for the resource. """ try: response = self.health_lake_client.list_tags_for_resource( ResourceARN=resource_arn ) return response["Tags"] except ClientError as err: logger.exception( "Couldn't list tags for resource %s. Here's why %s", resource_arn, err.response["Error"]["Message"], ) raise ``` + API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[ListTagsForResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListTagsForResource)」を参照してください。 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_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6' DATA(lo_result) = lo_hll->listtagsforresource( iv_resourcearn = iv_resource_arn ). ot_tags = lo_result->get_tags( ). DATA(lv_tag_count) = lines( ot_tags ). MESSAGE |Found { lv_tag_count } tag(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 リファレンス*の[ListTagsForResource](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. データストアを選択します。 **[データストアの詳細]** ページが開きます。**[タグ]** セクションに、すべてのデータストアタグが一覧表示されます。 ## HealthLake データストアのタグ解除 `UntagResource` を使用して HealthLake データストアからタグを削除します。以下のメニューでは、 の手順 AWS マネジメントコンソール と、 AWS CLI および AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_UntagResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_UntagResource.html.html)」を参照してください。 **HealthLake データストアのタグを解除するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ### AWS CLI および SDKs ------ #### [ CLI ] **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)」を参照してください。 ------ #### [ 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 untag_resource(self, resource_arn: str, tag_keys: list[str]) -> None: """ Untags a HealthLake resource. :param resource_arn: The resource ARN. :param tag_keys: The tag keys to remove from the resource. """ try: self.health_lake_client.untag_resource( ResourceARN=resource_arn, TagKeys=tag_keys ) except ClientError as err: logger.exception( "Couldn't untag resource %s. Here's why %s", resource_arn, err.response["Error"]["Message"], ) raise ``` + API の詳細については、*AWS  SDK for Python (Boto3) API リファレンス*の「[UntagResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/UntagResource)」を参照してください。 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_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6' lo_hll->untagresource( iv_resourcearn = iv_resource_arn it_tagkeys = it_tag_keys ). MESSAGE 'Resource untagged successfully.' 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* [UntagResource](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. 削除するタグの横にある **[削除]** を選択します。 1. **[保存]** を選択します。 # HealthLake データストアの削除 HealthLake データストアを削除するには、 `DeleteFHIRDatastore`を使用します。以下のメニューでは、 の手順 AWS マネジメントコンソール と、 AWS CLI および AWS SDKs。詳細については、「*AWS HealthLake API リファレンス*」の「[https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DeleteFHIRDatastores.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DeleteFHIRDatastores.html)」を参照してください。 **HealthLake データストアを削除するには** アクセス設定に基づいてメニューを選択します AWS HealthLake。 ## AWS CLI および SDKs ------ #### [ CLI ] **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)」を参照してください。 ------ #### [ 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 delete_fhir_datastore(self, datastore_id: str) -> None: """ Deletes a HealthLake data store. :param datastore_id: The data store ID. """ try: self.health_lake_client.delete_fhir_datastore(DatastoreId=datastore_id) except ClientError as err: logger.exception( "Couldn't delete data store with ID %s. Here's why %s", datastore_id, err.response["Error"]["Message"], ) raise ``` + API の詳細については、「*AWS SDK for Python (Boto3) API リファレンス*」の「[DeleteFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DeleteFHIRDatastore)」を参照してください。 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' oo_result = lo_hll->deletefhirdatastore( iv_datastoreid = iv_datastore_id ). MESSAGE 'Data store deleted successfully.' TYPE 'I'. CATCH /aws1/cx_hllaccessdeniedex INTO DATA(lo_access_ex). DATA(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. CATCH /aws1/cx_hllconflictexception INTO DATA(lo_conflict_ex). lv_error = |Conflict error: { lo_conflict_ex->av_err_code }-{ lo_conflict_ex->av_err_msg }|. MESSAGE lv_error TYPE 'I'. RAISE EXCEPTION lo_conflict_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 リファレンス*の[DeleteFHIRDatastore](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. データストアの削除を確認するには、テキスト入力フィールドにデータストア名を入力します。 1. **[Delete]** (削除) をクリックします。