19.5.7. API: 操作
支持制作者和消费者
操作 API 按照以下语法定义:
fhir:operation/methodName?[parameters]
下表中列出了 5 个方法,后面列出了每种方法的详细语法。(API 方法可以有一个简写的别名名称,可在语法中使用,而不是名称。)
方法 | Alias | 描述 |
---|---|---|
在服务器中对特定资源的所有版本执行操作(按 ID 和类型) | ||
此操作对资源的一个特定版本运行 | ||
对服务器上所有类型资源的所有版本执行操作 | ||
在服务器中给定类型的所有资源的所有版本执行操作 | ||
此操作称为 $process-message,如 FHIR 规格所定义 |
19.5.7.1. 实例方法
签名:
- 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 参数, Class<org.hl7.fhir.instance.model.api 布尔值 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 方法具有下表中列出的参数:
参数 | 描述 | 类型 |
---|---|---|
extraParameters | 有关可传递的参数的完整列表,请参阅 ExtraParameters,可以是 NULL | map |
id | 资源(将剥离) | IIdType |
name | 操作名称 | 字符串 |
outputParameterType | 用于输出参数的类型(应该从您使用的 FHIR 结构中将其设置为 Parameters.class drawn),可以是 NULL | 类 |
parameters | 用作输入的参数。如果操作不需要任何输入参数,则可能为空。 | IBaseParameters |
returnType | 如果此操作返回单个资源正文作为其返回类型,则使用此方法来指定该资源类型。这对返回捆绑包而非参数资源的某些操作(例如 Patient/NN/$everything)可能会是 NULL | 类 |
useHttpGet | 使用 HTTP GET 动词 | 布尔值 |