1.5 已定义的 RESTful API 操作（功能）

工作组: FHIR Infrastructure 成熟度: N/A标准状态: Informative

RESTful API定义了一组通用的交互动作（读取，更新，搜索等）可以操作储存库中已知类型的资源。 有关如何定义和调用操作的更多信息，请参阅RESTful API 的扩展操作。

此规范定义的操作的完整列表如下：

基本操作 (所有资源类型 )
资源的验证操作（$validate） [基地址]/[资源]/$validate | [基地址]/[资源]/[id]/$validate
获取配置、标签和安全信息的列表 [基地址]/$meta | [基地址]/[资源]/$meta | [基地址]/[资源]/[id]/$meta
向某个资源添加配置、标签和安全信息 [基地址]/[资源]/[id]/$meta-add
删除某个资源的配置、标签和安全信息 [基地址]/[资源]/[id]/$meta-delete
资源表述格式的转换 [基地址]/$convert
执行GraphQL语句 [基地址]/$graphql | [基地址]/[资源]/[id]/$graphql
返回一组图谱资源 [基地址]/[资源]/[id]/$graph
由资源类型定义的操作
应用活动定义[基地址]/ActivityDefinition/$apply | [基地址]/ActivityDefinition/[id]/$apply
获取某个活动定义的数据需求 [基地址]/ActivityDefinition/[id]/$data-requirements
获取能力声明资源的子集[基地址]/CapabilityStatement/$subset | [基地址]/CapabilityStatement/[id]/$subset
测试服务器是否实现了客户端所需的操作[基地址]/CapabilityStatement/$implements
[基地址]/CapabilityStatement/[id]/$implements
完整的对比两个能力声明 [基地址]/CapabilityStatement/$conforms
发现服务端支持的版本[基地址]/$versions
应用收费项目定义 [基地址]/ChargeItemDefinition/[id]/$apply
为获得理赔信息而提交保险理赔资源[基地址]/Claim/$submit
概念查找与分解[基地址]/CodeSystem/$lookup
基于编码系统的验证[基地址]/CodeSystem/$validate-code | [基地址]/CodeSystem/[id]/$validate-code
编码包含关系测试[基地址]/CodeSystem/$subsumes | [基地址]/CodeSystem/[id]/$subsumes
通过属性查找编码[基地址]/CodeSystem/$find-matches | [基地址]/CodeSystem/[id]/$find-matches
生成共享文档[基地址]/Composition/$document | [基地址]/Composition/[id]/$document
概念的编码转换[基地址]/ConceptMap/$translate | [基地址]/ConceptMap/[id]/$translate
维护层级（树型）数据表 [基地址]/$closure
提交保险资格查询资源（EligibilityRequest）以进行评估 [基地址]/CoverageEligibilityRequest/$submit
获取某个医疗活动的相关记录 [基地址]/Encounter/[id]/$everything
获取一组病人的所有记录[基地址]/Group/[id]/$everything
模型数据需求[基地址]/$data-requirements | [基地址]/Library/[id]/$data-requirements
根据功能代码查找患者的当前资源列表 [基地址]/List/$find
执行测量的计算（评估） [基地址]/Measure/$evaluate-measure | [基地址]/Measure/[id]/$evaluate-measure
评估的数据需求 [基地址]/Measure/[id]/$data-requirements
为评估提交收集的结果数据 [基地址]/Measure/$submit-data | [基地址]/Measure/[id]/$submit-data
为评估收集相关数据 [基地址]/Measure/$collect-data | [基地址]/Measure/[id]/$collect-data
根据质量评估决定护患比[基地址]/Measure/$care-gaps
获取药品的所有相关资源 [基地址]/MedicinalProduct/$everything | [基地址]/MedicinalProduct/[id]/$everything
处理消息[基地址]/$process-message
获取首选id [基地址]/NamingSystem/$preferred-id
观测数据统计[基地址]/Observation/$stats
查询最近几条观测数据 [基地址]/Observation/$lastn
使用患者主索引(MPI)查找匹配的患者 [基地址]/Patient/$match
获取某患者所有相关记录[基地址]/Patient/$everything | [基地址]/Patient/[id]/$everything
应用方案定义 [基地址]/PlanDefinition/$apply | [基地址]/PlanDefinition/[id]/$apply
方案定义的数据要求[基地址]/PlanDefinition/[id]/$data-requirements
根据资源的结构定义创建问卷资源 [基地址]/StructureDefinition/$questionnaire | [基地址]/StructureDefinition/[id]/$questionnaire
生成某个结构定义的快照 [基地址]/StructureDefinition/$snapshot | [基地址]/StructureDefinition/[id]/$snapshot
根据结构映射转换其模型实例 [基地址]/StructureMap/$transform | [基地址]/StructureMap/[id]/$transform
展开值集[基地址]/ValueSet/$expand | [基地址]/ValueSet/[id]/$expand
验证编码值是否在某个值集中[基地址]/ValueSet/$validate-code | [基地址]/ValueSet/[id]/$validate-code

注意：

  • 对meta元数据的特殊操作也支持资源的历史版本（/_history/）。只有这此操作可以对“当前”版本以外的其它版本进行操作。
  • 实施指南可以定义其他操作

1.5.1 FHIR规范定义的服务

此规范定义了一组服务，这些服务是业务级 资源 和操作的集合，它们提供了一个已定义的、与已知业务需求相对应的功能包。

注意，除了本规范中定义的服务之外，许多实施指南 还定义了业务级服务。

下表列出了当前已定义的服务：

名称 描述 相关链接
术语服务
(Terminology Service)

一种允许你不必成为精通编码系统、值集和概念映射资源以及基础编码系统和术语原则的详细信息方面的专家。 就可以让你的卫生健康应用程序使用编码、编码系统和值集的服务。此服务提供以下功能：

  • 定义和管理编码系统、值集和概念映射
  • 编码查找和验证
  • 值集展开（包括UI数据输入支持）
  • 值集验证
  • 编码系统之间转换
  • 包含性测试和其他逻辑分析
  • 维护层级（树型）数据表
 术语服务器能力声明
术语组件
符合性服务
(Conformance Service)		 一种基础服务，用于测试资源是否符合FHIR规范和适用的实施指南定义的规则。它还有助于实施指南的编写。 该服务提供以下功能：
  • 定义和管理结构定义、数据元素、能力声明、搜索参数以及操作和逻辑区块定义
  • 资源验证
  • 对比能力声明并获取其子集
 正在开发
知识库 一种为临床知识相关产物提供基本检索和维护功能的服务。该服务提供以下功能：
  • 定义和管理计划、活动定义（例如医嘱组集、规程、决策支持规则、文档模板等）、知识库和评估。
  • 搜索并获取知识相关产物
  • 对知识产物的数据需求分析
 知识库能力声明
临床推理组件
评估处理

提供与评估相关的服务。该服务提供以下功能：

  • 搜索并获取评估定义
  • 对患者和人群的评估
  • 对评估定义的数据需求分析
评估服务能力声明
临床推理组件

在未来版本可能的提供的候选业务服务

  • 转换服务（使用映射语言，以及资源中的ISO语义转换(iso-semantic transforms)
  • 问卷相关功能（参见SDC)
  • 患者注册与协调服务(每个IXS)
  • 药物管理服务（为家庭提供特定变体？）
  • 临床数据仓库(CDR,Clinical Data Repository)
  • 临床任务管理(CTM,Clinical Task Manager)
  • 沟通管理
  • ...?

请注意，在过去和现在，HL7中已经做了其的某些工作（尽管不一定是针对FHIR）