tencent cloud

Check Cloud Migration APIs
Download PDF
Last updated: 2025-03-07 17:07:29
Check Cloud Migration APIs
Last updated: 2025-03-07 17:07:29
Download PDF
This API enables the existing third-party systems in the hospital (e.g., PACS, RIS) to push examination information, reports, and images to the gateway, and then stores them in the cloud.

Authentication Method

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.

API Description

trigger timing: upon completion of the check, upload the check information when the image is received.
Transmission Protocol: HTTPS POST
Data interaction format: JSON (Content-Type: application/json)
API address: Address: https://${host}/ris/study/add, where host is the IP of the deployed front-end machine.
API parameter type description:
Parameter Type
Type Overview
A
Required. Missing this will cause an error and reject data reception, resulting in business disruption.
B
Required if present. Missing this will still allow data reception but may affect business operations.
C
Optional. Missing this will still allow data reception and will not affect business operations.

Request Parameters

Parameter Name
Type
Required or Not
Parameter Type
Remarks
patientId
string
Required
A
Patient ID
patientName
string
Required
A
Patient name
patientSex
string
Required
A
Patient gender
M: Male
F: Female
O: Others
studyId
string
Required
A
Check ID
accessNumber
string
Required
A
AccessNumber
modality
string
Required
A
Device Type
patientAge
string
Required
B
Patient age
patientAgeUnit
string
Required
B
Patient age unit, Y (years), M (months), D (days)
patientBirthday
string
Required
B
Patient's birthday, yyyy-MM-dd
size
string
Required
B
Patient's height (m)
weight
string
Required
B
Patient's weight (kg in kilograms)
phoneNum
string
Required
B
Phone number
medicalInsuranceNum
string
Required
B
Medical insurance number
idCardNum
string
Required
B
ID No.
hkAndMarcoPermitNum
string
Required
B
Hong Kong and Macao Travel Permit No.
passportNum
string
Required
B
Passport No.
otherInfo
string
Required
B
Other identity information
homeAddress
string
Optional
C
Home address
bodyPart
string
Required
B
Inspection part
studyDesc
string
Required
B
Check description
studyDate
string
Required
B
Check time, yyyy-MM-dd hh:mm:ss
appointDate
string
Optional
C
Scheduled Time
scanMode
string
Required
B
Scan method
studyCategory
string
Required
B
Inspection Category
normal: General Consultation
emergency: Emergency Consultation
applyDept
string
Required
B
Application department
applyDoctor
string
Required
B
Application doctor
applyDeptId
string
Required
B
Application department ID
applyDoctorId
string
Required
B
Application doctor ID
hisNum
string
Required
B
HIS number
clinicNum
string
Optional
C
Outpatient number
inpatientNum
string
Optional
C
Hospitalization number
healthScreenNum
string
Optional
C
Physical examination number
examDept
string
Required
B
Inspection department
examDoctor
string
Required
B
Inspection doctor
examDeptId
string
Required
B
Inspection department ID
examDoctorId
string
Required
B
Inspection doctor ID
examInfo
string
Optional
C
Inspection information (exposure times, inspection cost)
inpatientWard
string
Optional
C
Hospitalization ward
bedNum
string
Optional
C
Hospitalization bed number
diagnosis
string
Optional
C
Clinical diagnosis
symptom
string
Optional
C
Clinical symptoms
allergies
string
Optional
C
Allergic reaction
studyRequirement
string
Optional
C
Check requirements
equipment
string
Optional
C
Inspection equipment
status
string
Required
B
Check status
registered: Registration
partial: Initial Consultation
preliminary: Audit
print: print
final: final status
studyUid
string
Required
B
Check the Uid
imageCnt
int
Required
B
Number of images (Data Reconciliation)
reportCnt
int
Required
B
Number of structured reports (Data Reconciliation)
pdfCnt
int
Required
B
Number of PDF reports (Data Reconciliation)
seriesCnt
int
Required
B
Number of sequences (Data Reconciliation)

Request Return

Field
Type
Remarks
code
int
Error code indicating whether the access was successful. 0: success; other values: failure.
message
string
Error Description
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback