自助综合服务系统接口方案按需缴费.doc

自助综合服务系统接口方案按需缴费

25
2020年4月19日
文档仅供参考，不当之处，请联系改正。

自助综合服务系统接口方案

长沙. .6

文档名称
自助综合服务系统接口方案
版 本 号
V1.0
版本日期
6月3日
创 建 者
长城医疗
创立日期
9月25日
l 版本修订历史
版本号
变更时间
变更内容
拟稿人
审批人

目 录
1 服务测试 4
2 办卡 5
2.1 建卡病人身份校验 5
2.2建诊疗卡 6
3卡信息查询 8
4卡预交金充值 9
5 挂号 11
5.1可挂科室查询 11
5.2医生号查询 12
5.3挂号 14
6 缴费 17
6.1查询缴费项 17
6.2缴费 19
7 预约挂号 20
7.1 有卡预约病人可取号列表 20
7.2有卡预约病人取号 22
8 打印门诊费用清单 24
9 预交金对账 27
10 验证密码 28
11 预交金账户变更明细查询 29

1 服务测试
接口说明：服务测试
接口地址

接口方法
NetTest
接口描述
测试Web服务是否连接正常
接口协议
Web Service+XML
主要使用者
自动发卡机系统

输入消息说明
示例
以Request为根节点的XML串.子节点定义详见下方的说明.

<Request>
< UserId></ UserId>
</Request>
应答消息：
应答消息说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
< ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
</Response>
名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：错误

ResultCode

ErrorMsg
错误信息描述

ErrorMsg

2 办卡
2.1 建卡病人身份校验
接口说明：对身份证是否存在有效的卡进行校验
接口地址

接口方法
IDCardCheck
接口描述
对身份证是否存在有效卡进行校验
接口协议
Web Service+XML
主要使用者
自动发卡机系统

说明
示例
以Request为根节点的XML串.子节点定义详见下方的说明.

<Request>
<IDCardNo></IDCardNo>
</Request>

身份证号

String
IDCardNo

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result
如返回错误值，需要重新请求，3次为上限
<Response>
< ResultCode ></ ResultCode >
<Status></Status>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0:成功
1:失败

Int
ResultCode

状态
0：能够现金办卡
1:该身份证在银行申请过绑定卡
2：该身份证已建诊疗卡

Status

2.2建诊疗卡
接口说明：向HIS发送病人建卡信息
接口定义：
接口地址

接口方法
CreateCardPatInfo
接口描述
将建卡信息插入到HIS数据库
接口协议
Web Service+XML
主要使用者
自动发卡机系统

请求消息：

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<PatientName></PatientName>
<Sex></Sex>
<Birthday></Birthday>
<Age></Age>
<IDCardNo></IDCardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<Amt></Amt>
<Address></Address>
<Tel></Tel>
<UserId></UserId>
<ActDate></ActDate>
<ActTime></ActTime>
<PassWord></ PassWord>
</Request>
名称
说明
数据类型
标签名
长度
卡号

String
CardNo
16
病人姓名

String
PatientName

性别

String
Sex

出生日期
YYYY-MM-DD
Date
Birthday

年龄

String
Age

身份证号

String
IDCardNo

卡校验码

String
SecrityNo
10
卡序列号

String
CardSerNo
32
联系地址

String
Address

联系电话

String
Tel

预交金

Number
Amt

操作员

String
UserId

操作日期
YYYY-MM-DD
Date
ActDate

操作时间
HH:mm:ss
time
ActTime

缴费密码
不设置密码则为空
String
PassWord

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
<SerID><SerID>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：错误
-341：卡重复
Int
ResultCode

ErrorMsg
对错误/异常的详细描述信息
a、卡无效
      b、卡已存在
String
ErrorMsg

收据号

String
SerID

注：卡校验码和卡序列号不能同时为空

3卡信息查询
接口说明：查询病人卡信息
接口地址

接口方法
GetPatInfo
接口描述
病人刷卡的时候返回卡信息
接口协议
Web Service+XML
主要使用者
自动发卡机系统

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<UserId></UserId>
</Request>

卡号

String
CardNo
16
操作员

String
UserId

卡校验码
不能同时为空
String
SecrityNo

卡序列号
String
CardSerNo

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result
如返回错误值，需要重新请求，3次为上限
<Response>
<CardNo></CardNo>
<CardStatus></CardStatus>
<AccdNo></AccdNo>
<AccdStatus></AccdStatus>
<AccBalance></AccBalance>
<PatName></PatName>
<PwdStatus>0</PwdStatus>
</Response>

名称
说明
数据类型
标签名
长度（字节）
卡号

String
CardNo
16
卡状态
卡状态为N是正常状态，其它状态都禁止使用
String
CardStatus

账户号/ID号
账户号为空不能充值
String
AccdNo

账户状态
账户状态为N为正常状态，其它状态都禁止充值
String
AccdStatus

账户余额

String
AccBalance

姓名

String
PatName

密码状态
0为无密码，1为有密码
String
PwdStatus

4 挂号
4.1可挂科室查询
接口说明：查询能挂的科室
接口地址

接口方法
DOCKSList
接口描述
查询能挂的时段
接口协议
Web Service+XML
主要使用者
自助挂号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<DOCKSList>
<Day></Day>
<UserId></UserId>
</DOCKSList>
</Request>

日期
当天为空
String
Day

操作员

UserId

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<DOCKSList>
<Item>
<DeptId>9008<DeptId>
<ParDeptId><ParDeptId>
<DeptName></DeptName>
</Item>
<Item>
<DeptId><DepId>
<ParDeptId><ParDepId>
<DeptName></DepName>
</Item>
</DOCKSList>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode

ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg

科室ID

String
DeptId

父科室ＩＤ

String
ParDeptId

科室名称

DepName

4.2医生号查询
接口说明：查询能挂的医生号别
接口地址

接口方法
DOCHBList
接口描述
查询能挂的医生号别
接口协议
Web Service+XML
主要使用者
自助挂号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<DOCHBList>
<Day></Day>
<DeptId></DepId>
<UserId></UserId>
</ DOCHBList >
</Request>

日期
如果非预约为空
String
Day

科室ID

String
DepId

操作员

String
UserId

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
<DOCHBList>
<Item>
<RowId ></RowId>
<MarkDesc><MarkDesc>
<SessionType></SessionType>
<SumFee></SumFee>
<DepId></DepId>
<DepDesc></DepDesc>
<HBTime></HBTime>
</Item>
<Item>
<RowId ></RowId>
<MarkDesc><MarkDesc>
<SessionType></SessionType>
<SumFee></SumFee>
<DepId></DepId>
<DepDesc></DepDesc>
<HBTime></HBTime>
</Item >
</DOCHBList>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode

ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
号ID

String
RowId

科室ID

DeptId

科室名称

String
DeptDesc

号别名称
（医生姓名）
String
MarkDesc

出诊级别
（普通，专家、、、、）
String
SessionType

挂号费合计

String
SumFee

挂号时段

String
HBTime

4.3挂号
接口说明：挂号
接口地址

接口方法
OPRegist
接口描述
挂号
接口协议
Web Service+XML
主要使用者
自助挂号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<OPRegist>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<RowId></ RowId>
<Day></Day>
<Time></Time>
<UserId></UserId>
</OPRegist>
</Request>
卡号

String
CardNo
16
医生号RowId

String
RowId

日期
能够为空
String
Day

时段
预约挂号时传空

Time

操作员

String
UserId

卡校验码
不能同时为空
String
SecrityNo

卡序列号
String
CardSerNo
32
应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
<SerID><SerID>
<PrintData>
<RegYear></ RegYear>
<RegMonth></RegMonth>
<RegDay></RegDay>
<RegSerNo></RegSerNo>
<CardNo></CardNo>
<PatName></PatName>
<QueueNo></QueueNo>
<DepDesc></DepDesc>
<SessionType></SessionType>
<LocInfo></LocInfo>
< SumFee ></ SumFee >
<SerNo></SerNo>
<UserId></UserId>
<DocDesc></DocDesc >
<Doctor></Doctor>
</PrintData>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
收据号

SerID

年

String
RegYear
4
月

String
RegMonth
2
日

String
RegDay
2
卡号

String
CardNo
12
病人姓名

String
PatName
20
号别序号

String
QueueNo
4
就诊科室

String
DepDesc
20
职称
（普通，专家、、、、）
String
SessionType
20
就诊位置

String
LocInfo
40
操作员

String
UserId
20
医生号别
（医生姓名）
String
DocDesc
20
挂号费

String
SumFee
20

5 缴费
5.1查询缴费项
接口说明：查询缴费项目
接口地址

接口方法
GetBillInfo
接口描述

接口协议
Web Service+XML
主要使用者
自助挂号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo ></CardNo>
<UserId></UserId>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
</Request>
卡号

String
CardNo

操作员

String
Userid

校验码

String
SecrityNo

卡序列号

String
CardSerNo

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode></ResultCode >
<ErrorMsg></ErrorMsg>
<Items>
<Item>
<ItemId>项目编号</ItemId>
<ItemName>项目名称</ItemName>
<CateId>分类编号</CateId>
<CateName>分类名称</CateName>
<Price>金额</Price>
<Num>数量</Num>
<CtLoc>执行位置</CtLoc>
<Item>
<Item>
<ItemId>项目编号</ItemId>
<ItemName>项目名称</ItemName>
<CateId>分类编号</CateId>
<CateName>分类名称</CateName>
<Price>金额</Price>
<Num>数量</Num>
<CtLoc>执行位置</CtLoc>
<Item>
</ Items >
</ Response >

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
项目编号

String
ItemId
20
项目名称

String
ItemName
20
分类编号

String
CateId
20
分类名称

String
CateName
20
金额

String
Price
20
数量

String
Num
20
执行位置

String
CtLoc
20

5.2缴费
接口地址

接口方法
AutoOPBillCharge
接口描述
执行缴费
接口协议
Web Service+XML
主要使用者
自助挂号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<Amt></Amt>
<Rcptgroupid></Rcptgroupid>
<UserId></UserId>
</Request>
卡号

String
CardNo

卡校验码
不能同时为空
String
SecrityNo
20
卡序列号
String
CardSerNo
32
金额

String
Amt
10
分组票据号

String
Rcptgroupid
10
操作员

String
UserId

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
< Response>
<ResultCode></ResultCode >
<ErrorMsg></ErrorMsg>
<SerID></SerID>
</ Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
收据号

String
SerID

6 预约挂号
6.1有卡预约病人可取号列表
接口说明：有卡预约病人可取号列表
接口地址

接口方法
AppNoList
接口描述
有卡预约病人刷诊疗卡以后列出当前能够取的医生号
接口协议
Web Service+XML
主要使用者
自助取号机

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<AppNoList>
<CardNo></CardNo>
</AppNoList>
</Request>

卡号

String
CardNo
12
应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<AppNoList>
<AppNoInfo>
<RowId>号ID</RowId>
<MarkDesc>号名称</MarkDesc>
<SessionType>级别</SessionType>
<SumFee>总金额</SumFee>
<DepId>科室Id</DepId>
<DepDesc>科室</DepDesc>
<HBTime>时段</HBTime>
<Day>日期</Day>
</AppNoInfo>
<AppNoInfo>
……
</ AppNoInfo>
</AppNoList>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
</Response>

名称
说明
数据类型
标签名
长度（字节）
号别名称描述

String
RESDesc
100
价格

String
Price
5
Result
交易结果：
0：成功
1：错误
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256

6.2有卡预约病人取号
接口说明：有卡预约病人取号
接口地址

接口方法
GetAppNo
接口描述
有卡病人做网上预约以后在医院取号
接口协议
Web Service+XML
主要使用者
自动发卡机系统

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<UserId></UserId>
<Day></Day>
<Time></Time>
<RowId></RowId>
</Request>

卡号

String
CardNo

卡校验码
不能同时为空
String
SecrityNo

卡序列号
String
CardSerNo

取号日期

Date
Day

时段

string
Time

号ID

RowId

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode></ ResultCode>
<ErrorMsg></ErrorMsg>
<SerID><SerID>
<PrintData>
<RegYear></ RegYear>
<RegMonth></RegMonth>
<RegDay></RegDay>
<CardNo></CardNo>
<PatName></PatName>
<QueueNo></QueueNo>
<DepDesc></DepDesc>
<SessionType></SessionType>
<LocInfo></LocInfo>
<RMB></RMB>
<SerNo></SerNo>
<UserId></UserId>
<DocDesc></DocDesc >
<Doctor></Doctor>
<RegFee></RegFee>
</PrintData>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
对账号

SerID

年

String
RegYear
4
月

String
RegMonth
2
日

String
RegDay
2
卡号

String
CardNo
12
病人姓名

String
PatName
20
当前号别队列号

String
QueueNo
4
就诊科室

String
DepDesc
20
职称

String
SessionType
20
就诊位置

String
LocInfo
40
收据号

String
SerNo
14
操作员

String
UserId
20
号别

String
DocDesc
20
接诊医生

String
Doctor
20
挂号金额

String
RegFee
20

7 打印门诊费用清单
接口说明：查询病人门诊费用明细
接口地址

接口方法
GetBillDetailByAdm
接口描述
查询病人门诊费用明细
接口协议
Web Service+XML
主要使用者
自动发卡机系统

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<UserId></UserId>
<StartDay>开始日期</StartDay>
<EndDay>结束日期<EndDay>
</Request>

卡号

String
CardNo

卡校验码
不能同时为空
String
SecrityNo

卡序列号
String
CardSerNo

开始时间
YYYY-MM-DD
String
StartDay

结束时间
YYYY-MM-DD
String
EndDay

操作员

String
UserId

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<PatName>桂磊</PatName>
<Sex>男</Sex>
<Age>60</Age>
<ID>0000001</ID>
<ChargeType>自费</ChargeType>
<List>
<Item>
<CateName>检查</CateName>
<ItemName>肝功能检验</ItemName>
<Num>1</Num>
<Price>200</Price>
<Sum>200</Sum>
<Unit>次</Unit>
<Date> -09-26 13:25</Date>
</Item>
<Item>
<CateName>检查</CateName>
<ItemName>验血</ItemName>
<Num>1</Num>
<Price>6</Price>
<Sum>6</Sum>
<Unit>次</Unit>
<Date> -09-26 13:25</Date>
</Item>
</List>
<ResultCode>0</ResultCode>
<ErrorMsg></ErrorMsg>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256
姓名

String
PatName

性别

String
Sex
4
年龄

String
Age
2
个人ID

String
ID
2
费别

String
ChargeType
13
费用类型

String
CateName
12
项目名称

String
ItemName
20
数量

String
Num
4
单价

String
Price
20
单位
次、盒，支…..

Unit
20
金额

String
Sum
40
执行时间

String
Date
20

8 验证密码
接口说明：缴费密码验证
接口地址

接口方法
GetPassWord
接口描述
缴费密码验证
接口协议
Web Service+XML
主要使用者
自动发卡机系统

说明
示例
以Response为根节点的XML串.子节点定义详见下方的说明.

<Request>
<CardNo></CardNo>
<SecrityNo></SecrityNo>
<CardSerNo></CardSerNo>
<UserId></UserId>
<PassWord></PassWord>
</Request>

卡号

String
CardNo

操作员

String
UserId

校验码
不能同时为空
String
SecrityNo

卡序列号
String
CardSerNo

密码
采用加密方式加密
String
PassWord

应答消息：
说明
示例
以Response 为根节点的XML串.
子节点: Result, ErrorMsg
如返回错误值，需要重新请求，3次为上限
<Response>
<ResultCode>0</ResultCode>
<ErrorMsg></ErrorMsg>
</Response>

名称
说明
数据类型
标签名
长度（字节）
Result
交易结果：
0：成功
1：失败
Int
ResultCode
4
ErrorMsg
对错误/异常的详细描述信息
a、数据库连接异常

String
ErrorMsg
256