AWS API Changes

2025/06/30 - AWS Health Imaging - 4 updated api methods

Changes Added new fields to support the concept of primary image sets within the storage hierarchy.

CopyImageSet (updated)

Link ¶
Changes (request)

{'promoteToPrimary': 'boolean'}

Copy an image set.

See also: AWS API Documentation

Request Syntax

client.copy_image_set(
    datastoreId='string',
    sourceImageSetId='string',
    copyImageSetInformation={
        'sourceImageSet': {
            'latestVersionId': 'string',
            'DICOMCopies': {
                'copiableAttributes': 'string'
            }
        },
        'destinationImageSet': {
            'imageSetId': 'string',
            'latestVersionId': 'string'
        }
    },
    force=True|False,
    promoteToPrimary=True|False
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type sourceImageSetId:

string

param sourceImageSetId:

[REQUIRED]

The source image set identifier.

type copyImageSetInformation:

dict

param copyImageSetInformation:

[REQUIRED]

Copy image set information.

sourceImageSet (dict) -- [REQUIRED]

The source image set.
- latestVersionId (string) -- [REQUIRED]
  
  The latest version identifier for the source image set.
- DICOMCopies (dict) --
  
  Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.
  - copiableAttributes (string) -- [REQUIRED]
    
    The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
destinationImageSet (dict) --

The destination image set.
- imageSetId (string) -- [REQUIRED]
  
  The image set identifier for the destination image set.
- latestVersionId (string) -- [REQUIRED]
  
  The latest version identifier for the destination image set.

type force:

boolean

param force:

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.

type promoteToPrimary:

boolean

param promoteToPrimary:

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.

rtype:

dict

returns:

Response Syntax

{
    'datastoreId': 'string',
    'sourceImageSetProperties': {
        'imageSetId': 'string',
        'latestVersionId': 'string',
        'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
        'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'imageSetArn': 'string'
    },
    'destinationImageSetProperties': {
        'imageSetId': 'string',
        'latestVersionId': 'string',
        'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
        'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'imageSetArn': 'string'
    }
}

Response Structure

(dict) --
- datastoreId (string) --
  
  The data store identifier.
- sourceImageSetProperties (dict) --
  
  The properties of the source image set.
  - imageSetId (string) --
    
    The image set identifier for the copied source image set.
  - latestVersionId (string) --
    
    The latest version identifier for the copied source image set.
  - imageSetState (string) --
    
    The image set state of the copied source image set.
  - imageSetWorkflowStatus (string) --
    
    The workflow status of the copied source image set.
  - createdAt (datetime) --
    
    The timestamp when the source image set properties were created.
  - updatedAt (datetime) --
    
    The timestamp when the source image set properties were updated.
  - imageSetArn (string) --
    
    The Amazon Resource Name (ARN) assigned to the source image set.
- destinationImageSetProperties (dict) --
  
  The properties of the destination image set.
  - imageSetId (string) --
    
    The image set identifier of the copied image set properties.
  - latestVersionId (string) --
    
    The latest version identifier for the destination image set properties.
  - imageSetState (string) --
    
    The image set state of the destination image set properties.
  - imageSetWorkflowStatus (string) --
    
    The image set workflow status of the destination image set properties.
  - createdAt (datetime) --
    
    The timestamp when the destination image set properties were created.
  - updatedAt (datetime) --
    
    The timestamp when the destination image set properties were last updated.
  - imageSetArn (string) --
    
    The Amazon Resource Name (ARN) assigned to the destination image set.

GetImageSet (updated)

Link ¶
Changes (response)

{'isPrimary': 'boolean'}

Get image set properties.

See also: AWS API Documentation

Request Syntax

client.get_image_set(
    datastoreId='string',
    imageSetId='string',
    versionId='string'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type imageSetId:

string

param imageSetId:

[REQUIRED]

The image set identifier.

type versionId:

string

param versionId:

The image set version identifier.

rtype:

dict

returns:

Response Syntax

{
    'datastoreId': 'string',
    'imageSetId': 'string',
    'versionId': 'string',
    'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
    'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'deletedAt': datetime(2015, 1, 1),
    'message': 'string',
    'imageSetArn': 'string',
    'overrides': {
        'forced': True|False
    },
    'isPrimary': True|False
}

Response Structure

(dict) --
- datastoreId (string) --
  
  The data store identifier.
- imageSetId (string) --
  
  The image set identifier.
- versionId (string) --
  
  The image set version identifier.
- imageSetState (string) --
  
  The image set state.
- imageSetWorkflowStatus (string) --
  
  The image set workflow status.
- createdAt (datetime) --
  
  The timestamp when image set properties were created.
- updatedAt (datetime) --
  
  The timestamp when image set properties were updated.
- deletedAt (datetime) --
  
  The timestamp when the image set properties were deleted.
- message (string) --
  
  The error message thrown if an image set action fails.
- imageSetArn (string) --
  
  The Amazon Resource Name (ARN) assigned to the image set.
- overrides (dict) --
  
  This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
  - forced (boolean) --
    
    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.
- isPrimary (boolean) --
  
  The flag to determine whether the image set is primary or not.

ListImageSetVersions (updated)

Link ¶
Changes (response)

{'imageSetPropertiesList': {'isPrimary': 'boolean'}}

List image set versions.

See also: AWS API Documentation

Request Syntax

client.list_image_set_versions(
    datastoreId='string',
    imageSetId='string',
    nextToken='string',
    maxResults=123
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type imageSetId:

string

param imageSetId:

[REQUIRED]

The image set identifier.

type nextToken:

string

param nextToken:

The pagination token used to request the list of image set versions on the next page.

type maxResults:

integer

param maxResults:

The max results count.

rtype:

dict

returns:

Response Syntax

{
    'imageSetPropertiesList': [
        {
            'imageSetId': 'string',
            'versionId': 'string',
            'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
            'ImageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'deletedAt': datetime(2015, 1, 1),
            'message': 'string',
            'overrides': {
                'forced': True|False
            },
            'isPrimary': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- imageSetPropertiesList (list) --
  
  Lists all properties associated with an image set.
  - (dict) --
    
    The image set properties.
    - imageSetId (string) --
      
      The image set identifier.
    - versionId (string) --
      
      The image set version identifier.
    - imageSetState (string) --
      
      The image set state.
    - ImageSetWorkflowStatus (string) --
      
      The image set workflow status.
    - createdAt (datetime) --
      
      The timestamp when the image set properties were created.
    - updatedAt (datetime) --
      
      The timestamp when the image set properties were updated.
    - deletedAt (datetime) --
      
      The timestamp when the image set properties were deleted.
    - message (string) --
      
      The error message thrown if an image set action fails.
    - overrides (dict) --
      
      Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.
      - forced (boolean) --
        
        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.
    - isPrimary (boolean) --
      
      The flag to determine whether the image set is primary or not.
- nextToken (string) --
  
  The pagination token used to retrieve the list of image set versions on the next page.

SearchImageSets (updated)

Link ¶
Changes (request, response)
Request

{'searchCriteria': {'filters': {'values': {'isPrimary': 'boolean'}}}}

Response

{'imageSetsMetadataSummaries': {'isPrimary': 'boolean'}}

Search image sets based on defined input attributes.

See also: AWS API Documentation

Request Syntax

client.search_image_sets(
    datastoreId='string',
    searchCriteria={
        'filters': [
            {
                'values': [
                    {
                        'DICOMPatientId': 'string',
                        'DICOMAccessionNumber': 'string',
                        'DICOMStudyId': 'string',
                        'DICOMStudyInstanceUID': 'string',
                        'DICOMSeriesInstanceUID': 'string',
                        'createdAt': datetime(2015, 1, 1),
                        'updatedAt': datetime(2015, 1, 1),
                        'DICOMStudyDateAndTime': {
                            'DICOMStudyDate': 'string',
                            'DICOMStudyTime': 'string'
                        },
                        'isPrimary': True|False
                    },
                ],
                'operator': 'EQUAL'|'BETWEEN'
            },
        ],
        'sort': {
            'sortOrder': 'ASC'|'DESC',
            'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime'
        }
    },
    maxResults=123,
    nextToken='string'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The identifier of the data store where the image sets reside.

type searchCriteria:

dict

param searchCriteria:

The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.

filters (list) --

The filters for the search criteria.
- (dict) --
  
  The search filter.
  - values (list) -- [REQUIRED]
    
    The search filter values.
    - (dict) --
      
      The search input attribute value.
      
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys can be set: DICOMPatientId, DICOMAccessionNumber, DICOMStudyId, DICOMStudyInstanceUID, DICOMSeriesInstanceUID, createdAt, updatedAt, DICOMStudyDateAndTime, isPrimary.
      - DICOMPatientId (string) --
        
        The patient ID input for search.
      - DICOMAccessionNumber (string) --
        
        The DICOM accession number for search.
      - DICOMStudyId (string) --
        
        The DICOM study ID for search.
      - DICOMStudyInstanceUID (string) --
        
        The DICOM study instance UID for search.
      - DICOMSeriesInstanceUID (string) --
        
        The Series Instance UID input for search.
      - createdAt (datetime) --
        
        The created at time of the image set provided for search.
      - updatedAt (datetime) --
        
        The timestamp input for search.
      - DICOMStudyDateAndTime (dict) --
        
        The aggregated structure containing DICOM study date and study time for search.
        
        DICOMStudyDate (string) -- [REQUIRED]
        
        The DICOM study date provided in yyMMdd format.
        
        DICOMStudyTime (string) --
        
        The DICOM study time provided in HHmmss.FFFFFF format.
      - isPrimary (boolean) --
        
        The primary image set flag provided for search.
  - operator (string) -- [REQUIRED]
    
    The search filter operator for imageSetDateTime.
sort (dict) --

The sort input for search criteria.
- sortOrder (string) -- [REQUIRED]
  
  The sort order for search criteria.
- sortField (string) -- [REQUIRED]
  
  The sort field for search criteria.

type maxResults:

integer

param maxResults:

The maximum number of results that can be returned in a search.

type nextToken:

string

param nextToken:

The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

rtype:

dict

returns:

Response Syntax

{
    'imageSetsMetadataSummaries': [
        {
            'imageSetId': 'string',
            'version': 123,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'DICOMTags': {
                'DICOMPatientId': 'string',
                'DICOMPatientName': 'string',
                'DICOMPatientBirthDate': 'string',
                'DICOMPatientSex': 'string',
                'DICOMStudyInstanceUID': 'string',
                'DICOMStudyId': 'string',
                'DICOMStudyDescription': 'string',
                'DICOMNumberOfStudyRelatedSeries': 123,
                'DICOMNumberOfStudyRelatedInstances': 123,
                'DICOMAccessionNumber': 'string',
                'DICOMSeriesInstanceUID': 'string',
                'DICOMSeriesModality': 'string',
                'DICOMSeriesBodyPart': 'string',
                'DICOMSeriesNumber': 123,
                'DICOMStudyDate': 'string',
                'DICOMStudyTime': 'string'
            },
            'isPrimary': True|False
        },
    ],
    'sort': {
        'sortOrder': 'ASC'|'DESC',
        'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime'
    },
    'nextToken': 'string'
}

Response Structure

(dict) --
- imageSetsMetadataSummaries (list) --
  
  The model containing the image set results.
  - (dict) --
    
    Summary of the image set metadata.
    - imageSetId (string) --
      
      The image set identifier.
    - version (integer) --
      
      The image set version.
    - createdAt (datetime) --
      
      The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.
    - updatedAt (datetime) --
      
      The time an image set was last updated.
    - DICOMTags (dict) --
      
      The DICOM tags associated with the image set.
      - DICOMPatientId (string) --
        
        The unique identifier for a patient in a DICOM Study.
      - DICOMPatientName (string) --
        
        The patient name.
      - DICOMPatientBirthDate (string) --
        
        The patient birth date.
      - DICOMPatientSex (string) --
        
        The patient sex.
      - DICOMStudyInstanceUID (string) --
        
        The DICOM provided identifier for the Study Instance UID.
      - DICOMStudyId (string) --
        
        The DICOM provided identifier for the Study ID.
      - DICOMStudyDescription (string) --
        
        The DICOM provided Study Description.
      - DICOMNumberOfStudyRelatedSeries (integer) --
        
        The total number of series in the DICOM study.
      - DICOMNumberOfStudyRelatedInstances (integer) --
        
        The total number of instances in the DICOM study.
      - DICOMAccessionNumber (string) --
        
        The accession number for the DICOM study.
      - DICOMSeriesInstanceUID (string) --
        
        The DICOM provided identifier for the Series Instance UID.
      - DICOMSeriesModality (string) --
        
        The DICOM provided identifier for the series Modality.
      - DICOMSeriesBodyPart (string) --
        
        The DICOM provided identifier for the series Body Part Examined.
      - DICOMSeriesNumber (integer) --
        
        The DICOM provided identifier for the Series Number.
      - DICOMStudyDate (string) --
        
        The study date.
      - DICOMStudyTime (string) --
        
        The study time.
    - isPrimary (boolean) --
      
      The flag to determine whether the image set is primary or not.
- sort (dict) --
  
  The sort order for image set search results.
  - sortOrder (string) --
    
    The sort order for search criteria.
  - sortField (string) --
    
    The sort field for search criteria.
- nextToken (string) --
  
  The token for pagination results.