# AWS CLI を使用した HealthImaging の例
次のコード例は、HealthImaging で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `copy-image-set`
次のコード例は、`copy-image-set` を使用する方法を示しています。
**AWS CLI**
**例 1：コピー先を指定せずに画像セットをコピーするには。**
次の `copy-image-set` の例では、コピー先を指定せずに画像セットの複製コピーを作成します。
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" } }'
```
出力:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042357.432,
"imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042357.432,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
**例 2：コピー先を指定して画像セットをコピーするには。**
次の `copy-image-set` の例では、コピー先を指定して画像セットの複製コピーを作成します。
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" }, "destinationImageSet": { "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "latestVersionId": "1"} }'
```
出力:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042505.135,
"imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042505.135,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
**例 3: ソース画像セットからコピー先画像セットにインスタンスのサブセットをコピーするには。**
次の `copy-image-set` の例では、ソース画像セットからコピー先画像セットに 1 つの DICOM インスタンスをコピーします。force パラメータは、患者、検査、シリーズレベルの属性の不整合を上書きするために提供されます。
```
aws medical-imaging copy-image-set \
--datastore-id 12345678901234567890123456789012 \
--source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1","DICOMCopies": {"copiableAttributes": "{\"SchemaVersion\":\"1.1\",\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3666.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3669.0\":{}}}}}}"}},"destinationImageSet": {"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7","latestVersionId": "1"}}' \
--force
```
出力:
```
{
"destinationImageSetProperties": {
"latestVersionId": "2",
"imageSetWorkflowStatus": "COPYING",
"updatedAt": 1680042505.135,
"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7",
"imageSetState": "LOCKED",
"createdAt": 1680042357.432
},
"sourceImageSetProperties": {
"latestVersionId": "1",
"imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
"updatedAt": 1680042505.135,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436
},
"datastoreId": "12345678901234567890123456789012"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Copying an image set](https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/copy-image-set.html)」を参照してください。
### `create-datastore`
次の例は、`create-datastore` を使用する方法を説明しています。
**AWS CLI**
**例 1：データストアにタグを付けるには**
次の `create-datastore` コード例では、`my-datastore` という名が付けられたデータストアを作成しています。`--lossless-storage-format` を指定せずにデータストアを作成すると、AWS HealthImaging はデフォルトで HTJ2K (高スループット JPEG 2000) になります。
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore"
```
出力:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
**例 2: JPEG 2000 ロスレスストレージ形式でデータストアを作成するには**
JPEG 2000 ロスレスストレージ形式で設定されたデータストアは、可逆イメージフレームを JPEG 2000 形式でトランスコードして保持します。その後、画像フレームは JPEG 2000 ロスレス、トランスコーディングなしで取得できます。次の `create-datastore` コード例では、`my-datastore` という名前の JPEG 2000 ロスレスストレージ形式用に設定されたデータストアを作成します。
```
aws medical-imaging create-datastore \
--datastore-name "my-datastore" \
--lossless-storage-format JPEG_2000_LOSSLESS
```
出力:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "CREATING"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Creating a data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html)」を参照してください。
### `delete-datastore`
次のコード例は、`delete-datastore` を使用する方法を示しています。
**AWS CLI**
**データストアを削除するには**
次の `delete-datastore` コード例では、データストアを削除しています。
```
aws medical-imaging delete-datastore \
--datastore-id "12345678901234567890123456789012"
```
出力:
```
{
"datastoreId": "12345678901234567890123456789012",
"datastoreStatus": "DELETING"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Deleting a data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html)」を参照してください。
### `delete-image-set`
次のコード例は、`delete-image-set` を使用する方法を示しています。
**AWS CLI**
**画像セットを削除するには**
以下の `delete-image-set` コード例は画像セットを削除しています。
```
aws medical-imaging delete-image-set \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
出力:
```
{
"imageSetWorkflowStatus": "DELETING",
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"datastoreId": "12345678901234567890123456789012"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Deleting an image set](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-image-set.html)」を参照してください。
### `get-datastore`
次の例は、`get-datastore` を使用する方法を説明しています。
**AWS CLI**
**例 1: データストアのプロパティを取得するには**
次の `get-datastore` コード例では、データストアのプロパティを取得しています。
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
出力:
```
{
"datastoreProperties": {
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"losslessStorageFormat": "HTJ2K"
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
}
```
**例 2: JPEG 2000 用に設定されたデータストアのプロパティを取得するには**
次の `get-datastore` コード例では、JPEG 2000 ロスレスストレージ形式用に設定されたデータストアのデータストアのプロパティを取得します。
```
aws medical-imaging get-datastore \
--datastore-id 12345678901234567890123456789012
```
出力:
```
{
"datastoreProperties": {
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"losslessStorageFormat": "JPEG_2000_LOSSLESS",
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting data store properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html)」を参照してください。
### `get-dicom-import-job`
次のコード例は、`get-dicom-import-job` を使用する方法を示しています。
**AWS CLI**
**DICOM インポートジョブのプロパティを取得するには**
次の `get-dicom-import-job` コード例では、DICOM インポートジョブのプロパティを取得しています。
```
aws medical-imaging get-dicom-import-job \
--datastore-id "12345678901234567890123456789012" \
--job-id "09876543210987654321098765432109"
```
出力:
```
{
"jobProperties": {
"jobId": "09876543210987654321098765432109",
"jobName": "my-job",
"jobStatus": "COMPLETED",
"datastoreId": "12345678901234567890123456789012",
"dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
"endedAt": "2022-08-12T11:29:42.285000+00:00",
"submittedAt": "2022-08-12T11:28:11.152000+00:00",
"inputS3Uri": "s3://medical-imaging-dicom-input/dicom_input/",
"outputS3Uri": "s3://medical-imaging-output/job_output/12345678901234567890123456789012-DicomImport-09876543210987654321098765432109/"
}
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting import job properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-dicom-import-job.html)」を参照してください。
### `get-image-frame`
次のコード例は、`get-image-frame` を使用する方法を示しています。
**AWS CLI**
**画像セットのピクセルデータを取得するには**
次の `get-image-frame` コード例では、画像フレームを取得しています。
```
aws medical-imaging get-image-frame \
--datastore-id "12345678901234567890123456789012" \
--image-set-id "98765412345612345678907890789012" \
--image-frame-information imageFrameId=3abf5d5d7ae72f80a0ec81b2c0de3ef4 \
imageframe.jph
```
注：このコード例には出力は含まれていません。GetImageFrame という操作は、ピクセルデータのストリームを imageframe.jph ファイルに返すからです。画像フレームのデコードと表示については、「HTJ2K デコードライブラリ」を参照してください。
詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set pixel data](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageFrame](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-frame.html)」を参照してください。
### `get-image-set-metadata`
次のコード例は、`get-image-set-metadata` を使用する方法を示しています。
**AWS CLI**
**例 1：画像セットのメタデータをバージョンなしで取得するには**
次の `get-image-set-metadata` コード例では、バージョンを指定せずに画像セットのメタデータを取得しています。
注：`outfile` は必須のパラメータです
```
aws medical-imaging get-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
studymetadata.json.gz
```
返されたメタデータは gzip で圧縮され、studymetadata.json.gz ファイルに保存されます。返された JSON オブジェクトの内容を表示するには、まずオブジェクトを解凍する必要があります。
出力:
```
{
"contentType": "application/json",
"contentEncoding": "gzip"
}
```
**例 2：画像セットのメタデータをバージョン付きで取得するには**
次の `get-image-set-metadata` コード例では、指定されたバージョンの画像セットのメタデータを取得しています。
注：`outfile` は必須のパラメータです
```
aws medical-imaging get-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--version-id 1 \
studymetadata.json.gz
```
返されたメタデータは gzip で圧縮され、studymetadata.json.gz ファイルに保存されます。返された JSON オブジェクトの内容を表示するには、まずオブジェクトを解凍する必要があります。
出力:
```
{
"contentType": "application/json",
"contentEncoding": "gzip"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set metadata](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set-metadata.html)」を参照してください。
### `get-image-set`
次のコード例は、`get-image-set` を使用する方法を示しています。
**AWS CLI**
**画像セットのプロパティを取得するには**
以下の `get-image-set` コード例では、画像セットのプロパティを取得しています。
```
aws medical-imaging get-image-set \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 18f88ac7870584f58d56256646b4d92b \
--version-id 1
```
出力:
```
{
"versionId": "1",
"imageSetWorkflowStatus": "COPIED",
"updatedAt": 1680027253.471,
"imageSetId": "18f88ac7870584f58d56256646b4d92b",
"imageSetState": "ACTIVE",
"createdAt": 1679592510.753,
"datastoreId": "12345678901234567890123456789012"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set.html)」を参照してください。
### `list-datastores`
次のコード例は、`list-datastores` を使用する方法を示しています。
**AWS CLI**
**データストアを一覧表示するには**
次の `list-datastores` コード例では、利用可能なデータストアを一覧表示しています。
```
aws medical-imaging list-datastores
```
出力:
```
{
"datastoreSummaries": [
{
"datastoreId": "12345678901234567890123456789012",
"datastoreName": "TestDatastore123",
"datastoreStatus": "ACTIVE",
"datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
"createdAt": "2022-11-15T23:33:09.643000+00:00",
"updatedAt": "2022-11-15T23:33:09.643000+00:00"
}
]
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing data stores](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html)」を参照してください。
### `list-dicom-import-jobs`
次のコード例は、`list-dicom-import-jobs` を使用する方法を示しています。
**AWS CLI**
**DICOM インポートジョブを一覧表示するには**
次の `list-dicom-import-jobs` コード例では、インポートジョブを一覧表示します。
```
aws medical-imaging list-dicom-import-jobs \
--datastore-id "12345678901234567890123456789012"
```
出力:
```
{
"jobSummaries": [
{
"jobId": "09876543210987654321098765432109",
"jobName": "my-job",
"jobStatus": "COMPLETED",
"datastoreId": "12345678901234567890123456789012",
"dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
"endedAt": "2022-08-12T11:21:56.504000+00:00",
"submittedAt": "2022-08-12T11:20:21.734000+00:00"
}
]
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing import jobs](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDICOMImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-dicom-import-jobs.html)」を参照してください。
### `list-image-set-versions`
次のコード例は、`list-image-set-versions` を使用する方法を示しています。
**AWS CLI**
**画像セットバージョンを一覧表示するには**
次の `list-image-set-versions` コード例では、画像セットのバージョン履歴を一覧表示しています。
```
aws medical-imaging list-image-set-versions \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
出力:
```
{
"imageSetPropertiesList": [
{
"ImageSetWorkflowStatus": "UPDATED",
"versionId": "4",
"updatedAt": 1680029436.304,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"createdAt": 1680027126.436
},
{
"ImageSetWorkflowStatus": "UPDATED",
"versionId": "3",
"updatedAt": 1680029163.325,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"createdAt": 1680027126.436
},
{
"ImageSetWorkflowStatus": "COPY_FAILED",
"versionId": "2",
"updatedAt": 1680027455.944,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"message": "INVALID_REQUEST: Series of SourceImageSet and DestinationImageSet don't match.",
"createdAt": 1680027126.436
},
{
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "ACTIVE",
"versionId": "1",
"ImageSetWorkflowStatus": "COPIED",
"createdAt": 1680027126.436
}
]
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing image set versions](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImageSetVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-image-set-versions.html)」を参照してください。
### `list-tags-for-resource`
次のコード例は、`list-tags-for-resource` を使用する方法を示しています。
**AWS CLI**
**例 1：データストアリソースのタグを一覧表示するには**
次の `list-tags-for-resource` コード例では、データストアのタグを一覧表示しています。
```
aws medical-imaging list-tags-for-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012"
```
出力:
```
{
"tags":{
"Deployment":"Development"
}
}
```
**例 2：画像セットリソースのタグを一覧表示するには**
次の `list-tags-for-resource` コード例では、画像セットのタグを一覧表示しています。
```
aws medical-imaging list-tags-for-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b"
```
出力:
```
{
"tags":{
"Deployment":"Development"
}
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-tags-for-resource.html)」を参照してください。
### `search-image-sets`
次のコード例は、`search-image-sets` を使用する方法を示しています。
**AWS CLI**
**例 1：EQUAL 演算子を使用して画像セットを検索するには**
次の `search-image-sets` コード例では、EQUAL 演算子を使用し、特定の値に基づいて画像セットを検索しています。
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
`search-criteria.json` の内容
```
{
"filters": [{
"values": [{"DICOMPatientId" : "SUBJECT08701"}],
"operator": "EQUAL"
}]
}
```
出力:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"updatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**例 2：DICOMStudyDate と DICOMStudyTime を使用することで、BETWEEN 演算子を使用して画像セットを検索するには**
次の `search-image-sets` コード例では、1990 年 1 月 1 日 (午前 0 時) から 2023 年 1 月 1 日 (午前 0 時) の間に生成された DICOM スタディを含む画像セットを検索します。
注：DICOMStudyTime は選択可能です。入力されていない場合は、フィルターで指定された日付の時間値は午前 0 時 (1 日の始まり) になります。
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
`search-criteria.json` の内容
```
{
"filters": [{
"values": [{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "19900101",
"DICOMStudyTime": "000000"
}
},
{
"DICOMStudyDateAndTime": {
"DICOMStudyDate": "20230101",
"DICOMStudyTime": "000000"
}
}],
"operator": "BETWEEN"
}]
}
```
出力:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"updatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**例 3：createdAt を使用して BETWEEN 演算子を使用して画像セットを検索するには (スタディが以前に保存されていた時間)**
次の `search-image-sets` コード例では、UTC タイムゾーンの時間範囲の間で、HealthImaging に保持されている DICOM スタディを含む画像セットを検索します。
注：createdAt をサンプル形式 ("1985-04-12T23:20:50.52Z") で提供してください。
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
`search-criteria.json` の内容
```
{
"filters": [{
"values": [{
"createdAt": "1985-04-12T23:20:50.52Z"
},
{
"createdAt": "2022-04-12T23:20:50.52Z"
}],
"operator": "BETWEEN"
}]
}
```
出力:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
**例 4: DICOMSeriesInstanceUID で EQUAL 演算子を使用し、updatedAt で BETWEEN 演算子を使用して画像セットを検索し、updatedAt フィールドのレスポンスを ASC 順序でソートするには**
次の `search-image-sets` コード例では、DICOMSeriesInstanceUID で EQUAL 演算子を使用し、updatedAt で BETWEEN 演算子を使用して画像セットを検索し、updatedAt フィールドのレスポンスを ASC 順序でソートします。
注: updatedAt をサンプル形式 ("1985-04-12T23:20:50.52Z") で提供してください。
```
aws medical-imaging search-image-sets \
--datastore-id 12345678901234567890123456789012 \
--search-criteria file://search-criteria.json
```
`search-criteria.json` の内容
```
{
"filters": [{
"values": [{
"updatedAt": "2024-03-11T15:00:05.074000-07:00"
}, {
"updatedAt": "2024-03-11T16:00:05.074000-07:00"
}],
"operator": "BETWEEN"
}, {
"values": [{
"DICOMSeriesInstanceUID": "1.2.840.99999999.84710745.943275268089"
}],
"operator": "EQUAL"
}],
"sort": {
"sortField": "updatedAt",
"sortOrder": "ASC"
}
}
```
出力:
```
{
"imageSetsMetadataSummaries": [{
"imageSetId": "09876543210987654321098765432109",
"createdAt": "2022-12-06T21:40:59.429000+00:00",
"version": 1,
"DICOMTags": {
"DICOMStudyId": "2011201407",
"DICOMStudyDate": "19991122",
"DICOMPatientSex": "F",
"DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
"DICOMPatientBirthDate": "19201120",
"DICOMStudyDescription": "UNKNOWN",
"DICOMPatientId": "SUBJECT08701",
"DICOMPatientName": "Melissa844 Huel628",
"DICOMNumberOfStudyRelatedInstances": 1,
"DICOMStudyTime": "140728",
"DICOMNumberOfStudyRelatedSeries": 1
},
"lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
}]
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Searching image sets](https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchImageSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/search-image-sets.html)」を参照してください。
### `start-dicom-import-job`
次のコード例は、`start-dicom-import-job` を使用する方法を示しています。
**AWS CLI**
**DICOM インポートジョブを開始するには**
次の `start-dicom-import-job` コード例では、DICOM インポートジョブを開始しています。
```
aws medical-imaging start-dicom-import-job \
--job-name "my-job" \
--datastore-id "12345678901234567890123456789012" \
--input-s3-uri "s3://medical-imaging-dicom-input/dicom_input/" \
--output-s3-uri "s3://medical-imaging-output/job_output/" \
--data-access-role-arn "arn:aws:iam::123456789012:role/ImportJobDataAccessRole"
```
出力:
```
{
"datastoreId": "12345678901234567890123456789012",
"jobId": "09876543210987654321098765432109",
"jobStatus": "SUBMITTED",
"submittedAt": "2022-08-12T11:28:11.152000+00:00"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Starting an import job](https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/start-dicom-import-job.html)」を参照してください。
### `tag-resource`
次のコード例は、`tag-resource` を使用する方法を示しています。
**AWS CLI**
**例 1：データストアにタグを付けるには**
次の `tag-resource` コード例では、データストアにタグを付けています。
```
aws medical-imaging tag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
--tags '{"Deployment":"Development"}'
```
このコマンドでは何も出力されません。
**例 2：画像セットにタグを付けるには**
次の `tag-resource` コード例では、画像セットにタグを付けています。
```
aws medical-imaging tag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
--tags '{"Deployment":"Development"}'
```
このコマンドでは何も出力されません。
詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/tag-resource.html)」を参照してください。
### `untag-resource`
次のコード例は、`untag-resource` を使用する方法を示しています。
**AWS CLI**
**例 1：データストアのタグを削除するには**
次の `untag-resource` コード例では、データストアにタグを削除します。
```
aws medical-imaging untag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
--tag-keys '["Deployment"]'
```
このコマンドでは何も出力されません。
**例 2：画像セットにタグを削除するには**
次の `untag-resource` コード例では、画像セットにタグを削除します。
```
aws medical-imaging untag-resource \
--resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
--tag-keys '["Deployment"]'
```
このコマンドでは何も出力されません。
詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/untag-resource.html)」を参照してください。
### `update-image-set-metadata`
次のコード例は、`update-image-set-metadata` を使用する方法を示しています。
**AWS CLI**
**例 1: 画像セットメタデータに属性を挿入または更新するには**
次の `update-image-set-metadata` の例では、画像セットメタデータに属性を挿入または更新します。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"MX^MX\"}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**例 2: 画像セットメタデータから属性を削除するには**
次の `update-image-set-metadata` の例では、画像セットメタデータから属性を削除します。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"removableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"DICOM\":{\"StudyDescription\":\"CHEST\"}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**例 3: 画像セットメタデータからインスタンスを削除するには**
次の `update-image-set-metadata` の例では、画像セットメタデータからインスタンスを削除します。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id ea92b0d8838c72a3f25d00d13616f87e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates file://metadata-updates.json \
--force
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"removableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {}}}}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**例 4: 画像セットを以前のバージョンに戻すには**
次の `update-image-set-metadata` の例は、画像セットを以前のバージョンに戻す方法を示しています。CopyImageSet および UpdateImageSetMetadata アクションは、新しいバージョンの画像セットを作成します。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 3 \
--cli-binary-format raw-in-base64-out \
--update-image-set-metadata-updates '{"revertToVersionId": "1"}'
```
出力:
```
{
"datastoreId": "12345678901234567890123456789012",
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"latestVersionId": "4",
"imageSetState": "LOCKED",
"imageSetWorkflowStatus": "UPDATING",
"createdAt": 1680027126.436,
"updatedAt": 1680042257.908
}
```
**例 5: インスタンスにプライベート DICOM データ要素を追加するには**
次の `update-image-set-metadata` の例は、画像セット内で指定されたインスタンスにプライベート要素を追加する方法を示しています。DICOM 標準では、標準データ要素に含めることができない情報の通信に、プライベートデータ要素が許可されます。UpdateImageSetMetadata アクションを使用して、プライベートデータ要素を作成、更新、削除できます。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"001910F9\": \"97\"},\"DICOMVRs\": {\"001910F9\": \"DS\"}}}}}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**例 6: プライベート DICOM データ要素をインスタンスに対して更新するには**
次の `update-image-set-metadata` の例は、画像セット内のインスタンスに属するプライベートデータ要素の値を更新する方法を示しています。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"00091001\": \"GE_GENESIS_DD\"}}}}}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
**例 7: force パラメータを使用して SOPInstanceUID を更新するには**
次の `update-image-set-metadata` の例は、force パラメータを使用して SOPInstanceUID を更新し、DICOM メタデータの制約をオーバーライドする方法を示しています。
```
aws medical-imaging update-image-set-metadata \
--datastore-id 12345678901234567890123456789012 \
--image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
--latest-version-id 1 \
--cli-binary-format raw-in-base64-out \
--force \
--update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` の内容
```
{
"DICOMUpdates": {
"updatableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3656.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.0\":{\"DICOM\":{\"SOPInstanceUID\":\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.9\"}}}}}}}"
}
}
```
出力:
```
{
"latestVersionId": "2",
"imageSetWorkflowStatus": "UPDATING",
"updatedAt": 1680042257.908,
"imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
"imageSetState": "LOCKED",
"createdAt": 1680027126.436,
"datastoreId": "12345678901234567890123456789012"
}
```
詳細については、「*AWS HealthImaging Developer Guide*」の「[Updating image set metadata](https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/update-image-set-metadata.html)」を参照してください。