检查上云相关接口

最近更新时间:2023-07-25 09:40:04

我的收藏

概述

数智医疗影像平台提供与第三方系统(例如 PACS、RIS)进行对接,从而实现将院内第三方系统的检查信息、影像信息同步到云平台。文本提供的 API 仅适用于前置服务私有化部署时调用使用。

参数说明

HTTP 接口通用签名,用如下的签名算法:
​ ${signature} = Hmac-Sha256(${token}, ${appId}+${timestamp})
参数说明:
token - 密钥,由腾讯觅影进行分配
appId - 合作方ID,由腾讯觅影进行分配
timestamp - 时间戳,当前生成的时间戳,毫秒数
signature - 生成的密钥签名
所有接口在请求鉴权需要在 http 请求 header 头里面带上相应信息:
signature 对应 http 协议 header 的 signature 字段
appId 对应 http 协议 header 的 appId 字段
timestamp 对应 http 协议 header 的 timestamp 字段
接口参数类型说明:
参数类型
类型说明
A
强制必填,缺失将报错并拒绝接收数据,造成业务无法正常使用
B
存在则必填,缺失仍然可正常接收数据,但会影响业务正常使用
C
非必填,缺失仍然可正常接收数据,但不会影响业务正常使用

检查信息上传API

触发时机:检查完成时,收到图像则上传检查信息
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/study/add (host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
patientId
string
必填
A
患者 ID
patientName
string
必填
A
患者姓名
patientSex
string
必填
A
患者性别 ,
M: 男
F:女
O:其他
studyId
string
必填
A
检查 ID
accessNumber
string
必填
A
AccessNumber
modality
string
必填
A
设备类型
patientAge
string
必填
B
患者年龄
patientAgeUnit
string
必填
B
患者年龄单位,Y(岁),M(月),D(天)
patientBirthday
string
必填
B
患者生日,yyyy-MM-dd
size
string
必填
B
患者身高(m 单位米)
weight
string
必填
B
患者体重(kg 单位公斤)
phoneNum
string
必填
B
电话号码
medicalInsuranceNum
string
必填
B
医保号
idCardNum
string
必填
B
身份证号
hkAndMarcoPermitNum
string
必填
B
港澳通行证号
passportNum
string
必填
B
护照号
otherInfo
string
必填
B
其他身份信息
homeAddress
string
非必填
C
家庭住址
bodyPart
string
必填
B
检查部位
studyDesc
string
必填
B
检查描述
studyDate
string
必填
B
检查时间, yyyy-MM-dd hh:mm:ss
appointDate
string
非必填
C
预约时间
scanMode
string
必填
B
扫描方式
studyCategory
string
必填
B
检查类别, normal:平诊,emergency:急诊
applyDept
string
必填
B
申请科室
applyDoctor
string
必填
B
申请医生
applyDeptId
string
必填
B
申请科室 ID
applyDoctorId
string
必填
B
申请医生 ID
hisNum
string
必填
B
HIS 号
clinicNum
string
非必填
C
门诊号
inpatientNum
string
非必填
C
住院号
healthScreenNum
string
非必填
C
体检号
examDept
string
必填
B
检查科室
examDoctor
string
必填
B
检查医生
examDeptId
string
必填
B
检查科室 ID
examDoctorId
string
必填
B
检查医生 ID
examInfo
string
非必填
C
检查信息(曝光次数、检查费用)
inpatientWard
string
非必填
C
住院病区
bedNum
string
非必填
C
住院床号
diagnosis
string
非必填
C
临床诊断
symptom
string
非必填
C
临床症状
allergies
string
非必填
C
过敏反应
studyRequirement
string
非必填
C
检查需求
equipment
string
非必填
C
检查设备
status
string
必填
B
检查状态,registered:登记,partial:初诊,preliminary:审核,print:打印,final:最终状态
studyUid
string
必填
B
检查 Uid
imageCnt
int
必填
B
(数据对账)图片数
reportCnt
int
必填
B
(数据对账)结构化报告数
pdfCnt
int
必填
B
(数据对账) pdf 格式报告数
seriesCnt
int
必填
B
(数据对账)序列数
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述

检查报告上传API

触发时机:检查完成报告审核后,上传报告信息
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/report/add(host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
reportNumber
string
必填
A
报告号
studyId
string
必填
A
检查 ID
accessNumber
string
必填
A
检查 AccessNumber
imageDescription
string
必填
A
影像描述
conclusion
string
必填
A
诊断结论
reportTime
string
必填
B
初诊时间,yyyy-MM-dd hh:mm:ss
reportDoctor
string
必填
B
初诊医生
auditTime
string
必填
B
审核时间,yyyy-MM-dd hh:mm:ss
auditDoctor
string
必填
B
审核医生
printTime
string
必填
B
打印时间,yyyy-MM-dd hh:mm:ss
printDoctor
string
必填
B
打印医生
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述

云检查二维码返回API

触发时机:获取二维码,并放到患者登记时打印给患者的检查卡
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/getStudyQR(host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
studyId
string
必填
A
检查 ID
accessNumber
string
必填
B
检查 AccessNumber
patientId
string
必填
B
患者 ID
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述
data
struct
数据详情
数据格式:
字段
类型
备注
qrImage
string
二维码图片 Base64 字符串
qrUrl
string
云胶片二维码地址(外网),该字段为预留字段,暂时为空
结果示例:
{
"code":0,
"message":"成功",
"data":{
"qrImage":"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAADZ0lEQVR42uyYPY68OhDECxE47Bvgi4zgWgRIWCLgWozmIuYGDh0g11M387GbveC/rIN1sGK8vwDc7urqxt/6W/96DSQfZJ6LT+Owk8cQ09juJEs1QA+4DeKWDQzwCfM9cuWe7F8XAZ7rBskzY3KHT1wKGIY98agLeOx0yxPI7T1ivDWXA0UY9IFM5D0yoDIAcI8oGT2EW6NR9pjPh6sAu/Z7ylPvZf3y8D0vfhnQ1e7ME2Av71i8rIzfROSHgR6ykmQYopBM7hjIc6evBhiI8QZxoaGobqiIcT28ytpVADzJKG65RwPcQia0pAuoBugh+eZ1XwU2wh09mG+fr7gC8Jgfe2KA6icTYGGNyK8rVwEADwwFXDZgPho66udsTbKda4AmyvqI4oIdaUN3NBbN5A7UAzCNtw6Y4BnaAs1NyUMUzNtVAFTbPTEzMrTRACO/RPPXgYbM+ifokW52kkr55J4idgEAM1rI6q/yDQJ1fbrzimYNQO9FD1BzU9YH6Za7JijEitQ1AJDc0dnPU1HDGU0ht2qAITLoAQJewrDT8X7awle4LwB6b7JpsuBI5qmJadaHt9L+PtBoSpoRpeUFDz1bRvC4DFAPoxWH2+nxnPqH3KqRqAl4alcTzTbbvVsfEdrsXATYbd+pPSBmtS/znadXfgvI7wMD04gOagIloBMuxQu3Dq+SdAUQuVrnfqeEW6c12tsOP8lbA5BVN46Gup80N7lu3bssXgOQRRyLpeTZwushvtS+BqBHwlDErtx43jSf9Js+vvrHAW1tNp/yBJ/0Fybts7ZOXp17DUAPOYugNaq0RkzWR8GXbvGnAZw9slWc+Xhe+zyUj8mpALC2S5WsQLLa5qVAws0T03WAT7P5K73tVEClQSvOa7pYAXAKLDQlZWURTJqtm7f28CKgiZiPTmPn09gWnOMFFfqpIoBJvyS3d2JEQ7cUn0YTkf4qYKDNinO7qevTsBbYBPvtiisAnlM1BrWm1ogNEeYGl8sAmy4WsXm+U7MX4DG2++dOVgDY5L875wzmBsNwusFPzfp54JxXu2Cuj9SG1KaLGX1VwOYTph4Y4ZknDffWmeReCXSiamA1Wl9S+2hBWxFg4Rb1fsxQUrP1wNs2XwCcg30LpE0+rc/Shiu3pRrgb/2t/7/+CwAA//+Q7bUC9L1DBAAAAABJRU5ErkJggg==",
"qrUrl":""
}
}

DICOM 影像上传 API

触发时机:该检查完成,pacs 获得图像后即上传图像
协议:dicom c-store
配置: 在PACS上配置觅影云网关的AEtitle IP Port,在觅影云网关配置 PACS 的 AETitle IP Port

标记删除检查 API

触发时机:当医院想要删除不显示一些错误的检查时,调用该接口传输检查信息,标记删除影像云上该检查记录
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/study/delete(host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
patientId
string
必填
A
待删除 患者 ID
studyId
string
必填
A
待删除 检查 ID
accessNumber
string
必填
A
待删除 检查 AccessNumber
studyUid
string
必填
A
待删除 检查 Uid
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述

检查上传对账API

触发时机:定时上报已传检查维度数据以便核验数据的正确性
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/reconcilelog(host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
studyId
string
必填
A
检查 ID
accessNumber
string
必填
A
检查 AccessNumber
patientName
string
必填
A
患者姓名
studyUid
string
必填
A
检查 Uid
studyDate
string
必填
A
检查时间,yyyy-MM-dd hh:mm:ss
reportCnt
int
必填
A
结构化报告数
pdfCnt
int
必填
A
pdf 格式报告数
seriesCnt
int
必填
A
序列数
imageCnt
int
必填
A
图片数
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述

检查相关ID上报API

触发时机:每天在闲时统一上报一个时间周期内已传检查相关 ID 列表数据
传输协议 :HTTPS POST
数据交互格式 :JSON (Content-Type: application/json)
接口地址:https://${host}/ris/reconcilerangelog(host 为部署前置机 IP)
请求参数:
参数名
类型
是否必填
参数类型
备注
startTime
string
必填
A
对账时间段开始时间,yyyy-MM-dd hh:mm:ss
endTime
string
必填
A
对账时间段结束时间,yyyy-MM-dd hh:mm:ss
studyList
Array(StudyLog)
必填
A
检查相关 ID 的数据组
studyList数组里面StudyLog的结构
参数名
类型
是否必填
参数类型
备注
studyId
string
必填
A
检查 ID
accessNumber
string
必填
A
检查 AccessNumber
studyUid
string
必填
A
检查 Uid
studyDate
string
必填
A
检查时间,yyyy-MM-dd hh:mm:ss
reportCnt
int
必填
A
结构化报告数
pdfCnt
int
必填
A
pdf 格式报告数
seriesCnt
int
必填
A
序列数
imageCnt
int
必填
A
图片数
请求返回:
字段
类型
备注
code
int
标注本次访问是否成功的错误码,0成功,非0失败
message
string
错误描述