FHIR クライアント

相互作用メソッドの呼び出し

FHIR クライアントが update などの相互作用を使用してサーバに書き込みを行う場合は、SetRequestFormat メソッドを使用して、サーバに書き込まれるペイロードの形式を指定する必要があります。使用可能な形式は、JSON、XML、Form、XPatch、および Jpatch です。同様に、FHIR クライアントは SetResponseFormat を使用して、FHIR サーバから返されるリソースの適切な形式を指定できます。 使用可能な形式は、JSON と XML です。

要求および応答の形式が個々の相互作用に合わせて変更されない限り、アプリケーションは要求や応答を一度設定すると、すべての相互作用メソッドに適用できます。例えば、要求を HTTP 経由で FHIR サーバに送信するスタンドアロンの FHIR クライアントは、クライアントのインスタンス化後すぐに、要求と応答の形式を設定できます。

Set clientObj = ##class(HS.FHIRServer.RestClient.HTTP).CreateInstance("MyFHIR.HTTP.Service")
Do clientObj.SetRequestFormat("JSON")
Do clientObj.SetResponseFormat("JSON")

FHIR クライアント・クラスがインスタンス化され、要求と応答の形式が設定されると、アプリケーションはサーバ上で実行したい FHIR 相互作用に対応するメソッドを呼び出すことができます。シグニチャなど、FHIR クライアントで利用可能な FHIR 相互作用メソッドを確認するには、クラス・リファレンスで HS.FHIRServer.RestClient.BaseOpens in a new tab を参照してください。条件付きのアクションを許可する FHIR 相互作用には、2 つの異なるメソッドがあります。例えば、update 相互作用が条件付きであるかどうかに応じて、アプリケーションでは Update または ConditionalUpdate を呼び出すことができます。

引数として渡されるペイロードのデータ型は、インスタンス化された FHIR クライアントのタイプによって決まります。

• HTTP 経由で FHIR サーバにアクセスするクライアントの場合、ペイロードの引数は文字列またはストリームになります。

• ローカル・ネームスペースでインターシステムズの FHIR サーバにアクセスするクライアントの場合、ペイロードの引数は、文字列、ストリーム、またはダイナミック・オブジェクトにできます。

以下に、FHIR クライアントをインスタンス化し、外部 FHIR サーバ上で read 相互作用を実行する例を示します。

Set clientObj = ##class(HS.FHIRServer.RestClient.HTTP).CreateInstance("MyFHIR.HTTP.Service")
Do clientObj.SetResponseFormat("JSON")
Set clientResponseObj = clientObj.Read("GET", "Patient", "123")

カスタム・ヘッダの追加

API キーを渡す場合などで FHIR 要求にカスタム・ヘッダ情報が必要な場合は、SetOtherRequestHeaders()Opens in a new tab メソッドを使用します。このメソッドは、参照による多次元配列を入力として取ります。この配列では、各カスタム・ヘッダを添え字付き要素とします。配列にカスタム・ヘッダを取り込むには、次のように header name と header value を指定します。

 Set otherHeaders("X-API-Key") = "123"
 Do clientObj.SetOtherRequestHeaders(.otherHeaders)

REST clientObj インスタンスで “他のヘッダ” コレクションをクリアするには ClearOtherRequestHeaders()Opens in a new tab API メソッドを使用します。このメソッドは引数を取りません。

  Do clientObj.ClearOtherRequestHeaders()