HealthImaging / Client / search_image_sets

search_image_sets

HealthImaging.Client.search_image_sets(**kwargs)

Search image sets based on defined input attributes.

See also: AWS API Documentation

Request Syntax

response = client.search_image_sets(
    datastoreId='string',
    searchCriteria={
        'filters': [
            {
                'values': [
                    {
                        'DICOMPatientId': 'string',
                        'DICOMAccessionNumber': 'string',
                        'DICOMStudyId': 'string',
                        'DICOMStudyInstanceUID': 'string',
                        'createdAt': datetime(2015, 1, 1),
                        'DICOMStudyDateAndTime': {
                            'DICOMStudyDate': 'string',
                            'DICOMStudyTime': 'string'
                        }
                    },
                ],
                'operator': 'EQUAL'|'BETWEEN'
            },
        ]
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• datastoreId (string) –

  [REQUIRED]

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

• searchCriteria (dict) –

  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, createdAt, DICOMStudyDateAndTime.

          • 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.

          • createdAt (datetime) –

            The created at time of the image set provided 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.

      • operator (string) – [REQUIRED]

        The search filter operator for imageSetDateTime.

• maxResults (integer) – The maximum number of results that can be returned in a search.

• nextToken (string) – 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.

Return type:

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',
                'DICOMStudyDate': 'string',
                'DICOMStudyTime': 'string'
            }
        },
    ],
    '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 in AWS HealthImaging. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.

      • updatedAt (datetime) –

        The time when an image was last updated in AWS HealthImaging.

      • 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 studyInstanceUid.>

        • DICOMStudyId (string) –

          The DICOM provided studyId.

        • DICOMStudyDescription (string) –

          The description of the study.

        • 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.

        • DICOMStudyDate (string) –

          The study date.

        • DICOMStudyTime (string) –

          The study time.

  • nextToken (string) –

    The token for pagination results.

Exceptions

• HealthImaging.Client.exceptions.ThrottlingException

• HealthImaging.Client.exceptions.ConflictException

• HealthImaging.Client.exceptions.AccessDeniedException

• HealthImaging.Client.exceptions.ValidationException

• HealthImaging.Client.exceptions.InternalServerException

• HealthImaging.Client.exceptions.ResourceNotFoundException