31.6. API 参数(13 API)


@FHIR 端点是基于 API 的组件,具有基于哪个 API 名称和 API 方法的额外参数。API 名称和 API 方法位于端点 URI 中,作为 apiName/methodName 路径参数:

fhir:apiName/methodName
Copy to Clipboard Toggle word wrap

下表列出 13 个 API 名称:

Expand
API 名称类型描述

功能

两者都

API 用于 Fetch 服务器的能力语句

create

两者都

创建操作的 API,用于在服务器上创建新资源实例

delete

两者都

删除操作的 API,它在服务器资源上执行逻辑删除

history

两者都

历史记录方法的 API

load-page

两者都

使用 atom 捆绑包中的 link type=next 标签中指定的链接,从分页集中加载之前/下一步资源捆绑包的 API

meta

两者都

meta 操作的 API,可用于获取、添加和删除资源或跨服务器中的标签和其他 Meta 元素

operation

两者都

扩展 FHIR 操作的 API

patch

两者都

补丁操作的 API,它在服务器资源上执行逻辑补丁

读取

两者都

用于读取操作的 API 方法

search

两者都

API 搜索与给定条件匹配的资源

Transactions

两者都

将事务(资源集合)发送到服务器以作为一个单元执行的 API

update

两者都

更新操作的 API,它在服务器资源上执行逻辑删除

validate

两者都

用于验证资源的 API

每个 API 记录在以下部分中。

31.6.1. API: capabilities

支持生成者和消费者

capabilities API 在语法中定义,如下所示:

fhir:capabilities/methodName?[parameters]
Copy to Clipboard Toggle word wrap

此方法列在下表中,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

ofType

使用给定的模型类型检索合规语句

31.6.1.1. Type 方法

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

type

模型类型

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.2. API: create

支持生成者和消费者

create API 以语法定义,如下所示:

fhir:create/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 1 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

resource

在服务器上创建一个 IBaseResource

31.6.2.1. 方法资源

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

preferReturn

在请求中添加 Prefer 标头,该请求服务器包含或阻止资源正文作为结果的一部分。如果服务器返回资源,它将通过 MethodOutcome#getResource ()解析一个可由客户端访问的资源,则可能是 null

PreferReturnEnum

resource

要创建的资源

IBaseResource

resourceAsString

要创建的资源

字符串

url

要使用的搜索 URL。此 URL 的格式应该是 ResourceTypeParameters,例如:Patientname=Smith&identifier=13.2.4.11.4%7C847366,可以是 null

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.3. API: delete

支持生成者和消费者

delete API 以语法定义,如下所示:

fhir:delete/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 3 种方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

resource

删除给定资源

resourceById

按资源类型 e 删除资源

resourceConditionalByUrl

指定删除应作为一个条件删除对给定的搜索 URL 执行

31.6.3.1. 方法资源

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

resource

要删除的 IBaseResource

IBaseResource

31.6.3.2. 方法 resourceById

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

引用资源的 IIdType

IIdType

stringId

它是 id

字符串

type

资源类型,如 Patient

字符串

31.6.3.3. method resourceConditionalByUrl

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

url

要使用的搜索 URL。此 URL 的格式应该是 ResourceTypeParameters,例如:Patientname=Smith&identifier=13.2.4.11.4%7C847366

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.4. API: history

支持生成者和消费者

历史 API 以语法定义,如下所示:

fhir:history/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 3 种方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

onInstance

在服务器上对特定资源(按 ID 和类型)在所有版本间执行操作

onServer

对服务器上所有类型的所有资源版本执行操作

onType

对服务器上给定类型的所有资源的所有版本执行操作

31.6.4.1. method onInstance

signatures:

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

fhir/onInstance API 方法在下表中列出的参数:

Expand
参数描述类型

数�

请求服务器只返回资源Count 数量(可能为 NULL)

整数

cutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

Date

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

iCutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

IPrimitiveType

id

必须使用资源类型和资源 ID 填充的 IIdType

IIdType

returnType

请求该方法返回 Bundle 资源(如 ca.uhn.fhir.model.dstu2.resource.Bundle)。如果您要访问 DSTU2 服务器,请使用此方法。

31.6.4.2. Server 上的方法

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

数�

请求服务器只返回资源Count 数量(可能为 NULL)

整数

cutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

Date

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

iCutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

IPrimitiveType

returnType

请求该方法返回 Bundle 资源(如 ca.uhn.fhir.model.dstu2.resource.Bundle)。如果您要访问 DSTU2 服务器,请使用此方法。

31.6.4.3. 方法 onType

signatures:

  • 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, 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 方法在下表中列出的参数:

Expand
参数描述类型

数�

请求服务器只返回资源Count 数量(可能为 NULL)

整数

cutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

Date

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

iCutoff

请求服务器仅返回给定时间(包含)后或之后创建的资源版本可能为 NULL

IPrimitiveType

resourceType

要搜索的资源类型

returnType

请求该方法返回 Bundle 资源(如 ca.uhn.fhir.model.dstu2.resource.Bundle)。如果您要访问 DSTU2 服务器,请使用此方法。

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.5. api: load-page

支持生成者和消费者

载入页面 API 以语法中定义,如下所示:

fhir:load-page/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 3 种方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

byUrl

使用给定 URL 和捆绑包类型加载结果页面,并返回 DSTU1 Atom 捆绑包

next

使用捆绑包中下一个关系的链接来加载下一页的结果

previous

使用捆绑包中关系 prev 的链接加载前面的结果页面

31.6.5.1. method byUrl

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

returnType

返回类型

url

搜索 url

字符串

31.6.5.2. 下一步方法

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

bundle

IBaseBundle

IBaseBundle

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

31.6.5.3. 之前的方法

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

bundle

IBaseBundle

IBaseBundle

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.6. api: meta

支持生成者和消费者

meta API 以语法定义,如下所示:

fhir:meta/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 5 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

add

将给定元数据中的元素添加到已存在的集合中(请勿删除任何)

delete

从给定的 ID 中删除给定元数据中的元素

getFromResource

从特定资源获取当前元数据

getFromServer

从整个服务器获取当前元数据

getFromType

从特定类型的中获取当前元数据

31.6.6.1. 方法添加

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

id

IIdType

meta

IBaseMetaType 类

IBaseMetaType

31.6.6.2. 方法删除

signatures:

  • 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 方法包含下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

id

IIdType

meta

IBaseMetaType 类

IBaseMetaType

31.6.6.3. 方法 getFromResource

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

id

IIdType

metaType

IBaseMetaType 类

31.6.6.4. 方法 getFromServer

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

metaType

给定 FHIR 模型版本的 meta 数据类型(应该为 MetaDt.class 或 MetaType.class)

31.6.6.5. 方法 getFromType

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

metaType

IBaseMetaType 类

resourceType

资源类型,如 Patient

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.7. API: 操作

支持生成者和消费者

操作 API 以语法定义,如下所示:

fhir:operation/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 5 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

onInstance

在服务器上对特定资源(按 ID 和类型)在所有版本间执行操作

onInstanceVersion

此操作在资源的特定版本上运行

onServer

对服务器上所有类型的所有资源版本执行操作

onType

对服务器上给定类型的所有资源的所有版本执行操作

processMessage

此操作称为由 FHIR 规范定义的 $process-message

31.6.7.1. method onInstance

signatures:

  • org.hl7.fhir.instance.model.api.IBaseResource onInstance (org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, 布尔值 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

Map

id

资源(版本将被剥离)

IIdType

name

操作名称

字符串

outputParameterType

用于输出参数的类型(这应设置为来自您使用的 FHIR 结构版本的 Parameters.class drawn),可以是 NULL。

parameters

用作输入的参数。如果操作不需要任何输入参数,则也可能为 null。

IBaseParameters

returnType

如果此操作返回单个资源正文作为其返回类型而不是 Parameters 资源,请使用此方法指定该资源类型。这对返回捆绑包而不是 Parameters 资源的某些操作(如 Patient/NN/$everything)非常有用。

useHttpGet

使用 HTTP GET 动词

布尔值

31.6.7.2. method onInstanceVersion

signatures:

  • org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion (org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, 布尔值 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

资源版本

IIdType

name

操作名称

字符串

outputParameterType

用于输出参数的类型(这应设置为来自您使用的 FHIR 结构版本的 Parameters.class drawn),可以是 NULL。

parameters

用作输入的参数。如果操作不需要任何输入参数,则也可能为 null。

IBaseParameters

returnType

如果此操作返回单个资源正文作为其返回类型而不是 Parameters 资源,请使用此方法指定该资源类型。这对返回捆绑包而不是 Parameters 资源的某些操作(如 Patient/NN/$everything)非常有用。

useHttpGet

使用 HTTP GET 动词

布尔值

31.6.7.3. Server 上的方法

signatures:

  • org.hl7.fhir.instance.model.api.IBaseResource onServer (String name, org.hl7.fhir.instance.model.api.IBaseParameters 参数, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource>, returnTypeType java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

fhir/onServer API 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

name

操作名称

字符串

outputParameterType

用于输出参数的类型(这应设置为来自您使用的 FHIR 结构版本的 Parameters.class drawn),可以是 NULL。

parameters

用作输入的参数。如果操作不需要任何输入参数,则也可能为 null。

IBaseParameters

returnType

如果此操作返回单个资源正文作为其返回类型而不是 Parameters 资源,请使用此方法指定该资源类型。这对返回捆绑包而不是 Parameters 资源的某些操作(如 Patient/NN/$everything)非常有用。

useHttpGet

使用 HTTP GET 动词

布尔值

31.6.7.4. 方法 onType

signatures:

  • 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> outputType, outputType, 布尔值 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

name

操作名称

字符串

outputParameterType

用于输出参数的类型(这应设置为来自您使用的 FHIR 结构版本的 Parameters.class drawn),可以是 NULL。

parameters

用作输入的参数。如果操作不需要任何输入参数,则也可能为 null。

IBaseParameters

resourceType

要操作的资源类型

returnType

如果此操作返回单个资源正文作为其返回类型而不是 Parameters 资源,请使用此方法指定该资源类型。这对返回捆绑包而不是 Parameters 资源的某些操作(如 Patient/NN/$everything)非常有用。

useHttpGet

使用 HTTP GET 动词

布尔值

31.6.7.5. method processMessage

signatures:

  • 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>, ObjectParameters; extraParameters; extraParameter

fhir/processMessage API 方法在下表中列出的参数:

Expand
参数描述类型

asynchronous

是否异步处理消息,还是同步,默认为同步。

布尔值

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

msgBundle

将 Message Bundle 设置为 POST 到消息传递服务器

IBaseBundle

respondToUri

可选的查询参数(表示来自接收服务器的响应应发送到这个 URI)可以是 NULL

字符串

responseClass

响应类

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.8. API: patch

支持生成者和消费者

patch API 以语法定义,如下所示:

fhir:patch/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表列出 2 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

patchById

将补丁应用到给定的资源 ID

patchByUrl

指定更新应作为针对给定搜索 URL 创建的条件执行

31.6.8.1. 方法 patchById

signatures:

  • ca.uhn.fhir.rest.api.MethodOutcome patchById (String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

要修补的资源 ID

IIdType

patchBody

补丁文档在 XML 或 JSON 中序列化的正文

字符串

preferReturn

在请求中添加 Prefer 标头,该请求服务器包含或阻止资源正文作为结果的一部分。如果服务器返回资源,它将通过 MethodOutcome#getResource ()解析可由客户端访问的资源。

PreferReturnEnum

stringId

要修补的资源 ID

字符串

31.6.8.2. 方法 patchByUrl

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

patchBody

补丁文档在 XML 或 JSON 中序列化的正文

字符串

preferReturn

在请求中添加 Prefer 标头,该请求服务器包含或阻止资源正文作为结果的一部分。如果服务器返回资源,它将通过 MethodOutcome#getResource ()解析可由客户端访问的资源。

PreferReturnEnum

url

要使用的搜索 URL。此 URL 的格式应该是 ResourceTypeParameters,例如:Patientname=Smith&identifier=13.2.4.11.4%7C847366

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.9. api: read

支持生成者和消费者

read API 以语法定义,如下所示:

fhir:read/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表列出 2 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

resourceById

根据 id 读取服务器上的 IBaseResource

resourceByUrl

使用 url 读取服务器上的 IBaseResource

31.6.9.1. 方法 resourceById

signatures:

  • 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, String ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource> 布尔值 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, 布尔值 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, returnResource 布尔值 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.model.api.IBaseResource returnResource, boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.Parameters, 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, java.util.Map<org.apache.camel.component.fhir.api.Parameters>, ObjectParameters>

fhir/resourceById API 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

引用资源的 IIdType

IIdType

ifVersionMatches

与服务器上最新版本匹配的版本

字符串

longId

资源 ID

Long

resource

要读取的资源(如 Patient)

resourceClass

要读取的资源(如 Patient)

字符串

returnNull

如果版本匹配,则返回 null

布尔值

returnResource

如果版本匹配,则返回资源

IBaseResource

stringId

资源 ID

字符串

throwError

如果版本匹配,则抛出错误

布尔值

version

资源版本

字符串

31.6.9.2. method resourceByUrl

signatures:

  • org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl (Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String url, ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, String url, ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource> 布尔值 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, returnResourceResource, string ifVersionMatches, organization.hl7.fhir 布尔值 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, String ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, 布尔值 throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

fhir/resourceByUrl API 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

iUrl

通过绝对 url 引用资源的 IIdType

IIdType

ifVersionMatches

与服务器上最新版本匹配的版本

字符串

resource

要读取的资源(如 Patient)

resourceClass

要读取的资源(如 Patient.class)

字符串

returnNull

如果版本匹配,则返回 null

布尔值

returnResource

如果版本匹配,则返回资源

IBaseResource

throwError

如果版本匹配,则抛出错误

布尔值

url

通过绝对 url 引用资源

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.11. API: transaction

支持生成者和消费者

事务 API 以语法定义,如下所示:

fhir:transaction/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表列出 2 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

withBundle

使用给定的原始文本(应是 Bundle 资源)作为事务输入

withResources

使用资源列表作为事务输入

31.6.11.1. 使用Bundle 的方法

signatures:

  • 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 方法在下表中列出参数:

Expand
参数描述类型

bundle

在事务中使用的捆绑包

IBaseBundle

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

stringBundle

在事务中使用的捆绑包

字符串

31.6.11.2. method withResources

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

资源

在事务中使用的资源

list

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.12. API: update

支持生成者和消费者

更新 API 以语法定义,如下所示:

fhir:update/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表列出 2 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

resource

按 id 更新服务器上的 IBaseResource

resourceBySearchUrl

通过搜索 url 更新服务器上的 IBaseResource

31.6.12.1. 方法资源

signatures:

  • 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 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 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.PreferReturnnumE preferReturnnum, java.util.Map<org.apache.camel.component.fhir.api.Parameters>s; extraParameters; extraParameters;

fhir/resource API 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

id

引用资源的 IIdType

IIdType

preferReturn

服务器是否包含或阻止资源正文作为结果的一部分

PreferReturnEnum

resource

要更新的资源(如 Patient)

IBaseResource

resourceAsString

要更新的资源正文

字符串

stringId

引用资源的 ID

字符串

31.6.12.2. method resourceBySearchUrl

signatures:

  • ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl (String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum 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 preferReturnEnum preferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

fhir/resourceBySearchUrl API 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

preferReturn

服务器是否包含或阻止资源正文作为结果的一部分

PreferReturnEnum

resource

要更新的资源(如 Patient)

IBaseResource

resourceAsString

要更新的资源正文

字符串

url

指定更新应作为针对给定搜索 URL 创建的条件执行

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

31.6.13. api: validate

支持生成者和消费者

validate API 在语法中定义,如下所示:

fhir:validate/methodName?[parameters]
Copy to Clipboard Toggle word wrap

下表中列出了 1 方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可用于语法而不是名称)

Expand
方法描述

resource

验证资源

31.6.13.1. 方法资源

signatures:

  • 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 方法在下表中列出的参数:

Expand
参数描述类型

extraParameters

有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL

Map

resource

用于验证的 IBaseResource

IBaseResource

resourceAsString

用于验证的原始资源

字符串

除了上面的参数外,fhir API 也可以使用任何 Query 参数

任何参数可以在端点 URI 中提供,也可以在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere 覆盖 CamelFhir.myParameterNameHere 标头。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat