aws-sdk-medicalimaging 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2cb5ed9a6a23a77b1ee7fe53c8d81971d71a02d8d8439efbe7c3851c1da2c6
-  data.tar.gz: 9c49a91c69c397abd68d198c7dd0928593ba795b939eede258f46254871cde41
+  metadata.gz: '0038410ac54a81349bf45ded66e01c383e1918483c1192b8daceaea021e07a40'
+  data.tar.gz: 52c29ce2e1ccd8cae0e862affe3839c240e515bf1b48e9120fd56633d2f9106d
 SHA512:
-  metadata.gz: a497e068be31a95909933ce34d270616d2418d37adec348932c6e1fdb32260fdd1add3ca4ed8558fd9179d23736cb9db487e6829031709bf1f8490e543adea2c
-  data.tar.gz: d07a694f2c04ce6c1eb7e466f7152e61891b4e7664c44ef12a4789747247bcb413a6f8d45e7e31759c833c646ae5827eac606883aa03e9adacca63cd12ed07ec
+  metadata.gz: 8390170a433efe197fd08cd0ed2773794b59ab0c4f2554bf1e6e3b739b35b2553e7ead97b21390e63a808534f858e1a02d95119dcc1795411e00dcc1aa029284
+  data.tar.gz: 619f65a77dfd8074f7686478abec28582503c381a7a45640389b85e2d133edd96068265b467d55e6b4e2ae39e359429f28cc56cf3f22fefab37f39d623fc0a66

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.29.0 (2025-06-30)
+------------------
+
+* Feature - Added new fields to support the concept of primary image sets within the storage hierarchy.
+
 1.28.0 (2025-06-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.28.0
+1.29.0

data/lib/aws-sdk-medicalimaging/client.rb

@@ -481,9 +481,16 @@ module Aws::MedicalImaging
     #   Copy image set information.
     #
     # @option params [Boolean] :force
-    #   Setting this flag will force the `CopyImageSet` operation, even if
-    #   Patient, Study, or Series level metadata are mismatched across the
-    #   `sourceImageSet` and `destinationImageSet`.
+    #   Providing this parameter will force completion of the `CopyImageSet`
+    #   operation, even if there are inconsistent Patient, Study, and/or
+    #   Series level metadata elements between the `sourceImageSet` and
+    #   `destinationImageSet`.
+    #
+    # @option params [Boolean] :promote_to_primary
+    #   Providing this parameter will configure the `CopyImageSet` operation
+    #   to promote the given image set to the primary DICOM hierarchy. If
+    #   successful, a new primary image set ID will be returned as the
+    #   destination image set.
     #
     # @return [Types::CopyImageSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -509,6 +516,7 @@ module Aws::MedicalImaging
     #       },
     #     },
     #     force: false,
+    #     promote_to_primary: false,
     #   })
     #
     # @example Response structure
@@ -808,6 +816,7 @@ module Aws::MedicalImaging
     #   * {Types::GetImageSetResponse#message #message} => String
     #   * {Types::GetImageSetResponse#image_set_arn #image_set_arn} => String
     #   * {Types::GetImageSetResponse#overrides #overrides} => Types::Overrides
+    #   * {Types::GetImageSetResponse#is_primary #is_primary} => Boolean
     #
     # @example Request syntax with placeholder values
     #
@@ -830,6 +839,7 @@ module Aws::MedicalImaging
     #   resp.message #=> String
     #   resp.image_set_arn #=> String
     #   resp.overrides.forced #=> Boolean
+    #   resp.is_primary #=> Boolean
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSet AWS API Documentation
     #
@@ -1023,6 +1033,7 @@ module Aws::MedicalImaging
     #   resp.image_set_properties_list[0].deleted_at #=> Time
     #   resp.image_set_properties_list[0].message #=> String
     #   resp.image_set_properties_list[0].overrides.forced #=> Boolean
+    #   resp.image_set_properties_list[0].is_primary #=> Boolean
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListImageSetVersions AWS API Documentation
@@ -1119,6 +1130,7 @@ module Aws::MedicalImaging
     #                 dicom_study_date: "DICOMStudyDate", # required
     #                 dicom_study_time: "DICOMStudyTime",
     #               },
+    #               is_primary: false,
     #             },
     #           ],
     #           operator: "EQUAL", # required, accepts EQUAL, BETWEEN
@@ -1156,6 +1168,7 @@ module Aws::MedicalImaging
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_number #=> Integer
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_date #=> String
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_time #=> String
+    #   resp.image_sets_metadata_summaries[0].is_primary #=> Boolean
     #   resp.data.sort.sort_order #=> String, one of "ASC", "DESC"
     #   resp.data.sort.sort_field #=> String, one of "updatedAt", "createdAt", "DICOMStudyDateAndTime"
     #   resp.next_token #=> String
@@ -1382,7 +1395,7 @@ module Aws::MedicalImaging
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-medicalimaging'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-medicalimaging/client_api.rb

@@ -167,6 +167,7 @@ module Aws::MedicalImaging
     CopyImageSetRequest.add_member(:source_image_set_id, Shapes::ShapeRef.new(shape: ImageSetId, required: true, location: "uri", location_name: "sourceImageSetId"))
     CopyImageSetRequest.add_member(:copy_image_set_information, Shapes::ShapeRef.new(shape: CopyImageSetInformation, required: true, location_name: "copyImageSetInformation"))
     CopyImageSetRequest.add_member(:force, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "force"))
+    CopyImageSetRequest.add_member(:promote_to_primary, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "promoteToPrimary"))
     CopyImageSetRequest.struct_class = Types::CopyImageSetRequest
     CopyImageSetRequest[:payload] = :copy_image_set_information
     CopyImageSetRequest[:payload_member] = CopyImageSetRequest.member(:copy_image_set_information)
@@ -339,6 +340,7 @@ module Aws::MedicalImaging
     GetImageSetResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
     GetImageSetResponse.add_member(:image_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "imageSetArn"))
     GetImageSetResponse.add_member(:overrides, Shapes::ShapeRef.new(shape: Overrides, location_name: "overrides"))
+    GetImageSetResponse.add_member(:is_primary, Shapes::ShapeRef.new(shape: Boolean, location_name: "isPrimary"))
     GetImageSetResponse.struct_class = Types::GetImageSetResponse
 
     ImageFrameInformation.add_member(:image_frame_id, Shapes::ShapeRef.new(shape: ImageFrameId, required: true, location_name: "imageFrameId"))
@@ -353,6 +355,7 @@ module Aws::MedicalImaging
     ImageSetProperties.add_member(:deleted_at, Shapes::ShapeRef.new(shape: Date, location_name: "deletedAt"))
     ImageSetProperties.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
     ImageSetProperties.add_member(:overrides, Shapes::ShapeRef.new(shape: Overrides, location_name: "overrides"))
+    ImageSetProperties.add_member(:is_primary, Shapes::ShapeRef.new(shape: Boolean, location_name: "isPrimary"))
     ImageSetProperties.struct_class = Types::ImageSetProperties
 
     ImageSetPropertiesList.member = Shapes::ShapeRef.new(shape: ImageSetProperties)
@@ -364,6 +367,7 @@ module Aws::MedicalImaging
     ImageSetsMetadataSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Date, location_name: "createdAt"))
     ImageSetsMetadataSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Date, location_name: "updatedAt"))
     ImageSetsMetadataSummary.add_member(:dicom_tags, Shapes::ShapeRef.new(shape: DICOMTags, location_name: "DICOMTags"))
+    ImageSetsMetadataSummary.add_member(:is_primary, Shapes::ShapeRef.new(shape: Boolean, location_name: "isPrimary"))
     ImageSetsMetadataSummary.struct_class = Types::ImageSetsMetadataSummary
 
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
@@ -429,6 +433,7 @@ module Aws::MedicalImaging
     SearchByAttributeValue.add_member(:created_at, Shapes::ShapeRef.new(shape: Date, location_name: "createdAt"))
     SearchByAttributeValue.add_member(:updated_at, Shapes::ShapeRef.new(shape: Date, location_name: "updatedAt"))
     SearchByAttributeValue.add_member(:dicom_study_date_and_time, Shapes::ShapeRef.new(shape: DICOMStudyDateAndTime, location_name: "DICOMStudyDateAndTime"))
+    SearchByAttributeValue.add_member(:is_primary, Shapes::ShapeRef.new(shape: Boolean, location_name: "isPrimary"))
     SearchByAttributeValue.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     SearchByAttributeValue.add_member_subclass(:dicom_patient_id, Types::SearchByAttributeValue::DicomPatientId)
     SearchByAttributeValue.add_member_subclass(:dicom_accession_number, Types::SearchByAttributeValue::DicomAccessionNumber)
@@ -438,6 +443,7 @@ module Aws::MedicalImaging
     SearchByAttributeValue.add_member_subclass(:created_at, Types::SearchByAttributeValue::CreatedAt)
     SearchByAttributeValue.add_member_subclass(:updated_at, Types::SearchByAttributeValue::UpdatedAt)
     SearchByAttributeValue.add_member_subclass(:dicom_study_date_and_time, Types::SearchByAttributeValue::DicomStudyDateAndTime)
+    SearchByAttributeValue.add_member_subclass(:is_primary, Types::SearchByAttributeValue::IsPrimary)
     SearchByAttributeValue.add_member_subclass(:unknown, Types::SearchByAttributeValue::Unknown)
     SearchByAttributeValue.struct_class = Types::SearchByAttributeValue
 

data/lib/aws-sdk-medicalimaging/types.rb

@@ -136,9 +136,17 @@ module Aws::MedicalImaging
     #   @return [Types::CopyImageSetInformation]
     #
     # @!attribute [rw] force
-    #   Setting this flag will force the `CopyImageSet` operation, even if
-    #   Patient, Study, or Series level metadata are mismatched across the
-    #   `sourceImageSet` and `destinationImageSet`.
+    #   Providing this parameter will force completion of the `CopyImageSet`
+    #   operation, even if there are inconsistent Patient, Study, and/or
+    #   Series level metadata elements between the `sourceImageSet` and
+    #   `destinationImageSet`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] promote_to_primary
+    #   Providing this parameter will configure the `CopyImageSet` operation
+    #   to promote the given image set to the primary DICOM hierarchy. If
+    #   successful, a new primary image set ID will be returned as the
+    #   destination image set.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/CopyImageSetRequest AWS API Documentation
@@ -147,7 +155,8 @@ module Aws::MedicalImaging
       :datastore_id,
       :source_image_set_id,
       :copy_image_set_information,
-      :force)
+      :force,
+      :promote_to_primary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -766,6 +775,57 @@ module Aws::MedicalImaging
     # @!attribute [rw] content_type
     #   The format in which the image frame information is returned to the
     #   customer. Default is `application/octet-stream`.
+    #
+    #   <note markdown="1"> * If the stored transfer syntax is `1.2.840.10008.1.2.1`, the
+    #     returned `contentType` is `application/octet-stream`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is `1.2.840.10008.1.2.4.50`, the
+    #     returned `contentType` is `image/jpeg`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is `1.2.840.10008.1.2.4.91`, the
+    #     returned `contentType` is `image/j2c`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is MPEG2, `1.2.840.10008.1.2.4.100`,
+    #     `1.2.840.10008.1.2.4.100.1`, `1.2.840.10008.1.2.4.101`, or
+    #     `1.2.840.10008.1.2.4.101.1`, the returned `contentType` is
+    #     `video/mpeg`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is MPEG-4 AVC/H.264, UID
+    #     `1.2.840.10008.1.2.4.102`, `1.2.840.10008.1.2.4.102.1`,
+    #     `1.2.840.10008.1.2.4.103`, `1.2.840.10008.1.2.4.103.1`,
+    #     `1.2.840.10008.1.2.4.104`, `1.2.840.10008.1.2.4.104.1`,
+    #     `1.2.840.10008.1.2.4.105`, `1.2.840.10008.1.2.4.105.1`,
+    #     `1.2.840.10008.1.2.4.106`, or `1.2.840.10008.1.2.4.106.1`, the
+    #     returned `contentType` is `video/mp4`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is HEVC/H.265, UID
+    #     `1.2.840.10008.1.2.4.107` or `1.2.840.10008.1.2.4.108`, the
+    #     returned `contentType` is `video/H256`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is `1.2.840.10008.1.2.4.202` or if
+    #     the stored transfer syntax is *missing*, the returned
+    #     `contentType` is `image/jph`.
+    #
+    #   ^
+    #
+    #    * If the stored transfer syntax is `1.2.840.10008.1.2.4.203`, the
+    #     returned contentType is `image/jphc`.
+    #
+    #   ^
+    #
+    #    </note>
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageFrameResponse AWS API Documentation
@@ -893,6 +953,10 @@ module Aws::MedicalImaging
     #   `forced` flag.
     #   @return [Types::Overrides]
     #
+    # @!attribute [rw] is_primary
+    #   The flag to determine whether the image set is primary or not.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/GetImageSetResponse AWS API Documentation
     #
     class GetImageSetResponse < Struct.new(
@@ -906,7 +970,8 @@ module Aws::MedicalImaging
       :deleted_at,
       :message,
       :image_set_arn,
-      :overrides)
+      :overrides,
+      :is_primary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -965,6 +1030,10 @@ module Aws::MedicalImaging
     #   `forced` flag was used when creating the image set.
     #   @return [Types::Overrides]
     #
+    # @!attribute [rw] is_primary
+    #   The flag to determine whether the image set is primary or not.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ImageSetProperties AWS API Documentation
     #
     class ImageSetProperties < Struct.new(
@@ -976,7 +1045,8 @@ module Aws::MedicalImaging
       :updated_at,
       :deleted_at,
       :message,
-      :overrides)
+      :overrides,
+      :is_primary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1004,6 +1074,10 @@ module Aws::MedicalImaging
     #   The DICOM tags associated with the image set.
     #   @return [Types::DICOMTags]
     #
+    # @!attribute [rw] is_primary
+    #   The flag to determine whether the image set is primary or not.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ImageSetsMetadataSummary AWS API Documentation
     #
     class ImageSetsMetadataSummary < Struct.new(
@@ -1011,7 +1085,8 @@ module Aws::MedicalImaging
       :version,
       :created_at,
       :updated_at,
-      :dicom_tags)
+      :dicom_tags,
+      :is_primary)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1243,9 +1318,9 @@ module Aws::MedicalImaging
     # `CopyImageSet` and `UpdateImageSetMetadata`.
     #
     # @!attribute [rw] forced
-    #   Setting this flag will force the `CopyImageSet` and
-    #   `UpdateImageSetMetadata` operations, even if Patient, Study, or
-    #   Series level metadata are mismatched.
+    #   Providing this parameter will force completion of the `CopyImageSet`
+    #   and `UpdateImageSetMetadata` actions, even if metadata is
+    #   inconsistent at the Patient, Study, and/or Series levels.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/Overrides AWS API Documentation
@@ -1306,6 +1381,10 @@ module Aws::MedicalImaging
     #   for search.
     #   @return [Types::DICOMStudyDateAndTime]
     #
+    # @!attribute [rw] is_primary
+    #   The primary image set flag provided for search.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchByAttributeValue AWS API Documentation
     #
     class SearchByAttributeValue < Struct.new(
@@ -1317,6 +1396,7 @@ module Aws::MedicalImaging
       :created_at,
       :updated_at,
       :dicom_study_date_and_time,
+      :is_primary,
       :unknown)
       SENSITIVE = [:dicom_patient_id, :dicom_accession_number, :dicom_study_id, :dicom_study_instance_uid, :dicom_series_instance_uid]
       include Aws::Structure
@@ -1330,6 +1410,7 @@ module Aws::MedicalImaging
       class CreatedAt < SearchByAttributeValue; end
       class UpdatedAt < SearchByAttributeValue; end
       class DicomStudyDateAndTime < SearchByAttributeValue; end
+      class IsPrimary < SearchByAttributeValue; end
       class Unknown < SearchByAttributeValue; end
     end
 

data/lib/aws-sdk-medicalimaging.rb

@@ -55,7 +55,7 @@ module Aws::MedicalImaging
   autoload :EndpointProvider, 'aws-sdk-medicalimaging/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-medicalimaging/endpoints'
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.29.0'
 
 end
 

data/sig/client.rbs

@@ -99,7 +99,8 @@ module Aws
                                 latest_version_id: ::String
                               }?
                             },
-                            ?force: bool
+                            ?force: bool,
+                            ?promote_to_primary: bool
                           ) -> _CopyImageSetResponseSuccess
                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CopyImageSetResponseSuccess
 
@@ -191,6 +192,7 @@ module Aws
         def message: () -> ::String
         def image_set_arn: () -> ::String
         def overrides: () -> Types::Overrides
+        def is_primary: () -> bool
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MedicalImaging/Client.html#get_image_set-instance_method
       def get_image_set: (
@@ -289,7 +291,8 @@ module Aws
                                          dicom_study_date_and_time: {
                                            dicom_study_date: ::String,
                                            dicom_study_time: ::String?
-                                         }?
+                                         }?,
+                                         is_primary: bool?
                                        },
                                      ],
                                      operator: ("EQUAL" | "BETWEEN")

data/sig/types.rbs

@@ -46,6 +46,7 @@ module Aws::MedicalImaging
       attr_accessor source_image_set_id: ::String
       attr_accessor copy_image_set_information: Types::CopyImageSetInformation
       attr_accessor force: bool
+      attr_accessor promote_to_primary: bool
       SENSITIVE: []
     end
 
@@ -258,6 +259,7 @@ module Aws::MedicalImaging
       attr_accessor message: ::String
       attr_accessor image_set_arn: ::String
       attr_accessor overrides: Types::Overrides
+      attr_accessor is_primary: bool
       SENSITIVE: []
     end
 
@@ -276,6 +278,7 @@ module Aws::MedicalImaging
       attr_accessor deleted_at: ::Time
       attr_accessor message: ::String
       attr_accessor overrides: Types::Overrides
+      attr_accessor is_primary: bool
       SENSITIVE: []
     end
 
@@ -285,6 +288,7 @@ module Aws::MedicalImaging
       attr_accessor created_at: ::Time
       attr_accessor updated_at: ::Time
       attr_accessor dicom_tags: Types::DICOMTags
+      attr_accessor is_primary: bool
       SENSITIVE: []
     end
 
@@ -382,6 +386,7 @@ module Aws::MedicalImaging
       attr_accessor created_at: ::Time
       attr_accessor updated_at: ::Time
       attr_accessor dicom_study_date_and_time: Types::DICOMStudyDateAndTime
+      attr_accessor is_primary: bool
       attr_accessor unknown: untyped
       SENSITIVE: [:dicom_patient_id, :dicom_accession_number, :dicom_study_id, :dicom_study_instance_uid, :dicom_series_instance_uid]
 
@@ -401,6 +406,8 @@ module Aws::MedicalImaging
       end
       class DicomStudyDateAndTime < SearchByAttributeValue
       end
+      class IsPrimary < SearchByAttributeValue
+      end
       class Unknown < SearchByAttributeValue
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-medicalimaging
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Amazon Web Services