趣医院掌上医院系统医院标准接口说明书精简版.docx
《趣医院掌上医院系统医院标准接口说明书精简版.docx》由会员分享，可在线阅读，更多相关《趣医院掌上医院系统医院标准接口说明书精简版.docx（32页珍藏版）》请在冰豆网上搜索。
趣医院掌上医院系统医院标准接口说明书精简版
合资品牌
“趣医院”掌上医院系统
医院标准接口说明书
上海趣医网络科技有限公司
修订记录：
日期
作者
版本
更改参考/备注
2014.4.3
徐捷及各业务组长
1.0
初稿完成
2014.5.13
王庆涛
1.1
将科室查询·视图、医生查询视图、预约号表视图、挂号号表视图、医生排班视图统一为号表视图；
1`111
王庆涛、贺荣、徐乐
1.2
在查取就诊卡信息视图中增加“手机号”字段；
在号表视图、预约写入、挂号写入中增加“午别”、“支付方式”、“交易流水号”字段；
在缴费写入中增加“支付方式”、“交易流水号”字段；
完善叫号查询视图；
2014.8.12
王庆涛、李坤
1.3
增加视图、存储过程的创建样例语句
2014.10.16
刘健，贺荣
1.4
增加查询以挂号患者就诊状态视图
2014.10.16
王攀科及各业务组长
1.5
评审标准接口
2015.1.6
王攀科
1.6
增加内建排队系统，叫号历史排队队列信息接口；注APP1.1.52之后版本后支持
2015.2.12
王攀科
1.7
检验检查单接口修改，添加PATIENT_NAME,PHONE_NUMBER,ID_NO字段
2015.3.9
王攀科
1.8
2.7和2.8接口添加PHONE_NUMBER和ID_NO字段，添加VISIT_STATUS字段状态值
注：
预约请求、挂号请求、缴费请求写入时，医院HIS等业务系统可以采用存储过程方式或者webservice方式进行对接；
目录
目录2
1.查取就诊卡号4
1.1.查取就诊卡信息视图4
2.预约、挂号、医生排班5
2.1.号表查询视图5
2.2.预约请求写入/撤销处理存储过程7
2.3.挂号请求写入\撤销\预约转挂号处理存储过程9
2.4.查询挂号预约订单状态视图11
3.手机缴费12
3.1.查询待缴费记录视图12
3.2.缴费请求写入处理存储过程13
4.叫号查询14
4.1.当前叫号查询视图14
4.2.查询挂号用户正在排队的信息视图15
4.3.叫号历史排队队列信息视图（医院无叫号系统,内建排队用）16
5.取报告单18
5.1.查阅检验记录概要信息视图18
5.2.查阅检验记录详细信息视图19
5.3.查阅检查记录信息视图20
6.建卡建档21
6.1.建卡建档存储过程21
7.住院费用查询22
7.1.查询在院患者住院费用概要视图22
7.2.询在院患者费用记录详细视图24
1.查取就诊卡号
1.1.查取就诊卡信息视图
接口名称：
queryPatsCardInfo查取就诊者信息接口
视图名称：
VIEW_APP_CARD_INFO
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
身份证号
String
ID_NO
医院系统有ID_NO,返回；没有ID_NO,返回“”
就诊卡号
String
CARD_NO
医院系统有CARD_NO，返回；没有CARD_NO，返回PATIENT_ID
病人ID
String
PATIENT_ID
*非空
病人姓名
String
PATIENT_NAME
*非空
就诊卡类别
String
CARD_TYPE
手机号
String
PHONE_NUMBER
视图查询条件：
名称
说明
数据类型
标签名
备注
身份证号
String
ID_NO
ID_NO和CARD_NO两者选一作为查询条件
就诊卡号
String
CARD_NO
ID_NO和CARD_NO两者选一作为查询条件
病人姓名
String
PATIENT_NAME
*非空
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
2.预约、挂号、医生排班
2.1.号表查询视图
视图名称：
VIEW_APP_REGIST_MARK
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
号源ID
String
HID
科室代码
String
DEPT_CODE
*非空
科室名称
String
DEPT_NAME
*非空
医生编号
String
DOCTOR_CODE
*非空
医生姓名
String
DOCTOR_NAME
*非空
号类
例如：
主任、副主任、普通等
String
MARK_TYPE
*非空
医生号别
例如：
刘林霞副主任号
String
CLINIC_LABEL
*非空
号源日期
例如：
2014/5/12
String
HB_DATE
*非空
号源时段
例如：
14:
45:
00
String
HB_TIME
号源午别
上午、下午、晚间
String
AM_PM
*非空
号源分配
号源分配（标识哪些号源是分配给掌上医院的），例如：
0:
窗口挂号
1:
网站预约
2:
健康小屋
3:
电话预约
4:
手机APP
String
REGISTER_WAY
*非空（默认”4”）
是否已被预约
1-已预约0-未预约
String
FLAG_USED
*非空（默认“0”）
是否可挂号
1-可挂号
String
FLAG_AVAILABLE
*非空（默认“1”）
挂号费
String
SUM_FEE
*非空
就诊位置
可为空
String
CLINIC_POSITION
号别名称
如：
张三副主任
String
MARK_DESC
*非空
诊疗费
String
CLINIC_FEE
*非空（默认“0”）
可预约数
String
APPOINT_COUNT
*非空（默认“1000000”）
可挂号数
String
REG_COUNT
*非空（默认“1000000”）
视图查询科室数据条件：
接口名：
queryDeptDict查取科室信息接口
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
视图查询医生数据条件：
接口名：
queryDoctorDict查取医生信息接口
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
科室代码
String
DEPT_CODE
*非空
视图查询医生排班数据/取预约医生排班数据/取挂号医生排班数据条件：
接口名：
queryScheduleInfo查取医院排班信息接口
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
科室代码
String
DEPT_CODE
*非空
医生编号
String
DOCTOR_CODE
*非空
视图查询预约号源/挂号号源数据条件：
接口名：
queryHidInfo查取医院号源信息接口
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
科室代码
String
DEPT_CODE
*非空
医生编号
String
DOCTOR_CODE
*非空
2.2.预约请求写入/撤销处理存储过程
接口名称：
opAppoint预约写入医院系统接口
名称：
PROC_APP_APPOINT
写入参数（）
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
APP_HOSPITAL_MARK
*非空
号源ID
String
APP_HID
非空
身份证号
String
APP_ID_NO
非空
就诊人姓名
String
APP_PATIENT_NAME
非空
病人ID
String
APP_PATIENT_ID
非空
科室代码
String
APP_DEPT_CODE
非空
科室名称
String
APP_DEPT_NAME
非空
医生编号
String
APP_DOCTOR_CODE
非空
医生姓名
String
APP_DOCTOR_NAME
非空
号源日期
例如：
2014/5/12
String
APP_HB_DATE
非空
号源时段
例如：
14:
45:
00
String
APP_HB_TIME
非空
号源午别
上午、下午、晚间
String
APP_AM_PM
非空
操作类型
0-写入；1-撤销
String
APP_OPERATE_TYPE
0表示提交预约请求，1表示撤销预约
交易流水号
String
APP_FLOW_NO
非空
返回参数（）
名称
说明
数据类型
标签名
备注
Result
交易结果：
0000：
成功
0001：
已停诊
0002：
号源已满
0003：
重复预约
0004：
其它原因
String
RESULT_CODE
0000是操作成功
其它是失败
错误信息
操作的提示信息
String
ERROR_MSG
无论成功与失败都返回
预约时间
例如：
“2014/5/1610:
45:
00”
String
APP_TIME
预约流水号
String
APPOINT_NO
2.3.挂号请求写入\撤销\预约转挂号处理存储过程
接口名称：
opRegist挂号写入医院系统接口
名称：
PROC_APP_REGIST
说明：
挂号处理、撤销处理、预约转挂号处理，需要HIS明确接口文档的入参意义。
写入参数（）
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
APP_HOSPITAL_MARK
*非空
病人ID
String
APP_PATIENT_ID
非空
号源ID
String
APP_HID
非空
科室代码
String
APP_DEPT_CODE
非空
科室名称
String
APP_DEPT_NAME
非空
医生编号
String
APP_DOCTOR_CODE
非空
医生姓名
String
APP_DOCTOR_NAME
非空
号源日期
例如：
2014/5/12
String
APP_HB_DATE
非空
号源时段
例如：
14:
45:
00
String
APP_HB_TIME
非空
号源午别
上午、下午、晚间
String
APP_AM_PM
非空
操作类型
0-写入；1-撤销；2-预约转挂号
String
APP_OPERATE_TYPE
非空
挂号费
String
APP_SUM_FEE
非空
支付方式
0-支付宝
1-银联
2-微信支付
3-预交金
4-全民支付
5-交行支付
6-免挂号费
String
APP_PAY_WAY
非空
交易流水号
String
APP_FLOW_NO
非空
返回参数（）
名称
说明
数据类型
标签名
备注
Result
交易结果：
0000：
成功
0001：
已停诊
0002：
号源已满
0003：
重复挂号
0004：
其它
String
RESULT_CODE
0000是操作成功
其它是失败
错误信息
操作的提示信息
String
ERROR_MSG
无论成功与失败都返回
挂号收据号
收据号或发票号
String
RECEIPT_NO
预交金余额
对于预交金模式，可以给患者返回预交金余额
String
REMAIN_MONEY
门诊号
当日门诊号
String
VISIT_NO
排队号
本诊室患者排队就诊序号
String
CALL_NUMBER
2.4.查询挂号预约订单状态视图
接口名称：
queryPatsRegistStatus查询已挂号患者就诊状接口
视图名称：
VIEW_APP_VISIT_STATUS
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
就诊日期
例如：
2014/5/12
String
VISIT_DATE
*非空
门诊号
例如：
72323
String
VISIT_NO
*非空
病人ID
String
PATIENT_ID
*非空
号别
如：
左娟主任号
String
CLINIC_LABEL
*非空
病人姓名
String
PATIENT_NAME
*非空
号类
如：
副主任号
String
CLINIC_TYPE
*非空
金额
String
SUM_FEE
*非空
收据号
（医院HIS提供的流水号）
String
RECEIPT_NO
就诊状态
反映从预约到就诊的状态变化。
0-未取号1-已取号2-已就诊3-已退号4-爽约5-作废订单
String
VISIT_STATUS
*非空
手机号码
订单人手机号码
String
PHONE_NUMBER
身份证号
身份证号
String
ID_NO
视图查询条件：
名称
说明
数据类型
标签名
备注
病人ID
String
PATIENT_ID
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
门诊号
String
VISIT_NO
病人姓名
String
PATIENT_NAME
收据号
（医院HIS提供的流水号）
String
RECEIPT_NO
手机号码
订单人手机号码
String
PHONE_NUMBER
身份证号
身份证号
String
ID_NO
3.手机缴费
3.1.查询待缴费记录视图
接口名称：
queryAppPayInfo查询待缴费记录接口
视图名称：
VIEW_APP_PAY
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
项目编号
String
ITEM_NO
*非空
病人ID
String
PATIENT_ID
*非空
门诊号
String
VISIT_NO
*非空
项目名称
String
ITEM_NAME
*非空
项目类别
如：
西药，检查，检验
String
ITEM_CLASS
*非空
费用金额
String
PAY_COSTS
*非空
就诊日期
String
VISIT_DATE
*非空
处方号
String
PRESC_NO
*非空
流水号
String
SERIAL_NO
*非空（如果没有填处方号PRESC_NO）
单位
String
UNITS
*非空（“默认/”）
单价
String
PRICE
*非空（“默认/”）
数量
String
AMOUNT
*非空（“默认/”）
规格
如：
“30mg青海制药厂”
String
ITEM_SPEC
*非空（“默认/”）
执行科室
String
PERFORMED_BY
*非空（“默认/”）
开单科室
String
ORDERED_BY
*非空（“默认/”）
3.2.缴费请求写入处理存储过程
接口名称：
opPay缴费写入医院系统接口
名称：
PROC_APP_PAY
写入参数（）
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
APP_HOSPITAL_MARK
*非空
流水号
非空
String
APP_SERIAL_NO
非空
病人ID
非空
String
APP_PATIENT_ID
非空
支付方式
0-支付宝
1-银联
2-微信支付
3-预交金
4-全民支付
5-交行支付
String
APP_PAY_MODE
非空
支付金额
String
APP_AMT
非空
交易流水号
String
APP_FLOW_NO
非空
处方号
String
APP_PRESC_NO
非空
返回参数（）
名称
说明
数据类型
标签名
备注
Result
交易结果：
0000：
成功
0001：
失败
String
RESULT_CODE
*非空
错误信息
发生错误时的提示内容
String
ERROR_MSG
*非空
发票号、收据号
缴费的发票号或收据号
String
RECEIPT_NO
*非空
取药、检查窗口号
缴费成功后，可以给患者提示取药，或做检查的楼层位置
String
DRUG_WINDOWS
*非空
预交（缴）金余额
对于预交金模式，可以给患者返回预交金余额
String
REMAIN_MONEY
*非空（默认空）
4.叫号查询
4.1.当前叫号查询视图
接口名称：
queryCurrentNumber当前叫号查询接口
视图名称：
VIEW_APP_QUEUE_INFO
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
科室代码
String
DEPT_CODE
*非空，如果没有，DEPT_CODE和DEPT_NAME可相同
科室名称
String
DEPT_NAME
*非空
医生编号
String
DOCTOR_CODE
*非空，如果没有，DOCTOR_CODE和DOCTOR_NAME可相同
医生姓名
若是普通号，则填写“普通号”
String
DOCTOR_NAME
*非空
号别名称
如果为空，则由“科室＋医生姓名”生成；
例如：
产科张三
String
MARK_DESC
*非空
当前叫号号码
String
CURRENT_CALL_NUMBER
*非空
当前叫号时间
YYYY/MM/DDhh:
mm如:
2014/10/2911:
42
Date
CURRENT_CALL_TIME
*非空
当前排队尾号
String
QUEUE_LAST_NUMBER
*非空
4.2.查询挂号用户正在排队的信息视图
接口名称：
queryPatsQueue查询挂号用户正在排队信息接口
视图名称：
VIEW_APP_QUEUE_USER_INFO
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
病人ID
String
PATIENT_ID
*非空
病人排队号
病人的就诊序号
String
PATIENT_NUMBER
*非空
病人姓名
String
PATIENT_NAME
*非空
科室代码
String
DEPT_CODE
*非空
科室名称
String
DEPT_NAME
*非空
医生编号
String
DOCTOR_CODE
*非空
医生姓名
若是普通号，则填写“普通号”
String
DOCTOR_NAME
*非空
号别名称
如果为空，则由“科室＋医生姓名”生成；
例如：
产科张三
String
MARK_DESC
*非空
视图查询条件：
名称
说明
数据类型
标签名
备注
病人ID
String
PATIENT_ID
医院标示
医院的唯一标示，多端情况下区分医院
String
HOSPITAL_MARK
*非空
4.3.叫号历史排队队列信息视图（医院无叫号系统,内建排队用）
接口名称：
queryPatsCalledQueue查询历史排队队列信息信息接口
视图名称：
VIEW_APP_CALLED_QUEUE_INFO
视图参数：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
Hospital_Mark
*非空
科室编号
String
Dept_Code
*非空
科室名称
String
Dept_Name
*非空
医生编号
String
Doctor_Code
*非空
医生名称
String
Doctor_Name
*非空
号别名称
String
Mark_Desc
*非空
病人ID
String
Patient_Id
*非空
叫号号码
String
Call_Number
*非空
病人名称
String
Patient_Name
*非空
就诊序号
String
Visit_No
*非空
挂号状态
根据医院提供
String
Registration_Status
*非空
挂号日期
YYYY/MM/DDhh:
mm如:
2014/10/2910:
42
String
Registration_Date
*非空
叫号时间
YYYY/MM/DDhh:
mm如:
2014/10/2911:
42
String
Called_Time
*非空
视图查询条件：
名称
说明
数据类型
标签名
备注
医院标示
医院的唯一标示，多端情况下区分医院
String
Hospital_Mark
*非空
注：
查出的是当天数据
5.取报告单
5.1.查阅检验记录概要信息视图
接口名称：
queryCheckListMast
升级会员 