tencent cloud

Tencent Healthcare Data Services

ドキュメントTencent Healthcare Data ServicesAPI DocumentationSearch Operation APIsPatient Information Search

Patient Information Search

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-08-28 16:06:55
AI翻訳

API Description

This is used to search for all resource data associated with a specified patient. The interface returns the patient's comprehensive associated information via the $everything operation on the patient instance. This information typically includes related resources such as basic patient information, visit records, test results, diagnoses, and medications.
This API is applicable to scenarios such as patient panoramic view, medical record summarization, and cross-resource data aggregation.
This example demonstrates how to invoke the patient $everything operation and control the number of items returned per page by using _count.

Input parameters

Parameter Name
Type
Required
Description
HTTP Method
String
Yes
Fixed as GET.
URL
String
Yes
The operation address, in the format [baseUrl]/Patient/[id]/$everything.
Authorization
String
Yes
The access token, in the format Bearer <AccessToken>. For details on how to obtain it, see Calling Method.
Accept
String
No
The response format. It is recommended to use application/fhir+json.
id
String
Yes
The unique ID of the patient resource. It can be obtained from the id field returned when the resource is created, or by querying the patient list via the Basic Search API.
_count
Integer
No
Controls the number of records returned per page.
Note:
The $everything operation is used to return multiple types of resources associated with the target patient.
The result is typically returned as a Bundle. It may be returned in pages if the data volume is large.
You can control the number of results per page by using the _count parameter.

Output Parameters

Upon a successful API call, the HTTP status code 200 OK is typically returned. The response body is usually a Bundle resource, which contains a collection of resources related to the specified patient, along with pagination information.
Key Response Body Field Descriptions:
Field
Type
Description
resourceType
String
Returns the resource type, usually Bundle.
id
String
Unique ID of the Bundle resource, usually a UUID.
meta
Object
Metadata of the Bundle, containing fields such as lastUpdated.
meta.lastUpdated
String
Generation time of the Bundle, in ISO 8601 format.
type
String
The Bundle type is usually searchset.
total
Integer
Total number of matched resources.
link
Array
Pagination link information, such as self, next, and so on.
entry
Array
List of associated resources.
entry[].fullUrl
String
The complete access URL of the resource.
entry[].resource
Object
Resource content related to the patient.
entry[].resource.id
String
Unique ID of the resource.
entry[].resource.meta
Object
Metadata of the resource, containing fields such as versionId and lastUpdated.
entry[].search.mode
String
Search hit mode, usually match.

Examples

Request Example

Example 1: Obtain all associated resources for the specified patient.
GET /INSTANCE_ID/fhir/Patient/1228032/$everything HTTP/1.1
Host: HOSTNAME
Authorization: Bearer <AccessToken>
Accept: application/fhir+json
Example 2: Control the number of items returned per page.
GET /INSTANCE_ID/fhir/Patient/1228032/$everything?_count=50 HTTP/1.1
Host: HOSTNAME
Authorization: Bearer <AccessToken>
Accept: application/fhir+json

Response Example

{
  "resourceType": "Bundle",
  "id": "c48fc429-6091-4f61-abce-62388b08ccbc",
  "meta": {
    "lastUpdated": "2026-07-09T18:45:41.430+08:00"
  },
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://HOSTNAME/INSTANCE_ID/fhir/Patient/1228032/$everything"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://HOSTNAME/INSTANCE_ID/fhir/Patient/1228032",
      "resource": {
        "resourceType": "Patient",
        "id": "1228032",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-10-10T07:07:33.086-04:00"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://HOSTNAME/INSTANCE_ID/fhir/Encounter/enc-20001",
      "resource": {
        "resourceType": "Encounter",
        "id": "enc-20001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-10-11T08:30:00.000+08:00"
        },
        "subject": {
          "reference": "Patient/1228032"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://HOSTNAME/INSTANCE_ID/fhir/Observation/obs-30001",
      "resource": {
        "resourceType": "Observation",
        "id": "obs-30001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-10-12T09:15:00.000+08:00"
        },
        "subject": {
          "reference": "Patient/1228032"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Error Codes

Common error codes are listed below. For more error codes, see Error Codes.
Error Code
Description
400 Bad Request
The request parameter format is incorrect, or the patient ID is invalid.
401 Unauthorized
Not authenticated, and valid credentials are missing.
403 Forbidden
Authenticated but not authorized to access the patient's complete data.
404 Not Found
The specified patient does not exist.
422 Unprocessable Entity
The request syntax is correct, but it fails business or rule validation.
500 Internal Server Error
Internal server processing exception.

前の記事へ: Sorting and Searching次の記事へ: Basic Bundle Transactions

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック