帮你快速理解、总结文档立即下载
文档中心>腾讯健康数据服务>API 文档>搜索操作接口>排序搜索

排序搜索

最近更新时间：2026-07-28 16:18:01

我的收藏

本页目录：

接口描述

用于对 FHIR 搜索结果按指定字段进行排序。客户端可通过 HTTP GET 方法发起搜索请求，并使用 _sort 参数指定排序字段，从而按业务需要调整结果顺序。排序搜索支持按单个搜索字段排序和按多个搜索字段组合排序。
本示例展示了对 Patient 资源按姓氏和名字进行排序的常见方式。

输入参数

参数名称
类型
是否必填
说明
HTTP Method
String
是
固定为 GET。
URL
String
是
搜索地址，格式为 [baseUrl]/[resourceType]?[searchParams]。
Authorization
String
是
访问令牌，格式为 Bearer <AccessToken>。获取方式详见 调用方式。
Accept
String
否
响应格式，建议使用 application/fhir+json。
_sort
String
是
排序字段名称，可指定一个或多个字段，多个字段之间使用逗号分隔。
说明：
_sort=family 表示按姓氏排序。
_sort=family,given 表示先按姓氏排序，再按名字排序。
排序字段通常需要为该资源类型支持的搜索参数。
排序方向如需区分升序或降序，应以平台实际支持规则为准。

输出参数

接口调用成功后，通常返回 HTTP 状态码 200 OK，响应体一般为 Bundle 资源，包含排序后的资源列表及分页信息。
响应体主要字段说明：
字段
类型
说明
resourceType
String
返回资源类型，通常为 Bundle。
id
String
当前结果集唯一标识。
meta.lastUpdated
String
当前结果集生成时间。
type
String
Bundle 类型，搜索场景通常为 searchset。
total
Integer
命中的总记录数。默认情况下可能不返回此字段，仅当服务端能够高效计算总数时返回；当前服务端不支持通过 _total=accurate 强制返回准确总数。
entry
Array
排序后的结果列表。
entry[].fullUrl
String
资源完整访问地址。
entry[].resource
Object
匹配到的资源内容。
entry[].resource.id
String
资源的唯一 ID。
entry[].resource.meta
Object
资源元数据，包含 versionId、lastUpdated 等。
entry[].search.mode
String
搜索命中模式。
link
Array
分页链接信息。

示例

请求示例

示例一：按单个字段排序。
GET /INSTANCE_ID/fhir/Patient?_sort=family HTTP/1.1
Host: HOSTNAME
Authorization: Bearer <AccessToken>
Accept: application/fhir+json
示例二：按多个字段排序。
GET /INSTANCE_ID/fhir/Patient?_sort=family,given HTTP/1.1
Host: HOSTNAME
Authorization: Bearer <AccessToken>
Accept: application/fhir+json

响应示例

{
  "resourceType": "Bundle",
  "id": "2d7b3566-1773-40b3-abd4-0c8ebdd6466f",
  "meta": {
    "lastUpdated": "2026-07-08T21:24:05.941+08:00"
  },
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://HOSTNAME/INSTANCE_ID/fhir/Patient?_sort=family"
    },
    {
      "relation": "next",
      "url": "https://HOSTNAME/INSTANCE_ID/fhir?_getpages=2d7b3566-1773-40b3-abd4-0c8ebdd6466f&_getpagesoffset=2&_count=20&_bundletype=searchset"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://HOSTNAME/INSTANCE_ID/fhir/Patient/199963",
      "resource": {
        "resourceType": "Patient",
        "id": "199963",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-10-10T07:07:33.086-04:00"
        },
        "name": [
          {
            "family": "Chalmers",
            "given": [
              "James"
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://HOSTNAME/INSTANCE_ID/fhir/Patient/199964",
      "resource": {
        "resourceType": "Patient",
        "id": "199964",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-10-10T07:07:33.086-04:00"
        },
        "name": [
          {
            "family": "Chalmers",
            "given": [
              "Peter"
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

错误码

常见错误码如下，更多错误码请参见 错误码。
错误码
说明
400 Bad Request
_sort 参数格式错误，或排序字段不合法
401 Unauthorized
未认证，缺少有效身份凭证
403 Forbidden
已认证但无搜索该资源的权限
404 Not Found
指定资源类型不存在
422 Unprocessable Entity
排序参数语法正确，但未通过业务或规则校验
500 Internal Server Error
服务端内部处理异常

中国站