Обзор поиска в API Azure для FHIR

Спецификация "Ресурсы быстрого взаимодействия здравоохранения" (FHIR) определяет основы поиска ресурсов FHIR®. В этой статье описаны некоторые ключевые аспекты поиска ресурсов в FHIR. Полные сведения о поиске ресурсов FHIR см . в разделе "Поиск " в спецификации HL7 FHIR. В этой статье приведены примеры синтаксиса поиска. Каждый поиск находится на сервере FHIR, который обычно имеет URL-адрес https://<FHIRSERVERNAME>.azurewebsites.net. В примерах для этого URL-адреса используется заполнитель {{FHIR_URL}}.

Поиск FHIR может быть в отношении определенного типа ресурса, указанного отсека или всех ресурсов. Самый простой способ выполнения поиска в FHIR — использовать GET запрос. Например, если вы хотите извлечь всех пациентов в базе данных, можно использовать следующий запрос.

GET {{FHIR_URL}}/Patient

Вы также можете выполнить поиск по запросу POST, что полезно, если строка запроса длинна. Для поиска с POSTпомощью , параметры поиска можно подать в виде тела формы, что позволяет создавать более длинную и сложную серию параметров запроса, которые могут быть трудно увидеть и понять в строке запроса.

Если запрос поиска выполнен успешно, вы получите ответ пакета FHIR с типом searchset. Если поиск завершается ошибкой, вы можете найти сведения об ошибке в OperationOutcome этой статье, чтобы понять, почему поиск завершился ошибкой.

В следующих разделах мы рассмотрим различные аспекты, связанные с поиском. После изучения этих деталей обратитесь к нашей странице с примерами , где есть примеры поиска, которые можно выполнить в Azure API для FHIR.

Параметры поиска

Поиски основаны на различных атрибутах ресурса. Эти атрибуты называются параметрами поиска. Каждый ресурс имеет набор определенных параметров поиска. Параметр поиска должен быть определен и индексирован в базе данных для успешного поиска по нему.

Каждый параметр поиска имеет определенные типы данных. В следующей таблице описана поддержка различных типов данных.

Распространенные параметры поиска

Существуют распространенные параметры поиска, которые применяются ко всем ресурсам. Эти параметры приведены в следующем списке вместе с их поддержкой в Azure API для FHIR.

Параметры, относящиеся к ресурсу

С помощью Azure API для FHIR мы поддерживаем почти все параметры поиска, относящиеся к ресурсам, определенные спецификацией FHIR. В следующих ссылках доступны только параметры поиска, которые мы не поддерживаем.

• Неподдерживаемые параметры поиска STU3

• Неподдерживаемые параметры поиска R4

Вы также можете увидеть текущую поддержку параметров поиска в инструкции функции FHIR со следующим запросом.

GET {{FHIR_URL}}/metadata

Чтобы просмотреть параметры поиска в инструкции возможностей, перейдите к CapabilityStatement.rest.resource.searchParam просмотру параметров поиска для каждого ресурса и CapabilityStatement.rest.searchParam поиск параметров поиска для всех ресурсов.

Составные параметры поиска

Составной поиск позволяет выполнять поиск по парам значений. Например, если вы искали наблюдение высоты, где человек был 60 дюймов, необходимо убедиться, что один компонент наблюдения содержал код высоты и значение 60. Если нет, можно получить результаты, включающие 60, но не по росту. Например, вес 60 и рост 48. Оба параметра соответствуют условию поиска, но не в одном поле.

С помощью Azure API для FHIR мы поддерживаем следующие пары типов параметров поиска.

• Справочник, маркер
• Токен, дата
• Токен, число, число
• Токен, количество
• Токен, строка
• Токен, токен

Дополнительные сведения см. в параметрах составного поиска HL7.

Модификаторы и префиксы

Модификаторы позволяют изменять параметр поиска. В следующей таблице представлен обзор всех модификаторов FHIR и их поддержки в API Azure для FHIR.

Для параметров поиска, имеющих определенный порядок (числа, даты и количества), можно использовать префикс параметра для поиска совпадений. API Azure для FHIR поддерживает все префиксы.

Параметры результата поиска

Для управления возвращаемыми ресурсами можно использовать параметры результата поиска. Дополнительные сведения об использовании каждого из параметров результата поиска см. на веб-сайте HL7 .

По умолчанию API Azure для FHIR устанавливается на строгой обработку. Это означает, что сервер игнорирует любые неизвестные или неподдерживаемые параметры. Если вы хотите использовать строгую обработку, можно использовать заголовок "Предпочитать" и задать.handling=strict

Поиск в цепочке и обратной цепочке

Поиск в цепочке позволяет выполнять поиск с помощью параметра поиска в ресурсе, на который ссылается другой ресурс. Например, если вы хотите найти встречи, где имя пациента — Джейн, используйте следующую команду:

GET {{FHIR_URL}}/Encounter?subject:Patient.name=Jane.

Аналогичным образом можно также выполнять обратный связный поиск. Это позволяет получить ресурсы, указав критерии на других ресурсах, которые ссылаются на них. Дополнительные примеры цепочки и обратного поиска см. на странице примеров поиска FHIR.

Разбиение на страницы

Как упоминалось ранее, результаты поиска — это пакет страниц. По умолчанию поиск даёт 10 результатов на страницу, которые можно увеличить (или уменьшить) при указании _count. В пакете будет локальная ссылка, содержащая текущий результат поиска. Если есть другие совпадения, в наборе будет следующая ссылка. Чтобы получить последующие страницы результатов, можно продолжить использовать следующую ссылку. _count ограничено 1000 элементами или меньше.

Следующая ссылка в пакете имеет ограничение на размер маркера продолжения в 3 КБ. Вы можете настроить размер маркера продолжения в диапазоне от 1 КБ до 3 КБ, используя заголовок x-ms-documentdb-responsecontinuationtokenlimitinkb.

В настоящее время API Azure для FHIR поддерживает только следующую ссылку в пакетах, и она не поддерживает первые, последние или предыдущие ссылки.

Следующие шаги

Теперь, когда вы узнали об основах поиска, ознакомьтесь со страницей примеров поиска, чтобы узнать, как выполнять поиск с помощью различных параметров поиска, модификаторов и других сценариев поиска FHIR.