Skip to content

Commit a763a97

Browse files
author
AWS
committed
AWS Health Imaging Update: SearchImageSets API now supports following enhancements - Additional support for searching on UpdatedAt and SeriesInstanceUID - Support for searching existing filters between dates/times - Support for sorting the search result by Ascending/Descending - Additional parameters returned in the response
1 parent d3e828a commit a763a97

File tree

2 files changed

+102
-5
lines changed

2 files changed

+102
-5
lines changed

‎.changes/next-release/feature-AWSHealthImaging-261abb5.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Health Imaging",
4+
"contributor": "",
5+
"description": "SearchImageSets API now supports following enhancements - Additional support for searching on UpdatedAt and SeriesInstanceUID - Support for searching existing filters between dates/times - Support for sorting the search result by Ascending/Descending - Additional parameters returned in the response"
6+
}

‎services/medicalimaging/src/main/resources/codegen-resources/service-2.json

Lines changed: 96 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
{"shape":"InternalServerException"},
112112
{"shape":"ResourceNotFoundException"}
113113
],
114-
"documentation":"<p>Get the import job properties to learn more about the job or job progress.</p>"
114+
"documentation":"<p>Get the import job properties to learn more about the job or job progress.</p> <note> <p>The <code>jobStatus</code> refers to the execution of the import job. Therefore, an import job can return a <code>jobStatus</code> as <code>COMPLETED</code> even if validation issues are discovered during the import process. If a <code>jobStatus</code> returns as <code>COMPLETED</code>, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.</p> </note>"
115115
},
116116
"GetDatastore":{
117117
"name":"GetDatastore",
@@ -761,6 +761,32 @@
761761
"min":0,
762762
"sensitive":true
763763
},
764+
"DICOMSeriesBodyPart":{
765+
"type":"string",
766+
"max":64,
767+
"min":0,
768+
"sensitive":true
769+
},
770+
"DICOMSeriesInstanceUID":{
771+
"type":"string",
772+
"max":64,
773+
"min":0,
774+
"pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*",
775+
"sensitive":true
776+
},
777+
"DICOMSeriesModality":{
778+
"type":"string",
779+
"max":16,
780+
"min":0,
781+
"sensitive":true
782+
},
783+
"DICOMSeriesNumber":{
784+
"type":"integer",
785+
"box":true,
786+
"max":2147483647,
787+
"min":-2147483648,
788+
"sensitive":true
789+
},
764790
"DICOMStudyDate":{
765791
"type":"string",
766792
"max":18,
@@ -828,15 +854,15 @@
828854
},
829855
"DICOMStudyInstanceUID":{
830856
"shape":"DICOMStudyInstanceUID",
831-
"documentation":"<p>The DICOM provided identifier for studyInstanceUid.&gt;</p>"
857+
"documentation":"<p>The DICOM provided identifier for the Study Instance UID.</p>"
832858
},
833859
"DICOMStudyId":{
834860
"shape":"DICOMStudyId",
835-
"documentation":"<p>The DICOM provided studyId.</p>"
861+
"documentation":"<p>The DICOM provided identifier for the Study ID.</p>"
836862
},
837863
"DICOMStudyDescription":{
838864
"shape":"DICOMStudyDescription",
839-
"documentation":"<p>The description of the study.</p>"
865+
"documentation":"<p>The DICOM provided Study Description.</p>"
840866
},
841867
"DICOMNumberOfStudyRelatedSeries":{
842868
"shape":"DICOMNumberOfStudyRelatedSeries",
@@ -850,6 +876,22 @@
850876
"shape":"DICOMAccessionNumber",
851877
"documentation":"<p>The accession number for the DICOM study.</p>"
852878
},
879+
"DICOMSeriesInstanceUID":{
880+
"shape":"DICOMSeriesInstanceUID",
881+
"documentation":"<p>The DICOM provided identifier for the Series Instance UID.</p>"
882+
},
883+
"DICOMSeriesModality":{
884+
"shape":"DICOMSeriesModality",
885+
"documentation":"<p>The DICOM provided identifier for the series Modality.</p>"
886+
},
887+
"DICOMSeriesBodyPart":{
888+
"shape":"DICOMSeriesBodyPart",
889+
"documentation":"<p>The DICOM provided identifier for the series Body Part Examined.</p>"
890+
},
891+
"DICOMSeriesNumber":{
892+
"shape":"DICOMSeriesNumber",
893+
"documentation":"<p>The DICOM provided identifier for the Series Number.</p>"
894+
},
853895
"DICOMStudyDate":{
854896
"shape":"DICOMStudyDate",
855897
"documentation":"<p>The study date.</p>"
@@ -1692,10 +1734,18 @@
16921734
"shape":"DICOMStudyInstanceUID",
16931735
"documentation":"<p>The DICOM study instance UID for search.</p>"
16941736
},
1737+
"DICOMSeriesInstanceUID":{
1738+
"shape":"DICOMSeriesInstanceUID",
1739+
"documentation":"<p>The Series Instance UID input for search.</p>"
1740+
},
16951741
"createdAt":{
16961742
"shape":"Date",
16971743
"documentation":"<p>The created at time of the image set provided for search.</p>"
16981744
},
1745+
"updatedAt":{
1746+
"shape":"Date",
1747+
"documentation":"<p>The timestamp input for search.</p>"
1748+
},
16991749
"DICOMStudyDateAndTime":{
17001750
"shape":"DICOMStudyDateAndTime",
17011751
"documentation":"<p>The aggregated structure containing DICOM study date and study time for search.</p>"
@@ -1710,6 +1760,10 @@
17101760
"filters":{
17111761
"shape":"SearchCriteriaFiltersList",
17121762
"documentation":"<p>The filters for the search criteria.</p>"
1763+
},
1764+
"sort":{
1765+
"shape":"Sort",
1766+
"documentation":"<p>The sort input for search criteria.</p>"
17131767
}
17141768
},
17151769
"documentation":"<p>The search criteria.</p>",
@@ -1788,6 +1842,10 @@
17881842
"shape":"ImageSetsMetadataSummaries",
17891843
"documentation":"<p>The model containing the image set results.</p>"
17901844
},
1845+
"sort":{
1846+
"shape":"Sort",
1847+
"documentation":"<p>The sort order for image set search results.</p>"
1848+
},
17911849
"nextToken":{
17921850
"shape":"NextToken",
17931851
"documentation":"<p>The token for pagination results.</p>"
@@ -1807,6 +1865,39 @@
18071865
},
18081866
"exception":true
18091867
},
1868+
"Sort":{
1869+
"type":"structure",
1870+
"required":[
1871+
"sortOrder",
1872+
"sortField"
1873+
],
1874+
"members":{
1875+
"sortOrder":{
1876+
"shape":"SortOrder",
1877+
"documentation":"<p>The sort order for search criteria.</p>"
1878+
},
1879+
"sortField":{
1880+
"shape":"SortField",
1881+
"documentation":"<p>The sort field for search criteria.</p>"
1882+
}
1883+
},
1884+
"documentation":"<p>Sort search results.</p>"
1885+
},
1886+
"SortField":{
1887+
"type":"string",
1888+
"enum":[
1889+
"updatedAt",
1890+
"createdAt",
1891+
"DICOMStudyDateAndTime"
1892+
]
1893+
},
1894+
"SortOrder":{
1895+
"type":"string",
1896+
"enum":[
1897+
"ASC",
1898+
"DESC"
1899+
]
1900+
},
18101901
"StartDICOMImportJobRequest":{
18111902
"type":"structure",
18121903
"required":[
@@ -2050,5 +2141,5 @@
20502141
"exception":true
20512142
}
20522143
},
2053-
"documentation":"<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA-eligible service that helps health care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For an introduction to the service, see the <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html\"> <i>AWS HealthImaging Developer Guide</i> </a>.</p> <note> <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see <a href=\"http://aws.amazon.com/developer/tools\">Tools to build on AWS</a>.</p> <p>For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the <i>See Also</i> link at the end of each section that describes an API action or data type.</p> </note> <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the <i>AWS HealthImaging Developer Guide</i> where you can view console procedures and CLI/SDK code examples.</p> <p class=\"title\"> <b>Data store actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html\">CreateDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html\">Creating a data store</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html\">GetDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html\">Getting data store properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html\">ListDatastores</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html\">Listing data stores</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html\">DeleteDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html\">Deleting a data store</a>.</p> </li> </ul> <p class=\"title\"> <b>Import job actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_StartDICOMImportJob.html\">StartDICOMImportJob</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html\">Starting an import job</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDICOMImportJob.html\">GetDICOMImportJob</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html\">Getting import job properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDICOMImportJobs.html\">ListDICOMImportJobs</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html\">Listing import jobs</a>.</p> </li> </ul> <p class=\"title\"> <b>Image set access actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_SearchImageSets.html\">SearchImageSets</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html\">Searching image sets</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSet.html\">GetImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html\">Getting image set properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSetMetadata.html\">GetImageSetMetadata</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html\">Getting image set metadata</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageFrame.html\">GetImageFrame</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html\">Getting image set pixel data</a>.</p> </li> </ul> <p class=\"title\"> <b>Image set modification actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListImageSetVersions.html\">ListImageSetVersions</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html\">Listing image set versions</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UpdateImageSetMetadata.html\">UpdateImageSetMetadata</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html\">Updating image set metadata</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CopyImageSet.html\">CopyImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html\">Copying an image set</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteImageSet.html\">DeleteImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html\">Deleting an image set</a>.</p> </li> </ul> <p class=\"title\"> <b>Tagging actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html\">TagResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html\">Tagging a data store</a> and <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html\">Tagging an image set</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html\">ListTagsForResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html\">Tagging a data store</a> and <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html\">Tagging an image set</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html\">UntagResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-data-store.html\">Tagging a data store</a> and <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-list-untag-image-set.html\">Tagging an image set</a>.</p> </li> </ul>"
2144+
"documentation":"<p>This is the <i>AWS HealthImaging API Reference</i>. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html\"> <i>AWS HealthImaging Developer Guide</i> </a>.</p> <note> <p>We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see <a href=\"http://aws.amazon.com/developer/tools\">Tools to build on AWS</a>.</p> </note> <p>The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the <i>AWS HealthImaging Developer Guide</i> where you can view tested code examples.</p> <p class=\"title\"> <b>Data store actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html\">CreateDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html\">Creating a data store</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html\">GetDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html\">Getting data store properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html\">ListDatastores</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html\">Listing data stores</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html\">DeleteDatastore</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html\">Deleting a data store</a>.</p> </li> </ul> <p class=\"title\"> <b>Import job actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_StartDICOMImportJob.html\">StartDICOMImportJob</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html\">Starting an import job</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDICOMImportJob.html\">GetDICOMImportJob</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html\">Getting import job properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDICOMImportJobs.html\">ListDICOMImportJobs</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html\">Listing import jobs</a>.</p> </li> </ul> <p class=\"title\"> <b>Image set access actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_SearchImageSets.html\">SearchImageSets</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html\">Searching image sets</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSet.html\">GetImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html\">Getting image set properties</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSetMetadata.html\">GetImageSetMetadata</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html\">Getting image set metadata</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageFrame.html\">GetImageFrame</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html\">Getting image set pixel data</a>.</p> </li> </ul> <p class=\"title\"> <b>Image set modification actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListImageSetVersions.html\">ListImageSetVersions</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html\">Listing image set versions</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UpdateImageSetMetadata.html\">UpdateImageSetMetadata</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html\">Updating image set metadata</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CopyImageSet.html\">CopyImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html\">Copying an image set</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteImageSet.html\">DeleteImageSet</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html\">Deleting an image set</a>.</p> </li> </ul> <p class=\"title\"> <b>Tagging actions</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html\">TagResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html\">Tagging a resource</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html\">ListTagsForResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html\">Listing tags for a resource</a>.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html\">UntagResource</a> – See <a href=\"https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html\">Untagging a resource</a>.</p> </li> </ul>"
20542145
}

0 commit comments

Comments
 (0)