使用 AWS CLI 的 HealthLake 示例 - AWS Command Line Interface
操作

使用 AWS CLI 的 HealthLake 示例

以下代码示例演示了如何通过将 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 数据存储。

以下代码示例演示了如何使用 delete-fhir-datastore。

AWS CLI

删除 FHIR 数据存储

以下 delete-fhir-datastore 示例演示了如何在 Amazon 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 数据存储”<https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html>。

以下代码示例演示了如何使用 describe-fhir-datastore。

AWS CLI

描述 FHIR 数据存储

以下 describe-fhir-datastore 示例演示了如何在 Amazon 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 数据存储。

以下代码示例演示了如何使用 describe-fhir-export-job。

AWS CLI

描述 FHIR 导出作业

以下 describe-fhir-export-job 示例演示了如何在 Amazon HealthLake 中查找 FHIR 导出作业的属性。

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 数据存储中导出文件。

以下代码示例演示了如何使用 describe-fhir-import-job。

AWS CLI

描述 FHIR 导入作业

以下 describe-fhir-import-job 示例演示了如何使用 Amazon HealthLake 了解 FHIR 导入作业的属性。

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 数据存储。

以下代码示例演示了如何使用 list-fhir-datastores。

AWS CLI

列出 FHIR 数据存储

以下 list-fhir-datastores 示例演示了如何在 Amazon 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 数据存储。

  • 有关 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:674914422125:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --region us-east-1

输出：

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

有关更多信息，请参阅《Amazon HealthLake 开发人员指南》中的在 Amazon HealthLake 中标记资源。

以下代码示例演示了如何使用 start-fhir-export-job。

AWS CLI

启动 FHIR 导出作业

以下 start-fhir-export-job 示例演示了如何使用 Amazon HealthLake 启动 FHIR 导出作业。

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 HealthLake 启动 FHIR 导入作业。

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 数据存储”<https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html>。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 StartFhirImportJob。

以下代码示例演示了如何使用 tag-resource。

AWS CLI

向数据存储中添加标签

以下 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 HealthLake 开发人员指南》中的“向数据存储中添加标签”<https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html>。

  • 有关 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。