19.5. API 参数(13 API)


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

fhir:apiName/methodName

下表列出了 13 个 API 名称:

API 名称类型描述

功能

两者

API 以调整服务器的功能声明

create

两者

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

delete

两者

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

history

两者

历史记录方法的 API

load-page

两者

使用页面捆绑包中指定的链接,从页面集加载之前/下一个资源捆绑包的 API。

meta

两者

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

operation

两者

扩展 FHIR 操作的 API

patch

两者

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

读取

两者

用于读取操作的 API 方法

search

两者

用于搜索匹配给定条件集的资源的 API

transaction

两者

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

update

两者

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

validate

两者

用于验证资源的 API

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

19.5.1. API:功能

支持制作者和消费者

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

fhir:capabilities/methodName?[parameters]

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

方法Alias描述

ofType

 

使用给定的模型类型检索符合条件语句

19.5.1.1. Type 方法

签名:

  • 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

map

type

模型类型

除了以上参数外,fhir API 还可使用任意。

任何参数都可以在端点 URI 中提供,也可以在消息标头中动态提供。邮件标题名称必须为 CamelFhir.parameter.inBody 参数覆盖消息标头,例如,Body=myParameterNameHere 的 endpoint 参数会覆盖 CamelFhir.myParameterNameHere 标头。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.