医院接入文档 - Powered by MinDoc

1、体检报告同步

请求URL
https://api.mytijian.com/open-api/V2/ws/examreport/syncExamReport?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "examReportParams":[
        {
            "departmentList":[
                {
                    "agentDepartmentId":"000118",
                    "examTime":1526872187000,
                    "name":"耳鼻喉科检查",
                    "orderBy":"000118",
                    "reportNo":"201806040088"
                }
            ],
            "detailList":[
                {
                    "classId":"耳鼻喉科",
                    "className":"耳鼻喉科",
                    "classResult":"",
                    "department":"耳鼻喉科检查",
                    "departmentId":"000118",
                    "docName":"",
                    "examTime":1526872186000,
                    "itemId":"000128",
                    "itemName":"本科既往史和现患疾病（耳鼻喉）",
                    "itemResult":"拒检",
                    "itemTip":"",
                    "orderByClass":"A00005A000118",
                    "orderByDept":"A00005",
                    "orderByItem":"A00128",
                    "picUrl":"",
                    "reference":"",
                    "reportNo":"201806040088",
                    "unit":"",
                    "examBarCode":"ddd"
                },
                {
                    "classId":"耳鼻喉科",
                    "className":"耳鼻喉科",
                    "classResult":"",
                    "department":"耳鼻喉科检查",
                    "departmentId":"000118",
                    "docName":"",
                    "examTime":1526872186000,
                    "itemId":"000129",
                    "itemName":"鼻腔",
                    "itemResult":"拒检",
                    "itemTip":"",
                    "orderByClass":"A00005A000118",
                    "orderByDept":"A00005",
                    "orderByItem":"A00129",
                    "picUrl":"",
                    "reference":"",
                    "reportNo":"201806040088",
                    "unit":"",
                    "examBarCode":"ddd"
                }
            ],
            "examReportInfoParam":{
                "adviceType":0,
                "age":"28",
                "attention":"",
                "auditTime":1526832000000,
                "birthday":660844800000,
                "department":"",
                "detail":"",
                "detailType":0,
                "docName":"管理员",
                "examCompany":"网上预约(个人)",
                "examDate":1526832000000,
                "gender":"0",
                "hospitalId":197,
                "idCard":"360681199012115715",
                "mobile":"12345678901",
                "name":"黄伟",
                "reportNo":"201806040088",
                "reportTime":1526832000000,
                "examineTypeOriginalValue":"入职体检",
                "examineResult":0,
                "pdfUrl":"",
                "workNo":"",
                "storageType":0
            }
        }
    ]
}

请求参数说明：

参数名	是否必须	类型	说明
examReportParams	是	List（ExamReportParam）	体检报告集合

ExamReportParam对象说明：

参数名	是否必须	类型	说明
examReportInfoParam	是	ExamReportInfoParam	体检人信息
detailList	是	List（ExamReportDetailParam）	项目指标集合
departmentList	是	List（ExamReportDepartmentParam）	体检科室集合
resultList	否	List（ExamReportResultParam）	格式化的总检报告集合（除定制医院基本不用）
adviceList	否	List（ExamExceptionalParam）	格式化的异常建议集合（除定制医院基本不用）

examReportInfoParam对象说明：

参数名	是否必须	类型	说明
id	否	Integer	主键
hospitalId	是	Integer	体检中心ID
reportNo	是	String	体检报告编号
orderNum	否	String	体检订单号
name	是	String	姓名
idCard	是	String	身份证
gender	是	String	性别：0-男，1-女
age	否	String	年龄
marriageStatus	否	String	婚姻状况
examCompany	是	String	所属单位
department	否	String	部门
workNo	否	String	工号
mobile	否	String	手机号码
docName	是	String	总检报告医生名字
auditDoc	否	String	总检报告核对医生
detail	是	String	总检结果
advice	否	String	总检建议
attention	否	String	注意事项
examDate	是	Date	体检日期
reportTime	是	Date	生成总检报告时间
auditTime	否	Date	总检报告核对时间
state	否	Integer	体检报告同步状态
detailType	否	Integer	总检内容类型
adviceType	否	Integer	异常建议类型
birthday	否	Date	体检人出生日期
examineTypeOriginalValue	否	String	体检类型原始值
examineResult	否	Integer	体检结果:0.体检不合格 1.体检合格 2.未检出异常
pdfUrl	否	String	外网可访问的pdf链接
storageType	否	Integer	报告存储类型:1 平台存储pdf，2 平台存储结构化 ,3 平台存储pdf+结构化, 4 内网存储报告
examReportTypeId	否	int	报告类型

ExamReportDetailParam对象说明：

参数名	是否必须	类型	说明
reportNo	是	String	体检报告编号
departmentId	是	String	医院体检科室id
department	是	String	医院体检科室名称
classId	是	String	类别
className	是	String	类别名
examBarCode	是	String	大项条形编码号
classResult	是	String	组合项目结论
itemId	是	String	项目编号
itemName	是	String	项目名称
itemResult	是	String	小项结果
reference	是	String	参考值
itemTip	否	String	提示
unit	是	String	单位
picUrl	否	String	附件图片文件名，地址为{reportNo}/pic_name
docName	是	String	组合项检查医生
examTime	是	Date	体检时间
explain	否	String	说明
orderByDept	否	String	排序
orderByClass	否	String	排序
orderByItem	否	String	排序

ExamReportDepartmentParam对象说明：

参数名	是否必须	类型	说明
reportNo	是	String	体检报告编号
reportItemId	否	String	单项id
agentDepartmentId	是	String	agent端医院体检科室id
name	是	String	医院体检科室名称
result	是	String	医院检查科室结论
docName	否	String	检查医生
examTime	是	Date	体检时间
orderBy	否	Date	排序

ExamReportResultParam对象说明：

参数名	是否必须	类型	说明
id	否	Integer	主键
reportId	是	Integer	报告Id
title	是	String	格式化总检标题
content	是	String	格式化总检结论

ExamExceptionalParam对象说明：

参数名	是否必须	类型	说明
id	否	Integer	主键
reportId	是	Integer	报告Id
title	是	String	格式化总检标题
advice	是	String	异常建议
attention	是	String	注意事项
doctor	是	String	医生

正确返回示例:

{
    "success":"T",
    "msg":"success"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

2、同步体检报告图片

请求URL
https://api.mytijian.com/open-api/V2/ws/examreport/syncExamReportImage?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

POST参数示例

{
    "basicUrl":"report_id/文件名",
    "imageData":""
}

参数名	是否必须	类型	说明
basicUrl	是	String	图片路径
imageData	是	String	图片Base64字符串对象

正确返回示例:

{
    "success":"T",
    "msg":"success"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

3、体检报告同步全量解析队列

请求URL
https://api.mytijian.com/open-api/V2/ws/examreport/syncExamReportFullService?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN

请求格式以及数据结构跟体检报告同步一样

4. 同步大项报告

https://api.mytijian.com/open-api/V2/ws/examreport/syncItemReport?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

{"itemReportParams":[
{
"reportNo":"123",
"idCard":"122334",
"name":"的",
"mobile":"18702621932",
"gender":1,
"age":12,
"orderNum":"122222",
"url":"www.baidu.com",
"urlType":0,
"itemReportType";1,
"examBarCode":"232232323",
"title":"大项名称",
"doctor":"报告医生",
"auditDoc":"审核医生",
"examDate":1526832000000,
"agentDepartmentId":"内网科室id",
"agentDepartmentName":"内网科室名称",
"reportDate":1526832000000,
"summary":"小结"
}]}

参数名	是否必须	类型	说明
reportNo	是	String	体检报告编号
idCard	是	String	体检人身份证
name	是	String	体检人姓名
mobile	否	String	体检人手机号
gender	是	int	性别：0-男，1-女
age	是	int	年龄
orderNum	否	String	订单号
url	否	String	链接地址
urlType	否	String	地址类型：0 三方链接页面。
itemReportType	是	String	报告类型 0. 普通，1. 影像
examBarCode	是	String	条形编码号
title	是	String	大项名称
doctor	是	String	报告医生
auditDoc	否	String	审核医生
agentDepartmentId	是	String	内网科室id
agentDepartmentName	是	Date	医院体检科室名称
reportDate	否	Date	报告时间
examDate	否	Date	体检时间
summary	否	String	小结

正确返回示例:

{
    "success":"T",
    "msg":"success"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

同步报告基本信息

请求URL
https://api.mytijian.com/open-api/V2/ws/examreport/syncBaseExamreport?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken
nonce	是	string	当前有效的nonce
sign	是	string	数据sign值

    {"examReportBases":[{
                "adviceType":0,
                "age":"28",
                "attention":"",
                "checkDate":1526832000000,
                "birthday":660844800000,
                "department":"",
                "detail":"",
                "detailType":0,
                "doctor":"管理员",
                "checkDoctor":"张三",
                "reportDate":1526832000000,
                "companyName":"网上预约(个人)",
                "examineDate":1526832000000,
                "gender":"0",
                "idCard":"360681199012115715",
                "mobile":"12345678901",
                "userName":"黄伟",
                "reportNo":"201806040088",
                "reportTime":1526832000000,
                "examineTypeOriginalValue":"入职体检",
                "storageType":4
    }]
    }

一次最大传输20个报告

参数名	是否必传	类型	说明
reportNo	是	String	体检报告编号
orderNum	否	String	体检订单号
userName	是	String	姓名
idCard	是	String	身份证
gender	是	String	性别：0-男，1-女
age	否	String	年龄
marriageStatus	否	String	婚姻状况
companyName	是	String	所属单位
department	否	String	部门
employeeNo	否	String	工号
mobile	否	String	手机号码
doctor	是	String	总检报告医生名字
checkDoctor	否	String	总检报告核对医生
detail	是	String	总检结果
advice	否	String	总检建议
attention	否	String	注意事项
examineDate	是	Date	体检日期
reportDate	是	Date	生成总检报告时间
checkDate	否	Date	总检报告核对时间
state	否	Integer	体检报告同步状态. 0 未读同步后可发短信，1 已读同步后不发短信，2 c端不可见
detailType	否	Integer	“总检内容类型: 0 未格式化1 格式内容”
adviceType	否	Integer	异常建议类型：0 未格式，1 格式化
birthday	否	Date	体检人出生日期
examineTypeOriginalValue	否	String	体检类型原始值：eg：健康体检
storageType	是	integer	报告存储类型	1 平台存储pdf，2 平台存储结构化 ,3 平台存储pdf+结构化, 4 内网存储报告

正确返回示例:

{
    "success":"T",
    "data":{
        "syncExamResults":[{"reportNo":"201806040088","reportId":122233}]
    },
    "msg":"success"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息
data	object	返回的数据

参数名	类型	说明
reportNo	String	内网上传的报告号
reportId	String	每天的报告id

6. 修改报告状态

https://api.mytijian.com/open-api/V2/ws/examreport/syncExamReportState?accessToken=ACCESS_TOKEN
请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:

参数名	是否必须	类型	说明
accessToken	是	string	当前有效的accessToken

{"reportNo":"xxxxxx","state":2}

参数名	是否必须	类型	说明
reportNo	true	string	报告号
state	true	int	状态: 1 已读 2 异常体检报告（前端无法看到）

正确返回示例:

{
    "success":"T",
    "msg":"success"
}

返回参数说明:

参数名	类型	说明
success	String	T成功，F失败
errCode	String	错误码，只有失败的时候才有
msg	String	描述消息

文档更新时间: 2024-08-27 14:41

体检报告服务

1、体检报告同步

POST参数示例

请求参数说明：

ExamReportParam对象说明：

examReportInfoParam对象说明：

ExamReportDetailParam对象说明：

ExamReportDepartmentParam对象说明：

ExamReportResultParam对象说明：

ExamExceptionalParam对象说明：

返回参数说明:

2、同步体检报告图片

POST参数示例

返回参数说明:

3、体检报告同步全量解析队列

4. 同步大项报告

返回参数说明:

同步报告基本信息

返回参数说明:

6. 修改报告状态

返回参数说明: