23.5. API パラメーター (13 API)


@FHIR エンドポイントは API ベースのコンポーネントであり、使用される API 名と API メソッドに基づく追加のパラメーターがあります。API 名と API メソッドは、apiName/methodName パスパラメーターとしてエンドポイント URI に配置されます。

fhir:apiName/methodName

次の表に示すように、13 の API 名があります。

API 名タイプ説明

capabilities

両方

サーバーの機能ステートメントをフェッチする API

create

両方

サーバー上に新しいリソースインスタンスを作成する作成操作用の API

delete

両方

サーバーリソースで論理的な削除を実行する、削除操作用の API

history

両方

history メソッドの API

load-page

両方

Atom バンドル内の link type=next タグで指定されたリンクを使用して、ページセットからリソースの前/次のバンドルをロードする API

meta

両方

タグやその他のメタ要素をリソースから、またはサーバー全体で取得、追加、削除するために使用できるメタ操作用の API

operation

両方

拡張 FHIR 操作用の API

patch

両方

サーバーリソースで論理パッチを実行する、パッチ操作用の API

read

両方

読み取り操作の API メソッド

search

両方

特定の基準セットに一致するリソースを検索する API

transaction

両方

トランザクション (リソースの集まり) をサーバーに送信して単体で実行するための API

update

両方

サーバーリソースで論理的な削除を実行する、更新操作用の API

validate

両方

リソースを検証するための API

各 API については、以降のセクションで説明します。

23.5.1. API: 機能

producer と consumer の両方がサポート対象

機能 API は、次の構文で定義されます。

fhir:capabilities/methodName?[parameters]

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

メソッド説明

ofType

指定されたモデルタイプを使用して適合ステートメントを取得します

23.5.1.1. タイプの方法

署名:

  • org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

type

モデルタイプ

クラス

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.2. API: 作成

producer と consumer の両方がサポート対象

作成 API は、構文で次のように定義されます。

fhir:create/methodName?[parameters]

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

メソッド説明

resource

サーバー上に IBaseResource を作成します

23.5.2.1. メソッドリソース

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

preferReturn

リクエストに Prefer ヘッダーを追加します。これは、サーバーが結果の一部としてリソース本文を含めるか抑制することを要求します。リソースがサーバーによって返された場合、それは解析され、MethodOutcome#getResource () を介してクライアントにアクセス可能になります。null の場合があります。

PreferReturnEnum

resource

作成するリソース

IBaseResource

resourceAsString

作成するリソース

String

url

使用する検索 URL。この URL の形式は、ResourceTypeParameters の形式にする必要があります。たとえば、Patientname=Smith&identifier=13.2.4.11.4%7C847366、null の可能性があります。

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.3. API: 削除

producer と consumer の両方がサポート対象

削除 API は、構文で次のように定義されます。

fhir:delete/methodName?[parameters]

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

メソッド説明

resource

指定されたリソースを削除します

resourceById

リソースタイプ e でリソースを削除する

resourceConditionalByUrl

特定の検索 URL に対する条件付き削除として削除を実行する必要があることを指定します。

23.5.3.1. メソッドリソース

署名:

  • org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

resource

削除する IBaseResource

IBaseResource

23.5.3.2. メソッド resourceById

署名:

  • org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(String type, String stringId, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

リソースを参照する IIdType

IIdType

stringId

id です

String

type

リソースの種類 (患者など)

String

23.5.3.3. メソッド resourceConditionalByUrl

署名:

  • org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceConditionalByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

url

使用する検索 URL。この URL の形式は、ResourceTypeParameters の形式にする必要があります。たとえば、Patientname=Smith&identifier=13.2.4.11.4%7C847366 です。

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.4. API: 履歴

producer と consumer の両方がサポート対象

履歴 API は、次の構文で定義されます。

fhir:history/methodName?[parameters]

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

メソッド説明

onInstance

サーバー上の特定のリソースのすべてのバージョンに対して (ID とタイプによって) 操作を実行します

onServer

サーバー上のすべてのタイプのすべてのリソースのすべてのバージョンで操作を実行します

onType

サーバー上の指定されたタイプのすべてのリソースのすべてのバージョンで操作を実行します

23.5.4.1. メソッド onInstance

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

count

サーバーが theCount 数までのリソースのみを返すように要求します。NULL の場合があります

Integer

cutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

日付

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

iCutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

IPrimitiveType

id

リソースタイプとリソース ID の両方を入力する必要がある IIdType

IIdType

returnType

メソッドが Bundle リソース (ca.uhn.fhir.model.dstu2.resource.Bundle など) を返すように要求します。DSTU2 サーバーにアクセスしている場合は、この方法を使用します。

クラス

23.5.4.2. メソッド onServer

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

count

サーバーが theCount 数までのリソースのみを返すように要求します。NULL の場合があります

Integer

cutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

日付

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

iCutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

IPrimitiveType

returnType

メソッドが Bundle リソース (ca.uhn.fhir.model.dstu2.resource.Bundle など) を返すように要求します。DSTU2 サーバーにアクセスしている場合は、この方法を使用します。

クラス

23.5.4.3. メソッド onType

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

count

サーバーが theCount 数までのリソースのみを返すように要求します。NULL の場合があります

Integer

cutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

日付

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

iCutoff

指定された時間以降に作成されたリソースバージョンのみをサーバーが返すように要求します。NULL の場合があります。

IPrimitiveType

resourceType

検索するリソースの種類

クラス

returnType

メソッドが Bundle リソース (ca.uhn.fhir.model.dstu2.resource.Bundle など) を返すように要求します。DSTU2 サーバーにアクセスしている場合は、この方法を使用します。

クラス

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.5. API: ページの読み込み

producer と consumer の両方がサポート対象

ページ読み込み API は、次の構文で定義されます。

fhir:load-page/methodName?[parameters]

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

メソッド説明

byUrl

指定された URL とバンドルタイプを使用して結果のページを読み込み、DSTU1 Atom バンドルを返します

next

バンドル内のリレーション next のリンクを使用して、結果の次のページを読み込みます

previous

バンドル内のリレーション prev のリンクを使用して、結果の前のページをロードします

23.5.5.1. メソッド byUrl

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

returnType

リターンタイプ

クラス

url

検索 URL

String

23.5.5.2. 次の方法

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

bundle

IBaseBundle

IBaseBundle

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

23.5.5.3. 前の方法

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

bundle

IBaseBundle

IBaseBundle

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.6. API: メタ

producer と consumer の両方がサポート対象

メタ API は、次の構文で定義されます。

fhir:meta/methodName?[parameters]

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

メソッド説明

add

指定されたメタデータの要素を既存のセットに追加します (削除しないでください)。

delete

指定された ID から指定されたメタデータの要素を削除します

getFromResource

特定のリソースから現在のメタデータを取得する

getFromServer

サーバー全体から現在のメタデータを取得する

getFromType

特定のタイプから現在のメタデータをフェッチする

23.5.6.1. メソッドの追加

署名:

  • org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

ID

IIdType

meta

IBaseMetaType クラス

IBaseMetaType

23.5.6.2. メソッド: DELETE

署名:

  • org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

ID

IIdType

meta

IBaseMetaType クラス

IBaseMetaType

23.5.6.3. メソッド getFromResource

署名:

  • org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

ID

IIdType

metaType

IBaseMetaType クラス

クラス

23.5.6.4. メソッド: getFromServer

署名:

  • org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

metaType

特定の FHIR モデルバージョンのメタデータ型のタイプ (MetaDt.class または MetaType.class である必要があります)

クラス

23.5.6.5. メソッド getFromType

署名:

  • org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, String resourceType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

metaType

IBaseMetaType クラス

クラス

resourceType

リソースの種類 (患者など)

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.7. API: 操作

producer と consumer の両方がサポート対象

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

fhir:operation/methodName?[parameters]

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

メソッド説明

onInstance

サーバー上の特定のリソースのすべてのバージョンに対して (ID とタイプによって) 操作を実行します

onInstanceVersion

この操作は、リソースの特定のバージョンで動作します

onServer

サーバー上のすべてのタイプのすべてのリソースのすべてのバージョンで操作を実行します

onType

サーバー上の指定されたタイプのすべてのリソースのすべてのバージョンで操作を実行します

processMessage

この操作は、FHIR 仕様で定義されているように $process-message と呼ばれます

23.5.7.1. メソッド onInstance

署名:

  • 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 メソッドには、次の表に示すパラメーターがあります。

パラメーター説明タイプ

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 動詞を使用する

Boolean

23.5.7.2. メソッド onInstanceVersion

署名:

  • org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(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/onInstanceVersion API メソッドには、次の表に示すパラメーターがあります。

パラメーター説明タイプ

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 動詞を使用する

Boolean

23.5.7.3. メソッド onServer

署名:

  • org.hl7.fhir.instance.model.api.IBaseResource onServer(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/onServer API メソッドには、次の表に示すパラメーターがあります。

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

name

操作名

String

outputParameterType

出力パラメーターに使用する型 (これは、使用している FHIR 構造のバージョンから引き出された Parameters.class に設定する必要があります) は、NULL の場合があります。

クラス

parameters

入力として使用するパラメーター。操作に入力パラメーターが必要ない場合は、null になることもあります。

IBaseParameters

returnType

このオペレーションが、Parameters リソースではなく、単一のリソースボディを戻り値の型として返す場合は、このメソッドを使用してそのリソースの型を指定します。これは、Parameters リソースの代わりにバンドルを返す特定の操作 (Patient/NNN/$everything など) に役立ちます。NULL の場合があります。

クラス

useHttpGet

HTTP GET 動詞を使用する

Boolean

23.5.7.4. メソッド onType

署名:

  • org.hl7.fhir.instance.model.api.IBaseResource onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, 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/onType API メソッドには、次の表に示すパラメーターがあります。

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

name

操作名

String

outputParameterType

出力パラメーターに使用する型 (これは、使用している FHIR 構造のバージョンから引き出された Parameters.class に設定する必要があります) は、NULL の場合があります。

クラス

parameters

入力として使用するパラメーター。操作に入力パラメーターが必要ない場合は、null になることもあります。

IBaseParameters

resourceType

操作するリソースの種類

クラス

returnType

このオペレーションが、Parameters リソースではなく、単一のリソースボディを戻り値の型として返す場合は、このメソッドを使用してそのリソースの型を指定します。これは、Parameters リソースの代わりにバンドルを返す特定の操作 (Patient/NNN/$everything など) に役立ちます。NULL の場合があります。

クラス

useHttpGet

HTTP GET 動詞を使用する

Boolean

23.5.7.5. メソッド processMessage

署名:

  • org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class<org.hl7.fhir.instance.model.api.IBaseBundle> responseClass, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

非同期

メッセージを非同期または同期のどちらで処理するか。デフォルトは同期です。

Boolean

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

msgBundle

メッセージバンドルをメッセージングサーバーへの POST に設定します。

IBaseBundle

respondToUri

受信サーバーからの応答をこの URI に送信する必要があることを示すオプションのクエリーパラメーター。NULL の場合があります。

String

responseClass

応答クラス

クラス

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.8. API: パッチ

producer と consumer の両方がサポート対象

パッチ API は、次の構文で定義されます。

fhir:patch/methodName?[parameters]

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

メソッド説明

patchById

指定されたリソース ID にパッチを適用します

patchByUrl

特定の検索 URL に対して条件付きの作成として更新を実行する必要があることを指定します。

23.5.8.1. メソッド patchById

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

パッチを適用するリソース ID

IIdType

patchBody

に準拠する XML または JSON でシリアル化されたパッチドキュメントの本文

String

preferReturn

リクエストに Prefer ヘッダーを追加します。これは、サーバーが結果の一部としてリソース本文を含めるか抑制することを要求します。リソースがサーバーによって返された場合、それは解析され、MethodOutcome#getResource () を介してクライアントにアクセス可能になります。

PreferReturnEnum

stringId

パッチを適用するリソース ID

String

23.5.8.2. メソッド patchByUrl

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

patchBody

に準拠する XML または JSON でシリアル化されたパッチドキュメントの本文

String

preferReturn

リクエストに Prefer ヘッダーを追加します。これは、サーバーが結果の一部としてリソース本文を含めるか抑制することを要求します。リソースがサーバーによって返された場合、それは解析され、MethodOutcome#getResource () を介してクライアントにアクセス可能になります。

PreferReturnEnum

url

使用する検索 URL。この URL の形式は、ResourceTypeParameters の形式にする必要があります。たとえば、Patientname=Smith&identifier=13.2.4.11.4%7C847366 です。

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.9. API: 読み取り

producer と consumer の両方がサポート対象

読み取り API は、次の構文で定義されます。

fhir:read/methodName?[parameters]

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

メソッド説明

resourceById

サーバー上の IBaseResource を ID で読み取ります

resourceByUrl

サーバー上の IBaseResource を URL で読み取ります

23.5.9.1. メソッド resourceById

署名:

  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

リソースを参照する IIdType

IIdType

ifVersionMatches

サーバー上の最新バージョンと照合するバージョン

String

longId

リソース ID

Long

resource

読み取るリソース (Patient など)

クラス

resourceClass

読み取るリソース (Patient など)

String

returnNull

バージョンが一致する場合は null を返す

Boolean

returnResource

バージョンが一致する場合はリソースを返します

IBaseResource

stringId

リソース ID

String

throwError

バージョンが一致する場合はエラーを出力します

Boolean

version

リソースのバージョン

String

23.5.9.2. メソッド resourceByUrl

署名:

  • org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

iUrl

絶対 URL でリソースを参照する IIdType

IIdType

ifVersionMatches

サーバー上の最新バージョンと照合するバージョン

String

resource

読み取るリソース (Patient など)

クラス

resourceClass

読み取るリソース (Patient.class など)

String

returnNull

バージョンが一致する場合は null を返す

Boolean

returnResource

バージョンが一致する場合はリソースを返します

IBaseResource

throwError

バージョンが一致する場合はエラーを出力します

Boolean

url

絶対 URL によるリソースの参照

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.11. API: トランザクション

producer と consumer の両方がサポート対象

トランザクション API は、次の構文で定義されます。

fhir:transaction/methodName?[parameters]

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

メソッド説明

withBundle

指定された生のテキスト (バンドルリソースである必要があります) をトランザクション入力として使用します

withResources

リソースのリストをトランザクション入力として使用する

23.5.11.1. メソッド withBundle

署名:

  • String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

bundle

トランザクションで使用するバンドル

IBaseBundle

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

stringBundle

トランザクションで使用するバンドル

String

23.5.11.2. メソッド withResources

署名:

  • java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> withResources(java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> resources, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

resources

トランザクションで使用するリソース

リスト

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.12. API: 更新

producer と consumer の両方がサポート対象

更新 API は、次の構文で定義されます。

fhir:update/methodName?[parameters]

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

メソッド説明

resource

サーバー上の IBaseResource を ID で更新します

resourceBySearchUrl

検索 URL によってサーバー上の IBaseResource を更新します

23.5.12.1. メソッドリソース

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

id

リソースを参照する IIdType

IIdType

preferReturn

サーバーが結果の一部としてリソース本体を含めるか抑制するか

PreferReturnEnum

resource

更新するリソース (患者など)

IBaseResource

resourceAsString

更新するリソース本体

String

stringId

リソースを参照する ID

String

23.5.12.2. メソッド resourceBySearchUrl

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

preferReturn

サーバーが結果の一部としてリソース本体を含めるか抑制するか

PreferReturnEnum

resource

更新するリソース (患者など)

IBaseResource

resourceAsString

更新するリソース本体

String

url

特定の検索 URL に対して条件付きの作成として更新を実行する必要があることを指定します。

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

23.5.13. API: 検証

producer と consumer の両方がサポート対象

検証 API は、構文で次のように定義されます。

fhir:validate/methodName?[parameters]

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

メソッド説明

resource

リソースを検証します

23.5.13.1. メソッドリソース

署名:

  • ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

パラメーター説明タイプ

extraParameters

渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。

マップ

resource

検証する IBaseResource

IBaseResource

resourceAsString

検証する生のリソース

String

上記のパラメーターに加えて、fhir API は任意の クエリーパラメーター も使用できます。

いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelFhir.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHereCamelFhir.myParameterNameHere ヘッダーをオーバーライドします。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.