20.5. API 参数(13 API)
@FHIR 端点是基于 API 的组件,并根据哪个 API 名称和 API 方法添加其他参数。API 名称和 API 方法位于端点 URI 中,作为 apiName/methodName
路径参数:
fhir:apiName/methodName
fhir:apiName/methodName
下表中列出了 13 个 API 名称:
API 名称 | 类型 | 描述 |
---|---|---|
两者 | API to Fh the server 的 capabilities 语句 | |
两者 | 创建操作的 API,这将在服务器上创建新资源实例 | |
两者 | 用于删除操作的 API,在服务器资源上执行逻辑删除 | |
两者 | 用于历史方法的 API | |
两者 | 从页面集加载前/下一步资源捆绑包的 API,使用 atom bundle 中链接 type=next 标签中指定的链接 | |
两者 | 用于 meta 操作的 API,可用于获取、添加和删除资源或跨服务器中的标签和其他元元素 | |
两者 | 扩展 FHIR 操作的 API | |
两者 | 用于 patch 操作的 API,它在服务器资源上执行逻辑补丁 | |
两者 | 读取操作的 API 方法 | |
两者 | 用于搜索与指定一组条件匹配的资源的 API | |
两者 | 将事务(资源集合)发送到服务器的 API 以作为一个单元的形式执行 | |
两者 | 用于更新操作的 API,在服务器资源中执行逻辑删除 | |
两者 | 用于验证资源的 API |
每个 API 都会在以下部分中进行介绍。
20.5.1. API:功能 复制链接链接已复制到粘贴板!
支持制作者和消费者
功能 API 在语法中定义,如下所示:
fhir:capabilities/methodName?[parameters]
fhir:capabilities/methodName?[parameters]
该方法在下表中列出,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可以在语法而不是名称中使用。)
方法 | 描述 |
---|---|
使用给定模型类型检索 conformance 语句 |
20.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。 | map |
type | 模型类型 | 类 |
除了以上参数外,fhir API 还可使用任何查询参数。???
任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。消息标头名称必须是 CamelFhir.parameter
的格式。inBody
参数覆盖消息标头,即 endpoint 参数 inBody=myParameterNameHere
会覆盖 CamelFhir.myParameterNameHere
标头。