帮你快速理解、总结文档立即下载
文档中心>腾讯健康数据服务>API 文档>资源基础操作接口>Read

Read

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

我的收藏

本页目录：

接口描述

用于根据资源 ID 读取指定资源的最新版本内容。该接口遵循标准 FHIR Read 操作，客户端通过 HTTP GET 方法访问指定资源地址，服务端返回该资源当前最新版本的完整内容及版本信息。
本示例展示了读取 Patient 资源最新版本的调用方式。

输入参数

参数名称
类型
是否必填
说明
HTTP Method
String
是
固定为 GET。
URL
String
是
资源读取地址，格式为 [baseUrl]/[resourceType]/[id]。
Authorization
String
是
身份认证令牌，格式为 Bearer <AccessToken>，AccessToken 通过 调用方式 中的 GetAccessToken 接口获取（实例控制台场景可通过 GetWebAccessToken 接口获取）。
路径参数说明：
字段
类型
是否必填
说明
resourceType
String
是
FHIR 资源类型，例如 Patient、Observation、MedicationRequest 等。当前实例实际支持的全部资源类型，请通过 GET /INSTANCE_ID/fhir/metadata 调用 CapabilityStatement 接口，在返回的 rest[].resource[].type 中查看（实例支持的资源类型可在创建时通过 supported_resource_types 配置裁剪，不同实例可能不同）。各资源类型的字段定义可参见 FHIR Resource Types。
id
String
是
资源唯一 ID。为服务端创建资源时自动分配的逻辑 ID，可通过以下方式获取：
调用 创建接口（POST）创建资源，从响应头 Content-Location 或响应体 id 字段获取。
调用 搜索接口（GET /[resourceType]?_id= 或 /[resourceType]?identifier=）查询已有资源 ID。
请求 URL 示例：
https://HOSTNAME/INSTANCE_ID/fhir/Patient/199963

输出参数

接口调用成功后，通常返回 HTTP 状态码 200 OK，并在响应头中包含资源版本信息与当前版本地址，响应体中返回资源完整内容。
响应头示例说明：
参数名称
类型
说明
Status Code
Integer
成功时返回 200 OK。
ETag
String
资源版本标识，例如 W/"3"。
Content-Location
String
当前资源版本地址，格式为 [baseUrl]/[resourceType]/[id]/_history/[versionId]。
Last-Modified
String
资源最后修改时间，格式为 HTTP-date，例如 Fri, 03 Jul 2026 00:56:41 GMT。
响应体主要字段说明：
字段
类型
说明
resourceType
String
资源类型。
id
String
资源唯一 ID。
meta.versionId
String
当前资源版本号。
meta.lastUpdated
String
资源最后更新时间。
identifier
Array
标识信息。
name
Array
姓名信息。
gender
String
性别。
birthDate
String
出生日期。
address
Array
地址信息。

示例

请求示例

GET /INSTANCE_ID/fhir/Patient/199963 HTTP/1.1
Host: HOSTNAME
Authorization: Bearer YOUR_ACCESS_TOKEN

响应示例

HTTP/1.1 200 OK
ETag: W/"3"
Content-Location: https://HOSTNAME/INSTANCE_ID/fhir/Patient/199963/_history/3
Last-Modified: Mon, 06 Jul 2026 08:42:36 GMT
{
  "resourceType": "Patient",
  "id": "199963",
  "meta": {
    "versionId": "3",
    "lastUpdated": "2019-07-12T01:58:07.164+00:00"
  },
  "identifier": [
    {
      "system": "urn:oid:1.2.36.146.595.217.0.1",
      "value": "12345"
    }
  ],
  "name": [
    {
      "family": "Chalmers",
      "given": [
        "Peter",
        "James"
      ]
    }
  ],
  "gender": "male",
  "birthDate": "1974-02-13",
  "address": [
    {
      "line": [
        "534 Erewhon St"
      ],
      "city": "PleasantVille",
      "state": "Vic",
      "postalCode": "M5C 2X8"
    }
  ]
}

错误码

常见错误码如下，更多错误码请参见 错误码。
错误码
说明
400 Bad Request
请求格式错误或资源 ID 非法。
401 Unauthorized
未认证，缺少有效身份凭证。请检查请求头中是否携带正确的 Authorization: Bearer <AccessToken>，Token 是否已过期。
403 Forbidden
已认证但无读取该资源的权限。
404 Not Found
指定资源不存在。
410 Gone
资源已被逻辑删除或不可访问。
500 Internal Server Error
服务端内部处理异常。

中国站