FHIR サーバのインストールと構成

FHIR サーバの構成

FHIR サーバをインストールしたら、管理ポータルの [サーバ構成] ページを使用して、その設定を構成できます。これらの構成設定は、サーバの ConfigData オブジェクトのプロパティを設定することで、プログラムによって変更することもできます。

FHIR サーバを構成するには、以下の手順に従います。

1. [Health]→[MyNamespace]→[FHIR 構成] に移動します。FHIR サーバのネームスペースにいることを確認します。

2. [サーバ構成] カードを選択します。

3. 構成する FHIR サーバのエンドポイントを選択します。

4. ページが展開されたら、下方にスクロールして [編集] ボタンを選択します。

5. 以下の説明をガイドとして、設定を構成します。

コマンド行インタフェースを使用して FHIR サーバを構成する場合は、"コマンド行オプション" を参照してください。

FHIR エンドポイントの削除

既定では、管理ポータルを使用して FHIR サーバ・エンドポイントを削除すると、そのエンドポイントに関連付けられている FHIR データも削除されます。ただし、エンドポイントを削除しても、そのすべての FHIR データは保持したい場合は、コマンド行インタフェースを使用して、エンドポイントを削除するのではなくデコミッションします。コマンド行インタフェースを使用したエンドポイントのデコミッションの詳細は、"コマンド行オプション" を参照してください。

エンドポイントを削除するには、以下の手順を実行します。

1. [Health]→[MyNamespace]→[FHIR 構成] に移動します。FHIR サーバのネームスペースにいることを確認します。

2. [サーバ構成] カードを選択します。

3. 削除するエンドポイントを選択します。

4. [ごみ箱] アイコンを選択します。

プログラムによるインストール

管理ポータルを使用する代わりにプログラムによって FHIR サーバをインストールする必要があるアプリケーションでは、最初にサーバをインストールしたうえで、構成を行う必要があります。

FHIR サーバは Foundation ネームスペースで実行する必要があるため、Foundation ネームスペースを作成することが FHIR サーバをインストールするための前提条件です。Foundation ネームスペースを作成したら、HS.FHIRServer.InstallerOpens in a new tab の以下のメソッドを順番に呼び出す必要があります。

pPackageList パラメータ

InstallInstance()Opens in a new tab メソッドの pPackageList パラメータは、システムにロードされた FHIR パッケージのリストを受け入れます。多くの場合、パッケージは特定の実装ガイドに相当しますが、あるバージョンの FHIR のコア・メタデータである場合もあります。パッケージのリストを InstallInstance に渡すことにより、1 つ以上のパッケージをサポートするようエンドポイントを構成できます。パッケージの詳細は、"FHIR のプロファイルと適応" を参照してください。

pPackageList パラメータに渡すことができるパッケージのリストを取得するには、HS.FHIRMeta.Storage.Package.GetAllPackages()Opens in a new tab メソッドを使用します。例えば、以下のコードは、使用可能なパッケージの識別子を表示します。

 set packages = ##class(HS.FHIRMeta.Storage.Package).GetAllPackages()
 for i=1:1:packages.Count()
   { write packages.GetAt(i).id,! }

結果は以下のようになります。

hl7.fhir.r5.core@5.0.0
hl7.fhir.r4.core@4.0.1
hl7.fhir.us.core@3.1.0
hl7.fhir.r3.core@3.0.2

次に、$lb を使用して、これらのパッケージの識別子の一部を引数として pPackageList パラメータに渡すことができます。以下に例を示します。

 Do ##class(HS.FHIRServer.Installer).InstallInstance(
            myURL,
            strategyClass,
            $lb("hl7.fhir.r5.core@5.0.0"))

FHIR パッケージの作成に使用する API の詳細は、"パッケージ API" を参照してください。

プログラムによるインストールの例

以下の ObjectScript コードの例では、2 つのパッケージをサポートし、既定のストレージ・ストラテジ (リソース・リポジトリ) を使用する FHIR サーバをインストールします。

 Set appKey = "/myfhirserver/fhir/r5"
 Set strategyClass = "HS.FHIRServer.Storage.JsonAdvSQL.InteractionsStrategy"
 Set metadataPackages = $lb("hl7.fhir.r5.core@5.0.0")

 //Install a Foundation namespace and change to it
 Do ##class(HS.Util.Installer.Foundation).Install("FHIRNamespace")
 Set $namespace = "FHIRNamespace"

 // Install elements that are required for a FHIR-enabled namespace
 Do ##class(HS.FHIRServer.Installer).InstallNamespace()

 // Install an instance of a FHIR Service into the current namespace
 Do ##class(HS.FHIRServer.Installer).InstallInstance(appKey, strategyClass, metadataPackages)

プログラムによる構成

FHIR サーバをインストールしたら、HS.FHIRServer.Installer.UpdateInstance()Opens in a new tab メソッドを使用してプログラムによって構成できます。このメソッドは、サーバを構成する引数を複数受け入れます。その中には、サーバの HS.FHIRServer.API.ConfigDataOpens in a new tab オブジェクトを受け入れる引数もあり、ここにはサーバのほとんどの構成オプションが含まれます。これらの構成オプションのリストは、クラス・リファレンスOpens in a new tabを参照してください。ConfigData オブジェクトで定義するオプション以外に、サーバのいくつかの設定 ([サービス構成名]、[OAuth クライアント名]、および [有効]) も、UpdateInstance() メソッドの専用のパラメータを使用して指定します。

以下のコードは、UpdateInstance() メソッドを使用して既存の FHIR サーバを構成します。

 Set appKey = "/fhirendpoint/r5"

 //Get and modify FHIR server's configuration object
 Set strategy = ##class(HS.FHIRServer.API.InteractionsStrategy).GetStrategyForEndpoint(appKey)
 Set configData = strategy.GetServiceConfigData()
 Set configData.DefaultPreferHandling = "strict"
 Set configData.DebugMode = 1
 //stringify configData before updating FHIR Server
 Set jsonConfigData = configData.AsJSONString()

 // Define additional settings
 Set enabled = 1
 Set serviceConfigName = "HS.InteropPackage.myBusinessService"
 Set oAuthClient = "OAuthClientName"
 
 // Update FHIR Server
 Do ##class(HS.FHIRServer.Installer).UpdateInstance(appKey, jsonConfigData, enabled, serviceConfigName, oAuthClient)

コマンド行オプション

管理ポータルよりもコマンド行インタフェースを好む開発者は、InterSystems ターミナルのコンソール設定を使用して、ユーザ・インタフェースで使用可能なアクションと同じアクションを数多く実行できます。コンソール設定を実行するには、InterSystems ターミナルを開いて以下を実行します。

 do ##class(HS.FHIRServer.ConsoleSetup).Setup()

後続のセクションでは、コンソール設定で使用可能な各オプションについて説明します。

プロファイル検証サーバの構成

FHIR エンドポイントを作成すると、プロファイル検証に関連するバックエンド機能を実行する FHIR_Validation_Server という外部サーバが作成されます。このサーバは、Java 11 開発キットを必要とします。JAVA_HOME 環境変数が Java 11 ディレクトリを指していない場合は、以下のように管理ポータルを使用できます。

1. 必要に応じて、サポートされている Java 11 JDK をインストールOpens in a new tabします。インストールされたディレクトリを書き留めます。

2. 管理ポータルで、[システム管理]→[構成]→[接続性]→[外部言語サーバ] に移動します。

3. FHIR_Validation_Server が実行中の場合は [停止] をクリックします。

4. [FHIR_Validation_Server] をクリックして編集モードに入ります。

5. [外部言語サーバを編集] ページの [Javaホームディレクトリ] フィールドOpens in a new tabに、Java 11 ディレクトリへのパスを入力します。

6. [保存] をクリックします。

7. [開始] をクリックして FHIR_Validation_Server を再起動します。

8. 以前にインポートしたプロファイル (自動的にインストールされたものも含む) に関連する検証オペレーションを実行する際、良好なパフォーマンスを確保するために、ターミナル・アプリケーションで FHIR 対応ネームスペースに切り替えてOpens in a new tab、以下のコマンドを実行します。

   do ##class(HS.FHIRServer.Installer).InitializeProfileValidator()
   

   

検索パフォーマンスの最適化

リソース・リポジトリを使用または拡張する FHIR サーバの場合、そのエンドポイントに生成された SQL Search テーブルに対してテーブル・チューニング・ユーティリティを実行することで、search 相互作用の応答のパフォーマンスを最適化できます。既定では、これらのテーブルの名前は HSFHIR で始まります。これらのテーブルに、カスタムの選択性の値を手動で設定することもできます。

リソース・リポジトリを使用または拡張する新たな FHIR サーバをインストールすると、要素のデータ型に基づいて、既定の選択性の値セットが検索可能な要素に割り当てられます。これらの既定の選択性の値により、サーバは検索要求に応えてリソースを取得する際に、より効率的なクエリ・プランを選択できます。最も選択の幅の広いクエリ・パラメータから始めて想定される結果を選択することで、後続の各選択操作で評価する必要のあるリソースの数を最小限に抑えることができます。

例えば、以下の検索要求を考えてみます。

GET [base]/Patient?family=halifax&gender=male

リソース・リポジトリにおいて、Halifax という姓の患者は、男性の患者よりも少ないと考えられます。そのため、まず Halifax という姓の患者を検索するのがおそらく最も効率的です。その後に男性患者を検索する操作では、Halifax という姓の小さい患者のサブセットを検索すれば済むからです。

2023.1 より前のバージョンからこのバージョンにアップグレードし、既存の FHIR サーバを使用している場合は、SetDefaultSearchTableSelectivities()Opens in a new tab メソッドを使用することで、検索操作にこれらの既定の選択性の値を設定できます。ターミナルでこのメソッドを呼び出して、以下の例のように、FHIR エンドポイントの相対パスを指定します。

do ##class(HS.FHIRServer.Storage.SearchTableBuilder).SetDefaultSearchTableSelectivities("/csp/healthshare/hsods/fhir/r5")

ただし、既存のほとんどの FHIR サーバにとって、テーブル・チューニングで生成される選択性の値の方が、このメソッドで設定される既定の選択性の値よりも役立ちます。