Internet Hospital APIs
Last updated:2025-03-07 17:07:30
Overview
Digital and Intelligent Medical Imaging Platform (AIMIS) provides integration with Internet hospitals, enabling synchronization of user examination, report, and imaging information, as well as business interactions.
Parameter Description
HTTP API general signature uses the following signature algorithm:
${signature} = Hmac-Sha256(${token}, ${appId}+${timestamp})
Parameter description:
token: key, assigned by the Tencent system.
appId: partner ID, assigned by the Tencent system.
timestamp: timestamp, the current generated timestamp in milliseconds.
signature: generated key signature
All APIs require request authentication by including the corresponding information in the HTTP request header:
signature corresponds to the signature field in the HTTP protocol header.
appId corresponds to the appId field in the HTTP protocol header.
timestamp corresponds to the timestamp field in the HTTP protocol header.
Checklist Query API
Usage scenario: patient query for examination information completed within the hospital (distinguished by the usage field in the request parameter data purpose).
Protocol: HTTPS
Address: https://pacs.qq.com/thirdparty/patientStudies/${appId}
Data interaction format: JSON (application/json)
Use flow: patient examination list query > consultation to retrieve patient examination information > select candidate list to add examination information, distinguished by the usage field in the request parameter data purpose.
Request parameters.
Parameter Name | Type | Required or Not | Remarks |
phoneNum | string | Yes | Patient phone number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
idNum | string | Yes | Patient identity card number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
hisId | string | No | Hospital Information System ID, HIS number, if available |
patientName | string | No | Patient name |
hospitalId | string | Yes | Hospital ID (Tencent Miying Imaging Cloud System Hospital ID) |
unionId | string | Yes | Medical Consortium ID (Tencent Miying Imaging Cloud System Medical Consortium ID) |
studyType | int | Yes | Check type. 0: Radiology 1: Ophthalmology 2: Pathology 3: Endoscopy 4: Electrocardiogram 5: Ultrasound |
dataFlag | int | Yes | Data Identification. 0: Show all data of the patient 1: Show only data from this hospital (based on hospital ID) 2: Show data excluding this hospital (based on hospital ID) 3: Show only data from the current medical alliance (based on medical alliance ID) 4: Show data excluding the current medical alliance (based on medical alliance ID) |
usage | int | Yes | Data Purpose. 0: Patient views Checklist 1: Patient online consultation scenario 2: Doctor views patient details |
studyDateBegin | string | Yes | Check time query start time, yyyy-MM-dd hh:mm:ss. |
studyDateEnd | string | Yes | Check time query end time, yyyy-MM-dd hh:mm:ss. |
Request Return
Field | Type | Remarks |
code | int | Error code indicating whether the access was successful. 0: success; other values: failure. |
message | string | Error Description |
data | list (Study) | data detail, JSON list |
Checking Data Format
Field | Type | Remarks |
hisId | string | Hospital Information System ID, HIS number |
reportId | string | Imaging cloud returns reportId |
studyType | int | Check type. 0: Radiology 1: Ophthalmology 2: Pathology 3: Endoscopy 4: Electrocardiogram 5: Ultrasound |
studyDate | string | Check time, yyyy-MM-dd hh:mm:ss |
studyId | string | Check number, Check ID |
bodyPart | string | Inspection part |
studyName | string | Check project |
applyDoctor | string | Application doctor |
applyDoctorId | string | Application doctor ID |
applyDept | string | Application department |
applyDeptId | string | Application department ID |
uniAppId | string | mini program appid redirection |
uniPath | string | Check details, mini program jump path with parameters |
h5Url | string | Check report details, H5 redirection URL |
h5DetailUrl | string | Check imaging details, H5 redirection URL |
Consultation Record Query API
Usage scenario: Doctor queries remote consultation records
Protocol: HTTPS
Address: https://pacs.qq.com/thirdparty/patientConsultations/${appId}
Data interaction format: JSON (application/json)
Request parameters.
Parameter Name | Type | Required or Not | Remarks |
hisId | string | Yes | Hospital Information System ID, HIS number |
phoneNum | string | Yes | Patient phone number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
idNum | string | Yes | Patient identity card number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
patientName | string | No | Patient name |
hospitalId | string | Yes | Hospital ID (Tencent Miying Imaging Cloud System Hospital ID) |
unionId | string | Yes | Medical Consortium ID (Tencent Miying Imaging Cloud System Medical Consortium ID) |
Request Return
Field | Type | Remarks |
code | int | Error code indicating whether the access was successful. 0: success; other values: failure. |
message | string | Error Description |
data | struct | Data details |
<Data Format>
Field | Type | Remarks |
h5Url | string | Patient consultation list, H5 redirection URL |
Check Report URL Retrieval API
Protocol: HTTPS
Address: https://pacs.qq.com/thirdparty/patientReportUrl/${appId}
Data interaction format: JSON (application/json)
Use flow: After redirecting to the third-party mini program from the Imaging Cloud, get the Imaging Cloud report URL through reportId.
Request parameters.
Parameter Name | Type | Required or Not | Remarks |
reportId | string | Yes | Imaging cloud returns reportId |
phoneNum | string | Yes | Patient phone number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
idNum | string | Yes | Patient identity card number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
hospitalId | string | Yes | Hospital ID (Tencent Miying Imaging Cloud System Hospital ID) |
Request Return
Field | Type | Remarks |
code | int | Error code indicating whether the access was successful. 0: success; other values: failure. |
message | string | Error Description |
data | PatientStudyUrl | data detail, JSON object |
PatientStudyUrl Data Format
Field | Type | Remarks |
h5Url | string | Check report details, H5 redirection URL |
h5DetailUrl | string | Check imaging details, H5 redirection URL |
studyId | string | Check number, Check ID, aligned with hospital system |
Check Status Synchronization Callback API
Usage scenario: When receiving imaging examination information, report information, and image information on the Cloud Platform, the partner's API will be called back to synchronize Imaging Cloud status information, facilitating the wechat official account to push template messages.
Protocol: HTTPS
Address: defined by the partner
Data interaction format: JSON (application/json)
Request parameters.
Parameter Name | Type | Required or Not | Remarks |
status | int | Yes | 0: Only inspection information obtained 1: Report obtained 2: Image has been obtained 3: Report and image obtained |
phoneNum | string | Yes | Patient phone number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
idNum | string | Yes | Patient identity card number, encrypt the Field using the algorithm (AES-256-ECB + HEX), with the key being the same as the signature token (32 characters). |
patientId | string | Yes | Patient ID |
hospitalId | string | Yes | Hospital ID (Tencent Miying Imaging Cloud System Hospital ID) |
hisId | string | No | Hospital Information System ID, HIS number, if available |
studyType | int | Yes | Check type. 0: Radiology 1: Ophthalmology 2: Pathology 3: Endoscopy 4: Electrocardiogram 5: Ultrasound |
studyDate | string | Yes | Check time, yyyy-MM-dd hh:mm:ss |
studyId | string | Yes | Check number, Check ID |
bodyPart | string | No | Check the part, if available |
studyName | string | No | Check the item, if available |
h5Url | string | Yes | Check report details, H5 redirection URL |
h5DetailUrl | string | Yes | Check imaging details, H5 redirection URL |
reportId | string | Yes | Returned reportId, used to get the patient check report URL |
Request Return
Field | Type | Remarks |
code | int | Whether the request is successfully received, 0 for success, non-0 for failure |
message | string | Error Description |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback