поиск-наборов-изображений

Описание

Поиск наборов изображений на основе заданных входных атрибутов.

Примечание

SearchImageSets принимает один параметр запроса поиска и возвращает постраничный ответ со всеми наборами изображений, соответствующими заданным критериям. Все запросы с диапазонами дат должны быть введены как (lowerBound, upperBound) .

По умолчанию, SearchImageSets использует поле updatedAt для сортировки в порядке убывания, от новых к старым.

См. также: Документация API AWS

search-image-sets является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: imageSetsMetadataSummaries

Синтаксис

  search-image-sets
--datastore-id <value>
[--search-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--datastore-id (строка)

Идентификатор хранилища данных, где находятся наборы изображений.

--search-criteria (структура)

Критерии поиска, которые фильтруют, применяя максимум 1 элемент к SearchByAttribute .

filters -> (список)

Фильтры для критериев поиска.

(структура)

Фильтр поиска.

values -> (список)

Значения фильтра поиска.

(меченый объединенный тип данных)

Значение входного атрибута поиска.

Примечание

Это структура меченного объединенного типа данных. Только один из следующих верхнеуровневых ключей может быть установлен: DICOMPatientId, DICOMAccessionNumber, DICOMStudyId, DICOMStudyInstanceUID, DICOMSeriesInstanceUID, createdAt, updatedAt, DICOMStudyDateAndTime.

DICOMPatientId -> (строка)

Идентификатор пациента для поиска.

DICOMAccessionNumber -> (строка)

Номер регистрации DICOM для поиска.

DICOMStudyId -> (строка)

Идентификатор исследования DICOM для поиска.

DICOMStudyInstanceUID -> (строка)

Идентификатор экземпляра исследования DICOM для поиска.

DICOMSeriesInstanceUID -> (строка)

Идентификатор серии экземпляра DICOM для поиска.

createdAt -> (метка времени)

Время создания набора изображений для поиска.

updatedAt -> (метка времени)

Временная метка для поиска.

DICOMStudyDateAndTime -> (структура)

Агрегированная структура, содержащая дату и время исследования DICOM для поиска.

DICOMStudyDate -> (строка)

Дата исследования DICOM в формате yyMMdd.

DICOMStudyTime -> (строка)

Время исследования DICOM в формате HHmmss.FFFFFF.

operator -> (строка)

Оператор фильтра поиска для imageSetDateTime .

sort -> (структура)

Входные данные для сортировки критериев поиска.

sortOrder -> (строка)

Порядок сортировки для критериев поиска.

sortField -> (строка)

Поле сортировки для критериев поиска.

Синтаксис JSON:

{
  "filters": [
    {
      "values": [
        {
          "DICOMPatientId": "string",
          "DICOMAccessionNumber": "string",
          "DICOMStudyId": "string",
          "DICOMStudyInstanceUID": "string",
          "DICOMSeriesInstanceUID": "string",
          "createdAt": timestamp,
          "updatedAt": timestamp,
          "DICOMStudyDateAndTime": {
            "DICOMStudyDate": "string",
            "DICOMStudyTime": "string"
          }
        }
        ...
      ],
      "operator": "EQUAL"|"BETWEEN"
    }
    ...
  ],
  "sort": {
    "sortOrder": "ASC"|"DESC",
    "sortField": "updatedAt"|"createdAt"|"DICOMStudyDateAndTime"
  }
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Передача произвольных бинарных значений с помощью значения, полученного из JSON, невозможна, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничного вывода. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которое нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода необходимо указать значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (булево)

Отключить автоматический постраничный вывод. Если автоматический постраничный вывод отключен, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

включено
выключено
автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для бинарных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что бинарные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и бинарные значения должны быть переданы буквально. При предоставлении содержимого файла, соответствующего бинарному блоку, fileb:// всегда будет обрабатываться как бинарное и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить постраничный вывод CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. Использование кавычек с строками в Руководстве пользователя 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: Поиск наборов изображений с оператором BETWEEN, используя DICOMStudyDate и DICOMStudyTime

В следующем search-image-sets примере кода осуществляется поиск наборов изображений с DICOM-исследованиями, созданными между 1 января 1990 года (00:00) и 1 января 2023 года (00:00).

Примечание: DICOMStudyTime необязательно. Если его нет, значение времени для указанных дат фильтрации — 00:00 (начало дня).

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: Поиск наборов изображений с оператором BETWEEN, используя createdAt (время сохранения исследований)

В следующем search-image-sets примере кода осуществляется поиск наборов изображений с DICOM-исследованиями, сохраненными в HealthImaging в диапазонах времени в часовом поясе UTC.

Примечание: Укажите 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: Поиск наборов изображений с оператором EQUAL на DICOMSeriesInstanceUID и BETWEEN на updatedAt, с сортировкой ответа в порядке возрастания по полю updatedAt

В следующем search-image-sets примере кода осуществляется поиск наборов изображений с оператором EQUAL на DICOMSeriesInstanceUID и BETWEEN на updatedAt, с сортировкой ответа в порядке возрастания по полю updatedAt.

Примечание: Укажите 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.

Вывод

imageSetsMetadataSummaries -> (список)

Модель, содержащая результаты поиска наборов изображений.

(структура)

Сводка метаданных набора изображений.

imageSetId -> (строка)

Идентификатор набора изображений.

version -> (целое число)

Версия набора изображений.

createdAt -> (временная метка)

Время создания набора изображений. Пример даты создания предоставлен в формате 1985-04-12T23:20:50.52Z.

updatedAt -> (временная метка)

Время последнего обновления набора изображений.

DICOMTags -> (структура)

DICOM-метки, связанные с набором изображений.

DICOMPatientId -> (строка)

Уникальный идентификатор пациента в DICOM-исследовании.

DICOMPatientName -> (строка)

Имя пациента.

DICOMPatientBirthDate -> (строка)

Дата рождения пациента.

DICOMPatientSex -> (строка)

Пол пациента.

DICOMStudyInstanceUID -> (строка)

Идентификатор, предоставленный DICOM для Study Instance UID.

DICOMStudyId -> (строка)

Идентификатор, предоставленный DICOM для Study ID.

DICOMStudyDescription -> (строка)

Описание DICOM-исследования.

DICOMNumberOfStudyRelatedSeries -> (целое число)

Общее количество серий в DICOM-исследовании.

DICOMNumberOfStudyRelatedInstances -> (целое число)

Общее количество экземпляров в DICOM-исследовании.

DICOMAccessionNumber -> (строка)

Номер регистрации для DICOM-исследования.

DICOMSeriesInstanceUID -> (строка)

Идентификатор, предоставленный DICOM для Series Instance UID.

DICOMSeriesModality -> (строка)

Идентификатор, предоставленный DICOM для Modality серии.

DICOMSeriesBodyPart -> (строка)

Идентификатор, предоставленный DICOM для Body Part Examined серии.

DICOMSeriesNumber -> (целое число)

Идентификатор, предоставленный DICOM для Series Number.

DICOMStudyDate -> (строка)

Дата исследования.

DICOMStudyTime -> (строка)

Время исследования.

sort -> (структура)

Порядок сортировки результатов поиска наборов изображений.

sortOrder -> (строка)

Порядок сортировки по критериям поиска.

sortField -> (строка)

Поле сортировки по критериям поиска.

nextToken -> (строка)

Токен для страниц результатов.