Postman を使用したアクセス

この記事では、Postman を使用して Azure Health Data Services (以下、FHIR サービス) にアクセスする手順説明します。

前提条件

  • Azure にデプロイされた FHIR サービス。 FHIR サービスをデプロイする方法については、「FHIR サービスをデプロイする」を参照してください。
  • FHIR サービスにアクセスするための登録済みクライアント アプリケーション。 クライアント アプリケーションを登録する方法については、「Microsoft Entra ID でサービス クライアント アプリケーションを登録する」を参照してください。
  • FHIR サービスにアクセスするためのアクセス許可 ("FHIR データ共同作成者" など) をクライアント アプリケーションとユーザー アカウントに付与します。
  • Postman がローカルにインストールされています。 Postman の詳細については、「Postman の概要」を参照してください。

Postman の使用: ワークスペース、コレクション、環境を作成する

Postman を初めて使用する場合は、次の手順に従います。 それ以外の場合は、この手順はスキップできます

Postman では、自分とチームが API、コレクション、環境、およびその他のコンポーネントを共有できるようにするためのワークスペースの概念が導入されています。 既定の [マイ ワークスペース] または [チーム ワークスペース] を使用するか、自分またはチーム用に新しいワークスペースを作成できます。

Screenshot of create a new workspace in Postman.

次に、関連するすべての REST API 要求をグループ化できる新しいコレクションを作成します。 ワークスペースで [コレクションの作成] を選択します。 既定の名前新しいコレクションを保持するか、名前を変更することができます。 変更は自動的に保存されます。

Screenshot of create a new collection.

Postman コレクションをインポートおよびエクスポートすることもできます。 詳細については、Postman ドキュメント を参照してください。

Screenshot of import data.

環境変数を作成または更新する

要求では完全な URL を使用できますが、URL とその他のデータを変数に格納して使用することをお勧めします。

FHIR サービスにアクセスするには、次の変数を作成または更新する必要があります。

  • tenantid – FHIR サービスがデプロイされている Azure テナント。 これは、[アプリケーション登録の概要] メニュー オプションにあります。
  • subid – FHIR サービスがデプロイされている Azure サブスクリプション。 これは、[FHIR サービスの概要] メニュー オプションにあります。
  • clientid – アプリケーション クライアント登録 ID。
  • clientsecret – アプリケーション クライアント登録シークレット。
  • fhirurl – FHIR サービスの完全な URL。 たとえば、「 https://xxx.azurehealthcareapis.com 」のように入力します。 これは、[FHIR サービスの概要] メニュー オプションにあります。
  • bearerToken – スクリプトに Microsoft Entra アクセス トークンを格納する変数。 空欄のままにしてください。

Note

クライアント アプリケーションの登録でリダイレクト URL https://www.getpostman.com/oauth2/callback を構成していることを確認します。

Screenshot of environments variable.

FHIR サーバーに接続する

Postman を開き、[ワークスペース][コレクション]、使用する [環境] を選択します。 [+] アイコンを選択して、新しい要求を作成します。

Screenshot of create a new request.

FHIR サービスで正常性チェックを実行するには、GET 要求に「{{fhirurl}}/health/check」と入力し、[送信] を選択します。 FHIR サービスの状態を確認できるはずです。HTTP 状態コードの応答は 200 で、OverallStatus は応答で "正常" です。これは、正常性チェックが正常であることを意味します。

機能ステートメントを取得する

GET 要求に「{{fhirurl}}/metadata」と入力し、[Send] を選択します。 FHIR サービスの機能ステートメントが表示されます。

Screenshot of capability statement parameters.

Screenshot of save request.

Microsoft Entra アクセス トークンを取得する

FHIR サービスは Microsoft Entra ID によって保護されています。 既定の認証を無効にすることはできません。 FHIR サービスにアクセスするには、まず Microsoft Entra アクセス トークンを取得する必要があります。 詳細については、「Microsoft ID プラットフォーム アクセス トークン」を参照してください。

新しい POST 要求を作成します:

  1. 要求ヘッダーに入力する: https://login.microsoftonline.com/{{tenantid}}/oauth2/token

  2. [本文] タブを選択し、[x-www-form-urlencoded] を選択します。 キーと値のセクションに次の値を入力します:

    • grant_type: Client_Credentials
    • client_id: {{clientid}}
    • client_secret: {{clientsecret}}
    • resource: {{fhirurl}}

Note

FHIR サービス対象ユーザー パラメーターが FHIR サービス エンドポイント URL にマップされていないシナリオ。 リソース パラメーターの値は、FHIR サービス認証ブレードの [対象ユーザー] の値にマップする必要があります。

  1. [テスト] タブを選択し、テキスト セクションに以下を入力します: pm.environment.set("bearerToken", pm.response.json().access_token); 値をコレクションで使用できるようにするには、pm.collectionVariables.set メソッドを使用します。 set メソッドとそのスコープ レベルの詳細については、「スクリプトでの変数の使用」を参照してください。
  2. [保存] を選択して設定を保存します。
  3. [Send] を選択します。 Microsoft Entra アクセス トークンを含む応答が表示されます。このトークンは変数 bearerToken に自動的に保存されます。 その後、すべての FHIR サービス API 要求でそれを使用できます。

Screenshot of send button.

アクセス トークンは、https://jwt.ms などのオンライン ツールを使用して調べることができます。 [要求] タブを選択すると、トークン内の各要求の詳細な説明が表示されます。

Screenshot of access token claims.

FHIR リソースを取得する

Microsoft Entra アクセス トークンを取得したら、FHIR データにアクセスできます。 新しい GET 要求に「{{fhirurl}}/Patient」と入力します。

認可種類として ベアラー トークン を選択します。 [トークン] セクションに「{{bearerToken}}」と入力します。 [Send] を選択します。 応答として、FHIR リソース内の患者の一覧が表示されます。

Screenshot of select bearer token.

FHIR リソースを作成または更新する

Microsoft Entra アクセス トークンを取得したら、FHIR データを作成または更新できます。 たとえば、新しい患者を作成したり、既存の患者を更新したりすることができます。

新しい要求を作成し、メソッドを “Post” に変更し、要求セクションに値を入力します。

{{fhirurl}}/Patient

認可種類として ベアラー トークン を選択します。 [トークン] セクションに「{{bearerToken}}」と入力します。 [本文] タブを選択します。raw オプションと、JSON を本文形式として選択します。 テキストをコピーして本文セクションに貼り付けます。

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

[Send] を選択します。 JSON 応答に新しい患者が表示されます。

Screenshot of send button to create a new patient.

FHIR データをエクスポートする

Microsoft Entra アクセス トークンを取得したら、FHIR データを Azure ストレージ アカウントにエクスポートできます。

新しい GET 要求を作成します: {{fhirurl}}/$export?_container=export

認可種類として ベアラー トークン を選択します。 [トークン] セクションに「{{bearerToken}}」と入力します。 [ヘッダー] を選択して、2 つの新しいヘッダーを追加します:

  • Accept: application/fhir+json
  • Prefer: respond-async

[Send] を選択します。 202 Accepted 応答が表示されるはずです。 応答の [ヘッダー] タブを選択し、[コンテンツの場所] の値を書き留めます。 この値を使用して、エクスポート ジョブの状態を照会できます。

Screenshot of post to create a new patient 202 accepted response.

次のステップ

この記事では、Postman を使用して Azure Health Data Services の FHIR サービスにアクセスする方法について説明しました。 Azure Health Data Services の FHIR サービスの詳細については、次を参照してください

サンプル Postman クエリのスターター コレクションについては、GitHub の サンプル リポジトリ を参照してください。
FHIR® は HL7 の登録商標であり、HL7 の許可を得て使用しています。