1、自助综合服务系统接口方案按需缴费252020年4月19日文档仅供参考,不当之处,请联系改正。自助综合服务系统接口方案长沙. .6文档名称自助综合服务系统接口方案版 本 号V1.0版本日期 6月3日创 建 者长城医疗创立日期 9月25日l 版本修订历史版本号变更时间变更内容拟稿人审批人目 录1 服务测试42 办卡52.1 建卡病人身份校验52.2建诊疗卡63卡信息查询84卡预交金充值95 挂号115.1可挂科室查询115.2医生号查询125.3挂号146 缴费176.1查询缴费项176.2缴费197 预约挂号207.1 有卡预约病人可取号列表207.2有卡预约病人取号228 打印门诊费用清单24
2、9 预交金对账2710 验证密码2811 预交金账户变更明细查询291 服务测试接口说明:服务测试接口地址接口方法NetTest接口描述测试Web服务是否连接正常接口协议Web Service+XML主要使用者自动发卡机系统输入消息说明示例以Request为根节点的XML串.子节点定义详见下方的说明.应答消息:应答消息说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:错误ResultCodeErrorMsg错误信息描述ErrorMsg2 办卡2.1
3、 建卡病人身份校验接口说明:对身份证是否存在有效的卡进行校验接口地址接口方法IDCardCheck接口描述对身份证是否存在有效卡进行校验接口协议Web Service+XML主要使用者自动发卡机系统说明示例以Request为根节点的XML串.子节点定义详见下方的说明. 身份证号StringIDCardNo应答消息:说明示例以Response 为根节点的XML串.子节点: Result如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode状态0:能够现金办卡1:该身份证在银行申请过绑定卡2:该身份证已建诊疗卡St
4、atus2.2建诊疗卡接口说明:向HIS发送病人建卡信息接口定义:接口地址接口方法CreateCardPatInfo接口描述将建卡信息插入到HIS数据库接口协议Web Service+XML主要使用者自动发卡机系统请求消息:说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 名称说明数据类型标签名长度卡号StringCardNo16病人姓名StringPatientName性别StringSex出生日期YYYY-MM-DDDateBirthday年龄StringAge身份证号StringIDCardNo卡校验码StringSecrityNo10卡序列号StringCard
5、SerNo32联系地址StringAddress联系电话StringTel预交金NumberAmt操作员StringUserId操作日期YYYY-MM-DDDateActDate操作时间HH:mm:sstimeActTime缴费密码不设置密码则为空StringPassWord应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:错误-341:卡重复IntResultCodeErrorMsg对错误/异常的详细描述信息a、卡无效 b、卡已存在St
6、ringErrorMsg收据号StringSerID注:卡校验码和卡序列号不能同时为空3卡信息查询接口说明:查询病人卡信息接口地址接口方法GetPatInfo接口描述病人刷卡的时候返回卡信息接口协议Web Service+XML主要使用者自动发卡机系统说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 卡号StringCardNo16操作员StringUserId卡校验码不能同时为空StringSecrityNo卡序列号StringCardSerNo应答消息:说明示例以Response 为根节点的XML串.子节点: Result如返回错误值,需要重新请求,3次为上限 0名
7、称说明数据类型标签名长度(字节)卡号StringCardNo16卡状态卡状态为N是正常状态,其它状态都禁止使用StringCardStatus账户号/ID号账户号为空不能充值StringAccdNo账户状态账户状态为N为正常状态,其它状态都禁止充值StringAccdStatus账户余额StringAccBalance姓名String PatName密码状态0为无密码,1为有密码StringPwdStatus4 挂号4.1可挂科室查询接口说明:查询能挂的科室接口地址接口方法DOCKSList接口描述查询能挂的时段接口协议Web Service+XML主要使用者自助挂号机说明示例以Respons
8、e为根节点的XML串.子节点定义详见下方的说明. 日期当天为空StringDay操作员UserId应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 9008 名称说明数据类型标签名长度(字节)Result交易结果:0:成功 1:失败IntResultCodeErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg科室IDStringDeptId父科室StringParDeptId科室名称DepName4.2医生号查询接口说明:查询能挂的医生号别接口地址接口方法DOCHBLi
9、st接口描述查询能挂的医生号别接口协议Web Service+XML主要使用者自助挂号机说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 日期如果非预约为空StringDay科室IDStringDepId操作员StringUserId应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCodeErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256号IDSt
10、ringRowId科室IDDeptId科室名称StringDeptDesc号别名称(医生姓名)StringMarkDesc出诊级别(普通,专家、)StringSessionType挂号费合计StringSumFee挂号时段StringHBTime4.3挂号接口说明:挂号接口地址接口方法OPRegist接口描述挂号接口协议Web Service+XML主要使用者自助挂号机说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 卡号StringCardNo16医生号RowIdStringRowId日期能够为空StringDay时段预约挂号时传空Time操作员StringUserI
11、d卡校验码不能同时为空StringSecrityNo卡序列号StringCardSerNo32应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256收据号SerID年StringRegYear4月StringRegMonth2日StringRegDay2卡号StringCardNo12病人姓名StringPatName
12、20号别序号StringQueueNo4就诊科室StringDepDesc20职称(普通,专家、)StringSessionType20就诊位置StringLocInfo40操作员StringUserId20医生号别(医生姓名)StringDocDesc20挂号费StringSumFee205 缴费5.1查询缴费项接口说明:查询缴费项目接口地址接口方法GetBillInfo接口描述接口协议Web Service+XML主要使用者自助挂号机说明示例以Response为根节点的XML串.子节点定义详见下方的说明.卡号StringCardNo操作员StringUserid校验码StringSecri
13、tyNo卡序列号StringCardSerNo应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 项目编号项目名称 分类编号分类名称金额数量执行位置 项目编号项目名称 分类编号分类名称金额数量执行位置名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256项目编号StringItemId20项目名称StringItemName20分类编号StringCateId20分类名
14、称StringCateName20金额StringPrice20数量StringNum20执行位置StringCtLoc205.2缴费接口地址接口方法AutoOPBillCharge接口描述执行缴费接口协议Web Service+XML主要使用者自助挂号机说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 卡号StringCardNo卡校验码不能同时为空StringSecrityNo20卡序列号StringCardSerNo32金额StringAmt10分组票据号StringRcptgroupid10操作员StringUserId应答消息:说明示例以Response 为根
15、节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256收据号StringSerID6 预约挂号6.1有卡预约病人可取号列表接口说明:有卡预约病人可取号列表接口地址接口方法AppNoList接口描述有卡预约病人刷诊疗卡以后列出当前能够取的医生号接口协议Web Service+XML主要使用者自助取号机说明示例以Response为根节点的XML串.子节点定义详见下
16、方的说明. 卡号StringCardNo12应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 号ID号名称级别总金额科室Id科室 时段日期 名称说明数据类型标签名长度(字节)号别名称描述StringRESDesc100价格StringPrice5Result交易结果:0:成功1:错误IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg2566.2有卡预约病人取号接口说明:有卡预约病人取号接口地址接口方法GetAppNo接口描述有卡病人做网上预
17、约以后在医院取号接口协议Web Service+XML主要使用者自动发卡机系统说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 卡号StringCardNo卡校验码不能同时为空StringSecrityNo卡序列号StringCardSerNo取号日期DateDay时段stringTime号IDRowId应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限 名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的
18、详细描述信息a、数据库连接异常StringErrorMsg256对账号SerID年StringRegYear4月StringRegMonth2日StringRegDay2卡号StringCardNo12病人姓名StringPatName20当前号别队列号StringQueueNo4就诊科室StringDepDesc20职称StringSessionType20就诊位置StringLocInfo40收据号StringSerNo14操作员StringUserId20号别StringDocDesc20接诊医生StringDoctor20挂号金额StringRegFee207 打印门诊费用清单接口说明
19、:查询病人门诊费用明细接口地址接口方法GetBillDetailByAdm接口描述查询病人门诊费用明细接口协议Web Service+XML主要使用者自动发卡机系统说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 开始日期结束日期 卡号StringCardNo卡校验码不能同时为空StringSecrityNo卡序列号StringCardSerNo开始时间YYYY-MM-DDStringStartDay结束时间YYYY-MM-DDStringEndDay操作员StringUserId应答消息:说明示例以Response 为根节点的XML串.子节点: Result, Err
20、orMsg如返回错误值,需要重新请求,3次为上限桂磊男600000001自费检查肝功能检验1200200 次 -09-26 13:25检查验血166次 -09-26 13:250名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256姓名String PatName性别StringSex4年龄StringAge2个人IDStringID2费别StringChargeType13费用类型StringCateName12项目名称StringItemName20数
21、量StringNum4单价StringPrice20单位次、盒,支.Unit20金额StringSum40执行时间StringDate208 验证密码接口说明:缴费密码验证接口地址接口方法GetPassWord接口描述缴费密码验证接口协议Web Service+XML主要使用者自动发卡机系统说明示例以Response为根节点的XML串.子节点定义详见下方的说明. 卡号StringCardNo操作员StringUserId校验码不能同时为空StringSecrityNo卡序列号StringCardSerNo密码采用加密方式加密StringPassWord应答消息:说明示例以Response 为根节点的XML串.子节点: Result, ErrorMsg如返回错误值,需要重新请求,3次为上限0名称说明数据类型标签名长度(字节)Result交易结果:0:成功1:失败IntResultCode4ErrorMsg对错误/异常的详细描述信息a、数据库连接异常StringErrorMsg256