22.5. 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 名称类型描述

功能

both

API 到 Fetch 的服务器的 capabilities 语句

create

both

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

delete

both

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

history

both

history 方法的 API

load-page

both

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

meta

both

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

operation

both

用于扩展 FHIR 操作的 API

patch

both

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

读取

both

读取操作的 API 方法

search

both

API 用于搜索与给定一组条件匹配的资源

事务

both

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

update

both

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

validate

both

用于验证资源的 API

每个 API 记录在以下部分。

22.5.1. API: 功能

支持制作者和使用者

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

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

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

Expand
方法描述

ofType

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

22.5.1.1. Type 方法

签名:

  • org.hl7.fhir.instance.model.api.IBaseConformance ofType (Class<org.hl7.fhir.instance.model.api.IBaseConformance> 类型, 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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.2. api: create

支持制作者和使用者

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

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

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

Expand
方法描述

resource

在服务器上创建一个 IBaseResource

22.5.2.1. 方法资源

签名:

  • ca.uhn.fhir.rest.api.MethodOutcome 资源(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 资源(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, ObjectParameters);

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

字符串

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

任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。邮件标题名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.3. api: delete

支持制作者和使用者

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

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

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

Expand
方法描述

resource

删除给定资源

resourceById

按资源类型 e 删除资源

resourceConditionalByUrl

指定应根据给定的搜索 URL 以条件删除形式执行删除

22.5.3.1. 方法资源

签名:

  • org.hl7.fhir.instance.model.api.IBaseOperationOutcome 资源(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

22.5.3.2. method 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 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

id

使用 IIdType 引用资源

IIdType

stringId

它是 id

字符串

type

资源类型,如 Patient

字符串

22.5.3.3. method 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 方法具有下表中列出的参数:

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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.4. API: history

支持制作者和使用者

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

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

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

Expand
方法描述

onInstance

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

onServer

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

onType

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

22.5.4.1. 对Instance 的方法

签名:

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

Expand
参数描述类型

数量

请求服务器仅返回最多Count 个资源数,可能为 NULL

整数

cutoff

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

Date

extraParameters

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

map

iCutoff

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

IPrimitiveType

id

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

IIdType

returnType

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

22.5.4.2. Server 的方法

签名:

  • 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, 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 服务器,请使用此方法。

22.5.4.3. Type 的方法

签名:

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

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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.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

使用与捆绑包中相关的链接来加载前面的结果页面

22.5.5.1. method 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 方法有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

returnType

返回类型

url

搜索 url

字符串

22.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 方法具有下表中列出的参数:

Expand
参数描述类型

bundle

IBaseBundle

IBaseBundle

extraParameters

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

map

22.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 方法有下表中列出的参数:

Expand
参数描述类型

bundle

IBaseBundle

IBaseBundle

extraParameters

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

map

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

任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。邮件标题名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.6. api: meta

支持制作者和使用者

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

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

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

Expand
方法描述

add

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

delete

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

getFromResource

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

getFromServer

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

getFromType

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

22.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 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

id

id

IIdType

meta

IBaseMetaType 类

IBaseMetaType

22.5.6.2. 删除方法

签名:

  • 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

22.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> extra;

fhir/getFromResource API 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

id

id

IIdType

metaType

IBaseMetaType 类

22.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 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

metaType

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

22.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.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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.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

22.5.7.1. 对Instance 的方法

签名:

  • 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> outputType, 布尔值 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

用于输出参数的 type (这应该设置为 Parameters.class 从您使用的 FHIR 结构版本中提取),可能是 NULL

parameters

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

IBaseParameters

returnType

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

useHttpGet

使用 HTTP GET 动词

布尔值

22.5.7.2. 对InstanceVersion 的方法

签名:

  • 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> outputType, 布尔值 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

用于输出参数的 type (这应该设置为 Parameters.class 从您使用的 FHIR 结构版本中提取),可能是 NULL

parameters

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

IBaseParameters

returnType

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

useHttpGet

使用 HTTP GET 动词

布尔值

22.5.7.3. Server 的方法

签名:

  • 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.api. java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

Expand
参数描述类型

extraParameters

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

map

name

操作名称

字符串

outputParameterType

用于输出参数的 type (这应该设置为 Parameters.class 从您使用的 FHIR 结构版本中提取),可能是 NULL

parameters

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

IBaseParameters

returnType

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

useHttpGet

使用 HTTP GET 动词

布尔值

22.5.7.4. Type 的方法

签名:

  • 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, 布尔值 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

用于输出参数的 type (这应该设置为 Parameters.class 从您使用的 FHIR 结构版本中提取),可能是 NULL

parameters

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

IBaseParameters

resourceType

要操作的资源类型

returnType

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

useHttpGet

使用 HTTP GET 动词

布尔值

22.5.7.5. method 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.fhir.fhir.api.api.api.

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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.8. API: patch

支持制作者和使用者

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

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

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

Expand
方法描述

patchById

将补丁应用到给定资源 ID

patchByUrl

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

22.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> 额外;

fhir/patchById API 方法有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

id

要修补的资源 ID

IIdType

patchBody

补丁文档的正文以符合 XML 或 JSON 进行序列化

字符串

preferReturn

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

PreferReturnEnum

stringId

要修补的资源 ID

字符串

22.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 方法具有下表中列出的参数:

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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.9. API: read

支持制作者和使用者

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

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

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

Expand
方法描述

resourceById

按 id 读取服务器上的 IBaseResource

resourceByUrl

按 url 在服务器上读取 IBaseResource

22.5.9.1. method resourceById

签名:

  • org.hl7.fhir.instance.model.api.IBaseResource resourceById (Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, LongId, 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, 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, BooleanNull, 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 (String resourceClass, Long longId, String ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, ObjectParameters> 额外;
  • 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.api.api, ObjectParameters;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, 布尔值 throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);

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

资源版本

字符串

22.5.9.2. method 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.v.model.api.IBaseResource returnResource, 布尔值 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, 布尔值 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 resourceByUrl (String resourceClass, String url, String ifVersionMatches, boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.camel.component.fhir.api.ExtraParameters, ObjectParameters>, ObjectParameters; extra
  • 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.v.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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.11. API: transaction

支持制作者和使用者

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

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

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

Expand
方法描述

withBundle

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

withResources

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

22.5.11.1. 带有Bundle 的方法

签名:

  • 带有Bundle (String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
  • org.hl7.fhir.instance.model.api.IBaseBundles (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

在事务中使用的捆绑包

字符串

22.5.11.2. method 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 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

resources

在事务中使用的资源

list

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

任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。邮件标题名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.12. API: update

支持制作者和使用者

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

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

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

Expand
方法描述

resource

按 id 更新服务器上的 IBaseResource

resourceBySearchUrl

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

22.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 资源(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> extra);
  • ca.uhn.fhir.rest.api.MethodOutcome 资源(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> extra);
  • ca.uhn.fhir.rest.api.MethodOutcome 资源(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 方法具有下表中列出的参数:

Expand
参数描述类型

extraParameters

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

map

id

使用 IIdType 引用资源

IIdType

preferReturn

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

PreferReturnEnum

resource

要更新的资源(如 Patient)

IBaseResource

resourceAsString

要更新的资源正文

字符串

stringId

引用资源的 ID

字符串

22.5.12.2. method 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.camel.component.fhir.api.ExtraParameters>, ObjectParameters>; extra

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

Expand
参数描述类型

extraParameters

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

map

preferReturn

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

PreferReturnEnum

resource

要更新的资源(如 Patient)

IBaseResource

resourceAsString

要更新的资源正文

字符串

url

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

字符串

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

任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。邮件标题名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

22.5.13. api: validate

支持制作者和使用者

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

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

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

Expand
方法描述

resource

验证资源

22.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 资源(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 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat