22.5.7. API: 操作

プロデューサーとコンシューマーの両方がサポート対象

操作 API は、次の構文で定義されます。

fhir:operation/methodName?[parameters]

fhir:operation/methodName?[parameters]

Copy to Clipboard

Toggle word wrap

以下の表に 5 つのメソッドをリストし、その後に各メソッドの詳細な構文を示します。(API メソッドには、名前の代わりに構文で使用できる省略形の別名を付けることができます)

Expand

メソッド	説明
onInstance	サーバー上の特定のリソースのすべてのバージョンに対して (ID とタイプによって) 操作を実行します
onInstanceVersion	この操作は、リソースの特定のバージョンで動作します
onServer	サーバー上のすべてのタイプのすべてのリソースのすべてのバージョンで操作を実行します
onType	サーバー上の指定されたタイプのすべてのリソースのすべてのバージョンで操作を実行します
processMessage	この操作は、FHIR 仕様で定義されているように $process-message と呼ばれます

署名:

org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

fhir/onInstance API メソッドには、次の表に示すパラメーターがあります。

Expand

パラメーター	説明	タイプ
extraParameters	渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。	マップ
id	リソース (バージョンは削除されます)	IIdType
name	操作名	String
outputParameterType	出力パラメーターに使用する型 (これは、使用している FHIR 構造のバージョンから引き出された Parameters.class に設定する必要があります) は、NULL の場合があります。	クラス
parameters	入力として使用するパラメーター。操作に入力パラメーターが必要ない場合は、null になることもあります。	IBaseParameters
returnType	このオペレーションが、Parameters リソースではなく、単一のリソースボディを戻り値の型として返す場合は、このメソッドを使用してそのリソースの型を指定します。これは、Parameters リソースの代わりにバンドルを返す特定の操作 (Patient/NNN/$everything など) に役立ちます。NULL の場合があります。	クラス
useHttpGet	HTTP GET 動詞を使用する	ブール値

トップに戻る