HealthLake を使用した例 AWS CLI

次のコード例は、 AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています HealthLake。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

アクション

次のコード例は、create-fhir-datastore を使用する方法を示しています。

AWS CLI

FHIR データストアを作成するには。

次のcreate-fhir-datastore例は、Amazon で新しいデータストアを作成する方法を示しています HealthLake。


aws healthlake create-fhir-datastore \
    --region us-east-1 \
    --datastore-type-version R4 \
    --datastore-type-version R4 \
    --datastore-name "FhirTestDatastore"

出力:


{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Datastore ID)"
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「データストアの作成とモニタリング」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスCreateFhirDatastore」の「」を参照してください。

次の例は、delete-fhir-datastore を使用する方法を説明しています。

AWS CLI

FHIR データストアを削除するには

次のdelete-fhir-datastore例は、Amazon で Data Store とそのすべてのコンテンツを削除する方法を示しています HealthLake。


aws healthlake delete-fhir-datastore \
    --datastore-id (Data Store ID) \
    --region us-east-1

出力:


{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
    "DatastoreStatus": "DELETING",
    "DatastoreId": "(Datastore ID)"
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「Data Store <https://docs.aws.amazon.com/healthlake/latest/devguide/working-withFHIR-healthlake.html> の作成とモニタリング」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスDeleteFhirDatastore」の「」を参照してください。

次のコード例は、describe-fhir-datastore を使用する方法を示しています。

AWS CLI

FHIR データストアを記述するには

次のdescribe-fhir-datastore例は、Amazon で Data Store のプロパティを検索する方法を示しています HealthLake。


aws healthlake describe-fhir-datastore \
    --datastore-id "1f2f459836ac6c513ce899f9e4f66a59" \
    --region us-east-1

出力:


{
    "DatastoreProperties": {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "DatastoreName": "FhirTestDatastore",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
        "DatastoreStatus": "CREATING",
        "DatastoreTypeVersion": "R4",
        "DatastoreId": "(Datastore ID)"
    }
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「データストアの作成とモニタリング」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスDescribeFhirDatastore」の「」を参照してください。

次のコード例は、describe-fhir-export-job を使用する方法を示しています。

AWS CLI

FHIRエクスポートジョブを記述するには

次のdescribe-fhir-export-job例は、Amazon でFHIRエクスポートジョブのプロパティを検索する方法を示しています HealthLake。


aws healthlake describe-fhir-export-job \
    --datastore-id (Datastore ID) \
    --job-id 9b9a51943afaedd0a8c0c26c49135a31

出力:


{
    "ExportJobProperties": {
        "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
        "JobStatus": "IN_PROGRESS",
        "JobId": "9009813e9d69ba7cf79bcb3468780f16",
        "SubmitTime": 1609175692.715,
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/59593b2d0367ce252b5e66bf5fd6b574-FHIR_EXPORT-9009813e9d69ba7cf79bcb3468780f16/"
        },
        "DatastoreId": "(Datastore ID)"
    }
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「データストアからのファイルのエクスポート」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスDescribeFhirExportJob」の「」を参照してください。

次のコード例は、describe-fhir-import-job を使用する方法を示しています。

AWS CLI

FHIRインポートジョブを記述するには

次のdescribe-fhir-import-job例は、Amazon を使用してFHIRインポートジョブのプロパティを学習する方法を示しています HealthLake。


aws healthlake describe-fhir-import-job \
    --datastore-id (Datastore ID) \
    --job-id c145fbb27b192af392f8ce6e7838e34f \
    --region us-east-1

出力:


{
    "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": "(Datastore ID)"
    }
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「Data Store へのファイルのインポート」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスDescribeFhirImportJob」の「」を参照してください。

次のコード例は、list-fhir-datastores を使用する方法を示しています。

AWS CLI

FHIR データストアを一覧表示するには

次のlist-fhir-datastores例は、コマンドの使用方法と、ユーザーが Amazon の Data Store ステータスに基づいて結果をフィルタリングする方法を示しています HealthLake。


aws healthlake list-fhir-datastores \
    --region us-east-1 \
    --filter DatastoreStatus=ACTIVE

出力:


{
    "DatastorePropertiesList": [
    {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "DatastoreName": "FhirTestDatastore",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1605574003.209,
        "DatastoreId": "<Datastore ID>"
    },
    {
        "DatastoreName": "Demo",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1603761064.881,
        "DatastoreId": "<Datastore ID>"
    }
    ]
}

詳細については、「Amazon 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 (Datastore 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)

出力:


{
    "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": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Datastore ID)"
    }
}
"NextToken": String

詳細については、「Amazon 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 (Datastore 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)

出力:


{
    "ImportJobProperties": {
        "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-IMPORT",
        "SubmitTime": 1606272542.161,
        "EndTime": 1606272609.497,
        "DatastoreId": "(Datastore ID)"
    }
}
"NextToken": String

詳細については、Amazon HealthLake デベロッパーガイドのFHIR「Data Store へのファイルのインポート」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスListFhirImportJobs」の「」を参照してください。

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

データストアのタグを一覧表示するには

次のlist-tags-for-resource例では、指定された Data Store に関連付けられたタグを一覧表示します。


aws healthlake list-tags-for-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:674914422125:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --region us-east-1

出力:


{
    "tags": {
        "key": "value",
        "key1": "value1"
    }
}

詳細については、「Amazon デベロッパーガイド」の「Amazon でのリソースのタグ付け HealthLake」を参照してください。 HealthLake

API 詳細については、AWS CLI 「コマンドリファレンスListTagsForResource」の「」を参照してください。

次のコード例は、start-fhir-export-job を使用する方法を示しています。

AWS CLI

FHIRエクスポートジョブを開始するには

次のstart-fhir-export-job例は、Amazon を使用してFHIRエクスポートジョブを開始する方法を示しています HealthLake。


aws healthlake start-fhir-export-job \
    --output-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \
    --datastore-id (Datastore ID) \
    --data-access-role-arn arn:aws:iam::(AWS Account ID):role/(Role Name)

出力:


{
    "DatastoreId": "(Datastore ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "9b9a51943afaedd0a8c0c26c49135a31"
}

詳細については、「Amazon HealthLake デベロッパーガイド」のFHIR「データストアからのファイルのエクスポート」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスStartFhirExportJob」の「」を参照してください。

次のコード例は、start-fhir-import-job を使用する方法を示しています。

AWS CLI

FHIRインポートジョブを開始するには

次のstart-fhir-import-job例は、Amazon を使用してFHIRインポートジョブを開始する方法を示しています HealthLake。


aws healthlake start-fhir-import-job \
    --input-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \
    --datastore-id (Datastore ID) \
    --data-access-role-arn "arn:aws:iam::(AWS Account ID):role/(Role Name)" \
    --region us-east-1

出力:


{
    "DatastoreId": "(Datastore ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f"
}

詳細については、「Amazon HeatlhLake デベロッパーガイド」のFHIR「Data Store 'https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html へのファイルのインポート」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスStartFhirImportJob」の「」を参照してください。

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

Data Store にタグを追加するには

次のtag-resource例は、データストアにタグを追加する方法を示しています。


aws healthlake tag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:691207106566:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --tags '[{"Key": "key1", "Value": "value1"}]' \
    --region us-east-1

このコマンドでは何も出力されません。

詳細については、「Amazon デベロッパーガイド」の「Data Store へのタグの追加」＜https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html>」を参照してください。 HealthLake

API 詳細については、AWS CLI 「コマンドリファレンスTagResource」の「」を参照してください。

次のコード例は、untag-resource を使用する方法を示しています。

AWS CLI

データストアからタグを削除するには。

次のuntag-resource例は、データストアからタグを削除する方法を示しています。


aws healthlake untag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:674914422125:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \
    --tag-keys '["key1"]' \
    --region us-east-1

このコマンドでは何も出力されません。

詳細については、「Amazon デベロッパーガイド」の「データストアからのタグの削除」を参照してください。 HealthLake

API 詳細については、AWS CLI 「コマンドリファレンスUntagResource」の「」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

HealthImaging

HealthOmics