Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

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

管理ポータルには、新しい FHIR® サーバをインストールし、構成することができる [サーバ構成] ページが用意されています。または、プログラムによってサーバをインストールおよび構成することができます。

FHIR サーバは Foundation ネームスペースにインストールする必要があります。複数の FHIR サーバを同一の Foundation ネームスペースにインストールすることができます。

Important:

FHIR サーバをインストールする前に、カスタマイズを今するのか、後でするのかを検討する必要があります。多くの場合、エンドポイントを作成する前に InteractionsStrategy のサブクラスを作成しない限り、リソース・リポジトリを使用する FHIR サーバはカスタマイズできません。例えば、バンドルの処理方法の変更や検索結果の後処理を実行するには、リソース・リポジトリのサブクラスを作成する必要があります。FHIR サーバをインストールする前にこのようなカスタマイズを準備する方法の詳細は、"インストール前のサブクラスの作成" を参照してください。

新しい FHIR サーバを管理ポータルからインストールするには、以下の手順を実行します。

  1. 管理ポータルを開き、FHIR サーバをインストールする Foundation ネームスペースに切り替えます。Foundation ネームスペースがない場合は、[Health] に移動し、上部のメニュー・バーから [インストーラ・ウィザード] を選択します。[Foundation 構成] ボタンを使用すると、新しい Foundation ネームスペースを作成できます。作成後に、ネームスペースを必ず有効化してください。

  2. [Health] > [MyNamespace] > [FHIR 構成] に移動します。 [FHIR 構成] メニューが表示されない場合は、Foundation ネームスペースを使用していることを確認します。

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

  4. [エンドポイント] ペインで、[エンドポイントの追加] をクリックし、新しい FHIR エンドポイントを作成します。

  5. コア FHIR パッケージを選択します。各パッケージは、エンドポイントでサポートしている FHIR 標準のバージョンに対応しています。したがって、例えば、FHIR R4 をサポートする FHIR エンドポイントを構成するには、hl7.fhir.r4.core@4.0.1 パッケージを選択します。

  6. 選択したコア FHIR パッケージに応じて自動生成されたエンドポイント URL を確認します。エンドポイントの URL は変更できますが、必ずスラッシュ (/) で始めてください。

  7. エンドポイントで追加のパッケージをサポートする場合は、[追加パッケージ] ドロップダウン・リストから選択します。パッケージの詳細は、"FHIR のプロファイルと適応" を参照してください。

  8. エンドポイントの InteractionsStrategy を選択します。既定の相互作用ストラテジは、リソース・リポジトリ (HS.FHIRServer.Storage.Json.InteractionsStrategy) です。これにより、FHIR データはダイナミック・オブジェクトに JSON データとして格納されます。カスタムの InteractionsStrategy を作成した場合は、リストからそれを選択します。

  9. 既定では、ネームスペース内の各エンドポイントのデータは 2 つの別個のデータベースに格納されます。別個のデータベースを維持したくない場合は、[FHIR リソース・ストレージに別個のデータベースを使用する] フィールドのチェックを外します。この場合、すべての FHIR データはネームスペースの共通のデータベース・ファイルに格納されます。別個のデータベースを使用する場合は、既定の場所を受け入れることも、独自に場所を指定することもできます。リソース履歴データベースには、以前のバージョンのリソースが含まれています。これらは頻繁にアクセスされないため、このデータベースをより低速で安価なディスクに置くことができます。

  10. [追加] を選択します。

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

FHIR サーバの構成

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

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

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

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

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

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

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

設定 説明
有効 エンドポイントを有効にするかどうかを指定します。無効になっているエンドポイントは、FHIR クライアントからの要求を拒否します。
検索ページの既定のサイズ 検索に _count パラメータが含まれない場合に使用する検索結果ページのサイズ。
検索ページの最大サイズ 過剰なユーザ指定ページ・サイズを防止するための検索結果ページの最大サイズ。
検索結果の最大数 サーバがクエリにエラーで応答するまでの、1 つの検索で選択できるリソースの最大数。この数値には、実際の検索で選択されるリソースのみが含まれます。_include 検索パラメータで組み入れられるリソースは含まれません。この値は、検索で返されるページのサイズには影響しません。大量のリソースを選択する過剰に広範な検索は、実行するのに大量のシステム・リソースを必要とし、多くの場合、クライアントが実際に必要とするよりも広範になります。
条件付き削除結果の最大数 条件付き削除で削除できるリソースの最大数。条件付き削除検索でこの数を超えるリソースが見つかった場合、条件付き削除全体が「HTTP 412 前提条件が失敗しました」のエラーで拒否されます。
FHIR セッション・タイムアウト サービスへの要求からセッション・データが古いと見なされるまでの最大秒数。
既定の推奨処理 検索条件に不明なパラメータが含まれる場合の既定の処理を指定します。不明なパラメータを無視し、OperationOutcome リソースによって問題が特定されたバンドルを返すには、lenient を指定します。検索要求を拒否してエラーを返すには、strict を指定します。Prefer ヘッダOpens in a new tabが含まれる FHIR 検索要求では、この既定値は上書きされます。
OAuth クライアント名 必要に応じて、OAuth リソース・サーバとして、FHIR サーバが OAuth 2.0 承認サーバへのアクセスに使用するアプリケーション名を指定します。OAuth 2.0 のサポートの詳細は、"OAuth 2.0 承認" を参照してください。
必須のリソース InterSystems セキュリティ・リソースを指定する場合、FHIR クライアントは、サーバ上で相互作用を実行するため、リソースに対する特権を持っている必要があります。詳細は、"承認要件の追加" を参照してください。
サービス構成名 FHIR サーバに到達する前に相互運用プロダクション経由で FHIR 要求をルーティングするには、要求を受信するビジネス・サービスのパッケージと名前を入力します。ビジネス・サービスにカスタム名がない場合は、このエントリは HS.FHIRServer.Interop.Service になります。詳細は、"相互運用プロダクション" を参照してください。
認証なしアクセスを許可 認証と承認のストラテジを無視して、すべての FHIR 要求がサーバに届くようにすることができます。
新しいサービス・インスタンス すべての FHIR 要求について、新しいサービス・オブジェクトをインスタンス化します。
トレースバックを含む FHIR サーバは、OperationOutcome リソースでスタック・トレースを送信することによって、FHIR 要求に応答します。
SMART on FHIR 機能 エンドポイントの SMART on FHIR 機能のコンマ区切りリスト。このリストは、エンドポイントの機能を制御するものではありません。クライアントがエンドポイントの URL に /.well-known/smart-configuration を追加したときに JSON ドキュメントで返される機能を指定するものです。既知の URI で取得した FHIR 機能での SMART の詳細は、"FHIR Authorization Endpoint and Capabilities Discovery using a Well-Known Uniform Resource Identifiers (URIs)Opens in a new tab" を参照してください。

コマンド行インタフェースを使用して 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 の以下のメソッドを順番に呼び出す必要があります。

HS.FHIRServer.Installer メソッド 説明
InstallNamespace()Opens in a new tab FHIR サーバ用の既存の Foundation ネームスペースを準備します。新しい Foundation ネームスペースは作成しません。引数なしで呼び出すと、インストーラは、アクティブなネームスペースを Foundation ネームスペースであると見なし、これを FHIR サーバ用に準備します。
InstallInstance()Opens in a new tab FHIR サービスのインスタンスを現在のネームスペースにインストールします。このメソッドには、以下の引数が必要です。

  • FHIR エンドポイントの一意の URL。URL は必ずスラッシュ (/) で始めてください。

  • FHIR サーバの InteractionsStrategy のクラス名。

  • FHIR パッケージのリスト (US Core などの実装ガイドのパッケージのリストなど)。詳細は、"pPackageList パラメータ" を参照してください。

また、InstallInstance() に渡すことができるオプション・パラメータもあります。これらのオプション・パラメータの詳細は、"InstallInstance()Opens 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.r4.core@4.0.1
hl7.fhir.us.core@3.3.0
hl7.fhir.uv.vhdir@0.2.0

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

Do ##class(HS.FHIRServer.Installer).InstallInstance(myURL,
                                    strategyClass,
                                    $lb("hl7.fhir.r4.core@4.0.1","hl7.fhir.us.core@3.1.0")

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

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

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

Set appKey = "/myfhirserver/fhir/r4"
Set strategyClass = "HS.FHIRServer.Storage.Json.InteractionsStrategy"
Set metadataPackages = $lb("hl7.fhir.r4.core@4.0.1","hl7.fhir.us.core@3.1.0")

//Install a Foundation namespace and change to it
Do ##class(HS.HC.Util.Installer).InstallFoundation("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.ConfigData オブジェクトを受け入れる引数もあり、ここにはサーバのほとんどの構成オプションが含まれます。これらの構成オプションのリストは、クラス・リファレンスOpens in a new tabを参照してください。ConfigData オブジェクトで定義するオプション以外に、サーバのいくつかの設定 ([サービス構成名]、[OAuth クライアント名]、および [有効]) も、UpdateInstance() メソッドの専用のパラメータを使用して指定します。

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

Set appKey = "/fhirendpoint/r4"

//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()

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

Create FHIRServer Endpoint

新しい FHIR サーバ・エンドポイントをインストールします。以下のプロンプトが表示されます。

  • Choose the Storage Strategy — Json がリソース・リポジトリです。

  • Choose the FHIR version for this endpoint — エンドポイントでサポートしているコア FHIR 仕様のバージョンを選択します。

  • Enter any package numbers — インポートされたパッケージが候補として表示されます。エンドポイントは複数のパッケージをサポートできます。複数のパッケージを指定するには、数字をコンマで区切って指定します。パッケージは後から追加できますが、待機する場合には、追加の手順を実行する必要がある場合があります。Upload a FHIR Metadata Package オプションを使用して、パッケージをリストに追加します。

  • Do you want to create the default repository endpoint — エンドポイントの既定の URL を受け入れる場合は、Enter キーを押します。エンドポイントに異なる URL を指定する場合は、N と指定し、URL を入力します (URL は必ずスラッシュ (/) で始めてください)。

  • Enter the OAuth Client Name for this Endpoint — OAuth 2.0 を使用してエンドポイントを保護する場合は、FHIR サーバのクライアント名を入力します。詳細は、"OAuth 2.0 承認" を参照してください。

  • Do you want to create separate database files for your FHIR data? — yes を指定すると、エンドポイントの FHIR データは、同じネームスペース内のその他のエンドポイントの FHIR データとは別に格納されます。no を指定すると、複数のエンドポイントがある場合でも、すべての FHIR データがネームスペースのデータベース・ファイルに格納されます。個別のデータベース・ファイルを作成している場合は、既定の場所を受け入れることも、別の場所を指定することもできます。バージョン・データベースには、リソースの以前のバージョンが含まれています。これらは頻繁にアクセスされないため、バージョン・データベースをより低速で安価なディスクに置くことができます。

Add a profile package to an endpoint

FHIR パッケージを既存のエンドポイントに追加して、パッケージのプロファイル、検索パラメータ、およびその他の Conformance リソースをサポートできるようにします。このオプションを使用する前に、Conformance リソースを含む FHIR パッケージ (NPM のようなパッケージ) をアップロードしておく必要があります。Upload a FHIR Metadata Package オプションを使用して、FHIR パッケージをインポートできます。US Core Implementation Guide などの一部の共通パッケージは、既に利用できます。

パッケージに新しい検索パラメータが含まれている場合は、完了時に、Index new SearchParameters for an Endpoint オプションを実行する必要があります。

Display a FHIRServer Endpoint Configuration

FHIR サーバの現在の構成オプションを表示します。これらの構成オプションを変更するには、Configure a FHIRServer Endpoint オプションを使用します。

Configure a FHIRServer Endpoint

各構成オプションに値を指定することにより、FHIR サーバのエンドポイントを構成できます。各構成項目の詳細は、"FHIR サーバの構成" を参照してください。

Decommission a FHIRServer Endpoint

FHIR サーバ・エンドポイントは削除されますが、エンドポイントが収集した FHIR データは保持されます。FHIR データを含む SQL テーブルが保持されます。エンドポイントおよびすべての FHIR データを削除する場合は、Delete a FHIRServer Endpoint オプションを使用します。

Delete a FHIRServer Endpoint

FHIR サーバ・エンドポイントを削除し、かつエンドポイントの FHIR データを削除します。エンドポイントを削除するものの、エンドポイントが収集した FHIR データは保持する場合は、Decommission a FHIRServer Endpoint オプションを使用します。

Update the CapabilityStatement Resource

FHIR サーバの機能宣言書を更新します。詳細は、"機能宣言書の変更" を参照してください。

Index new SearchParameters for an Endpoint

公開またはカスタムのパッケージを使用して、新しい検索パラメータを既存のエンドポイントに追加する場合、FHIR クライアントは、パッケージの適用後に、新しいパラメータを使用して、リポジトリに追加されたリソースを取得できます。ただし、新しい検索パラメータを追加する前に存在していたリソースは、エンドポイントのインデックスを再作成するまで、返されません。エンドポイントが大量の FHIR データを収集していた場合、このオプションは既存のすべてのリソースを再処理するため、実行に長い時間がかかる可能性があります。

Upload a FHIR metadata package

Conformance リソースを定義する JSON ファイルの FHIR パッケージのインポートに使用します。このオプションは、パッケージをエンドポイントに適用する前に使用しておく必要があります。カスタム FHIR パッケージのアップロード準備の詳細は、"カスタム・パッケージの作成" を参照してください。

Delete a FHIR metadata package

エンドポイントに適用可能なパッケージのリストからパッケージを削除します。これにより、FHIR パッケージの JSON ファイルがローカル・システムから削除されることはありません。エンドポイントに適用されているパッケージは削除できません。

Next sectionサポートされる FHIR 相互作用とオペレーション
Previous sectionFHIR サーバ：概要
FeedbackOpens in a new tab