Доступ с помощью Postman

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

Предварительные требования

Использование Postman: создание рабочей области, коллекции и среды

Если вы не знакомы с Postman, выполните следующие действия. Этот шаг также можно пропустить.

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

Снимок экрана: создание рабочей области в Postman.

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

Снимок экрана: создание новой коллекции.

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

Снимок экрана: импорт данных.

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

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

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

  • tenantid — клиент Azure, в котором развернута служба FHIR. Он находится в меню обзора регистрации приложений .
  • subid — подписка Azure, в которой развернута служба FHIR. Он находится в меню обзора службы FHIR .
  • clientid — идентификатор регистрации клиента приложения.
  • clientsecret — секрет регистрации клиента приложения.
  • fhirurl — полный URL-адрес службы FHIR. Например, https://xxx.azurehealthcareapis.com. Он находится в меню обзора службы FHIR .
  • bearerToken — переменная для хранения маркера доступа Azure Active Directory (Azure AD) в скрипте. Оставьте пустым.

Примечание

Убедитесь, что вы настроили URL-адрес https://www.getpostman.com/oauth2/callbackперенаправления в регистрации клиентского приложения.

Снимок экрана: переменная среды.

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

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

Снимок экрана: создание нового запроса.

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

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

Снимок экрана: параметры оператора capability.

Снимок экрана: запрос на сохранение.

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

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

Создайте новый 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. Нажмите кнопку Отправить. Вы увидите ответ с маркером доступа Azure AD, который автоматически сохраняется в переменнойbearerToken. Затем его можно использовать во всех запросах API службы FHIR.

Снимок экрана: кнопка

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

Снимок экрана: утверждения маркера доступа.

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

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

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

Снимок экрана: выбор токена носителя.

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

Получив маркер доступа Azure AD, можно создать или обновить данные 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

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

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

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

  • Примите: application/fhir+json
  • Предпочитать: respond-async

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

Снимок экрана: сообщение о создании принятого ответа для нового пациента 202.

Дальнейшие действия

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

FHIR® является зарегистрированным товарным знаком HL7 и используется с разрешением HL7 .