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

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

《自助综合服务系统接口方案按需缴费.docx》由会员分享，可在线阅读，更多相关《自助综合服务系统接口方案按需缴费.docx（31页珍藏版）》请在冰豆网上搜索。

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

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

.2012.6

文档名称

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

版本号

V1.0

版本日期

2012年6月3日

创建者

长城医疗

创建日期

2011年9月25日

●版本修订历史

版本号

变更时间

变更容

拟稿人

审批人

1服务测试

接口说明：

服务测试

接口地址

接口方法

NetTest

接口描述

测试Web服务是否连接正常

接口协议

WebService+XML

主要使用者

自动发卡机系统

输入消息说明

示例

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

应答消息：

应答消息说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

名称

说明

数据类型

标签名

长度（字节）

Result

交易结果：

0：

成功

1：

错误

ResultCode

ErrorMsg

错误信息描述

ErrorMsg

2办卡

2.1建卡病人身份校验

接口说明：

对是否存在有效的卡进行校验

接口地址

接口方法

IDCardCheck

接口描述

对是否存在有效卡进行校验

接口协议

WebService+XML

主要使用者

自动发卡机系统

说明

示例

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

号

String

IDCardNo

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result

如返回错误值，需要重新请求，3次为上限

名称

说明

数据类型

标签名

长度（字节）

Result

交易结果：

0:

成功

1:

失败

Int

ResultCode

状态

0：

可以现金办卡

1:

该在银行申请过绑定卡

2：

该已建诊疗卡

Status

2.2建诊疗卡

接口说明：

向HIS发送病人建卡信息

接口定义：

接口地址

接口方法

CreateCardPatInfo

接口描述

将建卡信息插入到HIS数据库

接口协议

WebService+XML

主要使用者

自动发卡机系统

请求消息：

说明

示例

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

名称

说明

数据类型

标签名

长度

卡号

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次为上限

名称

说明

数据类型

标签名

长度（字节）

Result

交易结果：

0：

成功

1：

错误

-341：

卡重复

Int

ResultCode

ErrorMsg

对错误/异常的详细描述信息

a、卡无效

     b、卡已存在

String

ErrorMsg

收据号

String

SerID

注：

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

3卡信息查询

接口说明：

查询病人卡信息

接口地址

接口方法

GetPatInfo

接口描述

病人刷卡的时候返回卡信息

接口协议

WebService+XML

主要使用者

自动发卡机系统

说明

示例

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

卡号

String

CardNo

16

操作员

String

UserId

卡校验码

不能同时为空

String

SecrityNo

卡序列号

String

CardSerNo

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result

如返回错误值，需要重新请求，3次为上限

0

名称

说明

数据类型

标签名

长度（字节）

卡号

String

CardNo

16

卡状态

卡状态为N是正常状态，其他状态都禁止使用

String

CardStatus

账户号/ID号

账户号为空不能充值

String

AccdNo

账户状态

账户状态为N为正常状态，其他状态都禁止充值

String

AccdStatus

账户余额

String

AccBalance

String

PatName

密码状态

0为无密码，1为有密码

String

PwdStatus

4挂号

4.1可挂科室查询

接口说明：

查询能挂的科室

接口地址

接口方法

DOCKSList

接口描述

查询能挂的时段

接口协议

WebService+XML

主要使用者

自助挂号机

说明

示例

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

日期

当天为空

String

Day

操作员

UserId

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

9008

名称

说明

数据类型

标签名

长度（字节）

Result

交易结果：

0：

成功

1：

失败

Int

ResultCode

ErrorMsg

对错误/异常的详细描述信息

a、数据库连接异常

String

ErrorMsg

科室ID

String

DeptId

父科室ＩＤ

String

ParDeptId

科室名称

DepName

4.2医生号查询

接口说明：

查询能挂的医生号别

接口地址

接口方法

DOCHBList

接口描述

查询能挂的医生号别

接口协议

WebService+XML

主要使用者

自助挂号机

说明

示例

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

日期

如果非预约为空

String

Day

科室ID

String

DepId

操作员

String

UserId

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

名称

说明

数据类型

标签名

长度（字节）

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

接口描述

挂号

接口协议

WebService+XML

主要使用者

自助挂号机

说明

示例

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

卡号

String

CardNo

16

医生号RowId

String

RowId

日期

可以为空

String

Day

时段

预约挂号时传空

Time

操作员

String

UserId

卡校验码

不能同时为空

String

SecrityNo

卡序列号

String

CardSerNo

32

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

名称

说明

数据类型

标签名

长度（字节）

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

接口描述

接口协议

WebService+XML

主要使用者

自助挂号机

说明

示例

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

卡号

String

CardNo

操作员

String

Userid

校验码

String

SecrityNo

卡序列号

String

CardSerNo

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

项目编号

项目名称

分类编号

分类名称

金额

数量

执行位置

项目编号

项目名称

分类编号

分类名称

金额

数量

执行位置

名称

说明

数据类型

标签名

长度（字节）

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

接口描述

执行缴费

接口协议

WebService+XML

主要使用者

自助挂号机

说明

示例

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

卡号

String

CardNo

卡校验码

不能同时为空

String

SecrityNo

20

卡序列号

String

CardSerNo

32

金额

String

Amt

10

分组票据号

String

Rcptgroupid

10

操作员

String

UserId

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

名称

说明

数据类型

标签名

长度（字节）

Result

交易结果：

0：

成功

1：

失败

Int

ResultCode

4

ErrorMsg

对错误/异常的详细描述信息

a、数据库连接异常

String

ErrorMsg

256

收据号

String

SerID

6预约挂号

6.1有卡预约病人可取号列表

接口说明：

有卡预约病人可取号列表

接口地址

接口方法

AppNoList

接口描述

有卡预约病人刷诊疗卡以后列出当前可以取的医生号

接口协议

WebService+XML

主要使用者

自助取号机

说明

示例

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

卡号

String

CardNo

12

应答消息：

说明

示例

以Response为根节点的XML串.

子节点:

Result,ErrorMsg

如返回错误值，需要重新请求，3次为上限

号ID

号名称

级别

总金额

科室Id

科室

时段

日期

……