22.5.7. api: 操作
支持制作者和使用者
操作 API 在语法中定义,如下所示:
fhir:operation/methodName?[parameters]
下表中列出了 5 种方法,后跟每种方法的详细语法。(API 方法可以有一个简写别名名称,可以在语法中使用,而不是名称。)
方法 | 描述 |
---|---|
对服务器上特定资源(按 ID 和类型)的所有版本执行操作 | |
此操作在资源的特定版本上运行 | |
对服务器上所有类型的所有资源都执行操作 | |
对服务器上给定类型的所有资源的所有版本执行操作 | |
此操作称为 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 方法具有下表中列出的参数:
参数 | 描述 | 类型 |
---|---|---|
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 动词 | 布尔值 |