Доступ к службе FHIR с помощью Postman

В этой статье показано, как получить доступ к службе FHIR® в Службах данных работоспособности Azure с помощью Postman.

Необходимые компоненты

• Служба FHIR, развернутая в Azure. Дополнительные сведения см. в разделе "Развертывание службы FHIR".
• Postman установлен локально. Дополнительные сведения см. в статье "Начало работы с Postman".
• Роль администратора доступа пользователей для назначений ролей в службе FHIR.

Шаги установки

Чтобы получить доступ к службе FHIR из приложения Postman, ознакомьтесь с инструкциями.

1. Зарегистрируйте клиентское приложение (регистрация приложений) в идентификаторе Microsoft Entra.

2. Назначьте роль участника данных FHIR в службе FHIR.

3. Настройка Postman — создание рабочей области, коллекции и среды

Регистрация клиентского приложения в Microsoft Entra ID

1. В портал Azure выберите плитку Идентификатора Записи Майкрософт.

2. Выберите Регистрация приложений в разделе "Управление".

3. Выберите +Создать регистрацию.

4. Введите имя регистрации приложения. В разделе "Поддерживаемые типы учетных записей" выберите только учетные записи в этом каталоге организации. нажмите кнопку "Зарегистрировать".

ИД приложения (ИД клиента)

После регистрации нового приложения можно найти идентификатор приложения (клиента) и идентификатор каталога (клиента) в разделе "Обзор". Запишите эти значения для последующего использования, так как вам потребуется при настройке среды Postman.

Параметр проверки подлинности: конфиденциальный и общедоступный

• Выберите проверку подлинности, чтобы просмотреть параметры. Значением по умолчанию для разрешенных общедоступных потоков клиента является "Нет".

• При сохранении этого значения по умолчанию регистрация приложения является конфиденциальным клиентским приложением, а сертификат или секрет требуется.

• Если вы измените значение по умолчанию на "Да" для параметра "Разрешить общедоступные потоки клиентов" в расширенном параметре, регистрация приложения является общедоступным клиентским приложением, а сертификат или секрет не требуется.
  

• Значение "Да" полезно, если вы хотите использовать клиентское приложение в мобильном приложении или приложении JavaScript, где вы не хотите хранить секреты.

• Для инструментов, требующих URL-адреса перенаправления, выберите "Добавить платформу", чтобы настроить платформу.

• Для Postman выберите мобильные и классические приложения. Введите "https://www.getpostman.com/oauth2/callback" в разделе пользовательских URI перенаправления. Нажмите кнопку "Настройка", чтобы сохранить этот параметр.

Сертификаты и секреты

1. Щелкните сертификаты и секреты. Нажмите кнопку +Создать секрет клиента.

2. В разделе "Добавление секрета клиента" введите имя секрета в поле "Описание ". Руководство — установить 6 месяцев для истечения срока действия секрета. Нажмите кнопку Добавить.

3. Важно сохранить значение секрета, а не идентификатор секрета.

Назначение роли участника данных FHIR в службе FHIR

В этом разделе показано, как назначить роль участника данных FHIR зарегистрированным приложению для службы FHIR® в службах данных Работоспособности Azure.

1. В портал Azure перейдите к службе FHIR.

2. В меню слева выберите колонку контроль доступа (IAM). Нажмите кнопку +Добавить и выберите "Добавить назначение роли". Если параметр добавления назначения ролей недоступен, попросите администратора Azure назначить вам разрешение на выполнение этого шага.

3. В разделе "Добавление назначения ролей" на вкладке "Роль " прокрутите вниз в списке и выберите участника данных FHIR. Затем нажмите Далее.

4. На вкладке "Члены" нажмите кнопку +Выбрать участников. Введите имя клиентского приложения службы Postman в поле Select справа. Выберите приложение.

5. Таким же образом введите имя имени пользователя в элементе Select. Выберите пользователя, чтобы он был добавлен в список вместе с регистрацией приложения и нажмите кнопку "Выбрать". Затем нажмите Далее.

6. На вкладке "Рецензирование и назначение " нажмите кнопку "Рецензирование" и " Назначить".

Настройка Postman — создание рабочей области, коллекции и среды.

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

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

Затем создайте новую коллекцию, в которой можно сгруппировать все связанные запросы REST API. В рабочей области выберите "Создать коллекции". Имя новой коллекции по умолчанию можно сохранить или переименовать. Изменения сохраняются автоматически.

Вы также можете импортировать и экспортировать коллекции Postman. Дополнительные сведения см . в документации Postman.

Создание или обновление переменных среды

Хотя в запросе можно использовать полный URL-адрес, рекомендуется хранить URL-адрес и другие данные в переменных.

Чтобы получить доступ к службе FHIR, необходимо создать или обновить следующие переменные:

Получение инструкции возможностей

Введите {{fhirurl}}/metadata запрос GET , а затем выберите Send. Вы увидите инструкцию возможности службы FHIR.

Получение маркера доступа Microsoft Entra

Получите маркер доступа Microsoft Entra, выбрав субъект-службу или учетную запись пользователя Microsoft Entra.

Использование субъекта-службы с типом предоставления учетных данных клиента

Служба FHIR защищена идентификатором Microsoft Entra. Проверка подлинности по умолчанию не может быть отключена. Чтобы получить доступ к службе FHIR, сначала необходимо получить маркер доступа Microsoft Entra. Дополнительные сведения см. в разделе платформа удостоверений Майкрософт маркеры доступа.

Создайте новый POST запрос:

1. Введите заголовок запроса: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

2. Выберите вкладку "Текст" и выберите x-www-form-urlencoded. Введите следующие значения в разделе ключа и значения:

   • grant_type:Client_Credentials
   • client_id:{{clientid}}
   • client_secret:{{clientsecret}}
   • ресурс: {{fhirurl}}

3. Выберите вкладку "Тест" и введите pm.environment.set("bearerToken", pm.response.json().access_token); в текстовом разделе. Чтобы сделать значение доступным для коллекции, используйте метод pm.collectionVariables.set. Дополнительные сведения о методе set и его уровне области см. в разделе "Использование переменных в сценариях".
4. Нажмите кнопку Сохранить, чтобы сохранить параметры.
5. Выберите Отправить. Вы увидите ответ с маркером доступа Microsoft Entra, который автоматически сохраняется в переменной bearerToken. Затем его можно использовать во всех запросах API службы FHIR.

Маркер доступа можно проверить с помощью таких средств, как https://jwt.msИнтернет. Перейдите на вкладку "Утверждения", чтобы просмотреть подробные описания каждого утверждения в токене.

Использование учетной записи пользователя с типом предоставления кода авторизации

Маркер доступа Microsoft Entra можно получить с помощью учетных данных учетной записи Microsoft Entra и описанных ниже действий.

1. Убедитесь, что вы являетесь членом клиента Microsoft Entra с необходимыми разрешениями на доступ.

2. Убедитесь, что вы настроили URL-адрес https://oauth.pstmn.io/v1/callback перенаправления для веб-платформы в регистрации клиентского приложения.

3. В регистрации клиентского приложения в разделе "Разрешения API" добавьте User_Impersonation делегированное разрешение для API здравоохранения Azure из API, которые использует моя организация.

4. В Postman перейдите на вкладку "Авторизация " коллекции или определенного вызова REST, выберите "Тип " в качестве OAuth 2.0 и в разделе "Настройка нового маркера " задайте следующие значения:

   • URL-адрес обратного вызова: https://oauth.pstmn.io/v1/callback

   • URL-адрес проверки подлинности: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/authorize

   • URL-адрес маркера доступа: https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

   • Идентификатор клиента: идентификатор регистрации клиента приложения

   • Секрет клиента: секрет регистрации клиента приложения

   • Область: {{fhirurl}}/.default

   • Проверка подлинности клиента: отправка учетных данных клиента в тексте

5. Нажмите кнопку "Получить новый маркер доступа" в нижней части страницы.

6. Укажите учетные данные пользователя для входа.

7. После получения маркера нажмите кнопку "Использовать маркер".

8. Убедитесь, что маркер находится в заголовке авторизации вызова REST.

Проверьте маркер доступа с помощью таких средств, как https://jwt.msИнтернет. Перейдите на вкладку "Утверждения", чтобы просмотреть подробные описания каждого утверждения в токене.

Подключение к серверу FHIR

Откройте Postman, выберите рабочую область, коллекцию и среду , которую вы хотите использовать. + Выберите значок, чтобы создать новый запрос.

Чтобы выполнить проверку работоспособности службы FHIR, введите {{fhirurl}}/health/check запрос GET и нажмите кнопку "Отправить". Вы должны увидеть Status of FHIR service - HTTP Status ответ кода с 200 и OverallStatus как работоспособный в ответе, что означает, что проверка работоспособности выполнена успешно.

Получение ресурса FHIR

Получив маркер доступа Microsoft Entra, вы можете получить доступ к данным FHIR. В новом GET запросе введите {{fhirurl}}/Patient.

Выберите маркер носителя в качестве типа авторизации. Введите {{bearerToken}} раздел токена . Выберите Отправить. В качестве ответа вы увидите список пациентов в ресурсе FHIR.

Создание или обновление ресурса FHIR

Получив маркер доступа Microsoft Entra, вы можете создать или обновить данные FHIR. Например, можно создать нового пациента или обновить существующего пациента.

Создайте новый запрос, измените метод на Post и введите значение в разделе запроса.

{{fhirurl}}/Patient

Выберите маркер носителя в качестве типа авторизации. Введите {{bearerToken}} раздел токена . Выберите вкладку "Текст ". Выберите необработанный параметр и формат JSON в виде текста текста. Скопируйте и вставьте следующий текст в раздел текста.

{
    "resourceType": "Patient",
    "active": true,
    "name": [
        {
            "use": "official",
            "family": "Kirk",
            "given": [
                "James",
                "Tiberious"
            ]
        },
        {
            "use": "usual",
            "given": [
                "Jim"
            ]
        }
    ],
    "gender": "male",
    "birthDate": "1960-12-25"
}

Выберите Отправить. В ответе JSON должен появиться новый пациент.

Экспорт данных FHIR

Получив маркер доступа Microsoft Entra, вы можете экспортировать данные FHIR в учетную запись хранения Azure.

Чтобы настроить параметры экспорта и создать учетную запись Data Lake Storage 2-го поколения, см. раздел "Настройка параметров для экспорта".

Создайте новый GET запрос: {{fhirurl}}/$export?_container=export

Выберите маркер носителя в качестве типа авторизации. Введите {{bearerToken}} раздел токена . Выберите заголовки , чтобы добавить два новых заголовка:

• Примите: application/fhir+json

• Предпочитать: respond-async

Выберите Отправить. Вы должны заметить 202 Accepted ответ. Выберите вкладку "Заголовки" ответа и запишите значение в content-Location. Это значение можно использовать для запроса состояния задания экспорта.

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

Начальная коллекция примеров запросов Postman