22.5. API 参数(13 API)
@FHIR 端点是基于 API 的组件,具有额外的参数,基于哪些 API 名称和 API 方法。API 名称和 API 方法位于端点 URI 中,作为 apiName/methodName 路径参数:
fhir:apiName/methodName
下表列出了 13 个 API 名称:
| API 名称 | 类型 | 描述 |
|---|---|---|
| both | API 到 Fetch 的服务器的 capabilities 语句 | |
| both | 创建操作的 API,这会在服务器上创建新资源实例 | |
| both | delete 操作的 API,它会在服务器资源上执行逻辑删除 | |
| both | history 方法的 API | |
| both | 使用 atom 捆绑包中链接 type=next 标签中指定的链接 type=next 标签中指定的链接,从页面集中加载前/下一步资源捆绑包的 API | |
| both | meta 操作的 API,可用于获取、添加和删除资源或服务器中的标签和其他 Meta 元素 | |
| both | 用于扩展 FHIR 操作的 API | |
| both | patch 操作的 API,它对服务器资源执行逻辑补丁 | |
| both | 读取操作的 API 方法 | |
| both | API 用于搜索与给定一组条件匹配的资源 | |
| both | 用于将事务(资源集合)发送到要作为一个单元执行的服务器的 API | |
| both | 更新操作的 API,它会在服务器资源上执行逻辑删除 | |
| both | 用于验证资源的 API |
每个 API 记录在以下部分。
22.5.1. API: 功能 复制链接链接已复制到粘贴板!
支持制作者和使用者
capabilities API 在语法中定义,如下所示:
fhir:capabilities/methodName?[parameters]
此方法在下表中列出,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可以在语法中使用,而不是名称。)
| 方法 | 描述 |
|---|---|
| 使用给定的模型类型检索合规语句 |
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 方法具有下表中列出的参数:
| 参数 | 描述 | 类型 |
|---|---|---|
| extraParameters | 如需可以传递的完整参数列表,请参阅 ExtraParameters,可以是 NULL | map |
| type | 模型类型 | 类 |
除了上述参数外,fhir API 也可以使用任何 Query 参数。
任何参数都可以在端点 URI 中提供,或者在消息标头中动态提供。邮件标题名称必须是 CamelFhir.parameter 的格式。inBody 参数覆盖消息标头,即 Body=myParameterNameHere 中的端点参数将覆盖 CamelFhir.myParameterNameHere 标头。