微信支付全流程对接文档
-
- 第一部分:诊中支付
1.1.1患者信息查询
请求地址 |
|
|||
注意 |
|
|||
接口名称 |
getMZPatient |
|||
示例代码 |
请求报文: <request> <params> <patName></patName> … </params> </request>
响应报文: <response> … <result> <patType></patType> … </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则返回空字符串; 医院存在分院时不允许为空 |
患者姓名 |
patName |
Y |
|
|
诊疗卡号码 |
patCardNo |
Y |
没有诊疗卡的,就是门诊号 |
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
患者类型 |
patType |
Y |
1:成人 2:儿童 |
|
姓名 |
patName |
Y |
|
|
性别 |
patSex |
Y |
M:男,F:女 |
|
出生日期 |
patBirth |
Y |
|
|
地址 |
patAddress |
Y |
|
|
电话 |
patMobile |
y |
|
|
证件类型 |
patIdType |
Y |
||
证件号码 |
patIdNo |
Y |
|
|
诊疗卡类型 |
patCardType |
Y |
||
诊疗卡号码 |
patCardNo |
Y |
|
|
是否绑定医保 |
hasMedicare |
Y |
true:绑定;false:不绑定 |
1.1.2首诊患者建档
请求地址 |
|
|||
接口名称 |
createACard |
|||
示例代码 |
请求报文: <request> <params> <patType></patType> … </params> </request>
响应报文: <response> … <result> <patCardType></patCardType> … </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传入空字符串; 医院不存在分院时不允许为空; |
患者类型 |
patType |
Y |
1:成人 2:儿童 |
|
姓名 |
patName |
Y |
|
|
性别 |
patSex |
Y |
M:男,F:女 |
|
年龄 |
patAge |
Y |
|
|
出生日期 |
patBirth |
Y |
|
|
地址 |
patAddress |
Y |
|
|
电话 |
patMobile |
Y |
|
|
证件类型 |
patIdType |
Y |
患者类型为“2”儿童时,该项允许为空 |
|
证件号码 |
patIdNo |
Y |
患者类型为“2”儿童时,该项允许为空 |
|
监护人姓名 |
guardName |
Y |
患者类型为“2”儿童时,该项必输 |
|
监护人证件类型 |
guardIdType |
Y |
||
监护人证件号码 |
guardIdNo |
Y |
||
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:已建档(输出按建档成功的返回值返回) |
错误消息 |
resultMessage |
y |
当交易结果代码成功时,该字段返回空字符串 |
|
诊疗卡号码 |
patCardNo |
Y |
门诊号 |
1.1.3门诊待缴费记录查询
请求地址 |
|
|||
接口名称 |
getMZFeeList |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
诊疗卡类型 |
patCardType |
N |
||
诊疗卡号(门诊号) |
patCardNo |
Y |
|
|
输出 输出参数中去除了分院代码及分院名称 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
缴费项集合 |
集合内容包括以下item |
|||
缴费项唯一标识 |
mzFeeId |
Y |
用来唯一标识一笔缴费 (包含1..n个处方或1..n个检查单,n个处方是一笔缴费,n个检查单是另一笔缴费) |
|
生成时间 |
time |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
医生代码 |
doctorCode |
Y |
|
|
医生姓名 |
doctorName |
Y |
|
|
缴费科室 |
deptName |
Y |
|
|
应付金额 |
payAmout |
Y |
应付金额 = 总金额 - 医保金额 若不支持医保结算,则返回总金额 |
|
医保金额 |
MedicareAmout |
Y |
医保金额 = 总金额 - 应付金额 |
|
总金额 |
totalAmout |
Y |
总金额 = 应付金额 + 医保金额 |
1.1.4门诊待缴费记录明细查询
请求地址 |
|
|||
接口名称 |
getMZFeeDetail |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
缴费项唯一标识 |
mzFeeId |
Y |
用来唯一标识一笔缴费 |
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
缴费项明细集合 |
集合内容包括以下item |
|||
项目日期 |
itemTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
项目名称 |
itemName |
Y |
|
|
项目类别/费别 |
itemType |
Y |
如:药费、检查费、材料费 |
|
单位 |
itemUnit |
Y |
|
|
项目编号 |
itemId |
Y |
项目的标识符,没有则空 |
|
单价 |
itemPrice |
Y |
单位:分 |
|
规格 |
itemSpec |
Y |
|
|
数量 |
itemNumber |
Y |
|
|
项目价格合计 |
itemTotalFee |
Y |
单位:分,等于:单价*数量 |
|
开出科室 |
deptName |
Y |
|
|
开药医生代码 |
doctorCode |
Y |
|
|
开药医生姓名 |
doctorName |
Y |
|
1.1.5门诊缴费订单支付
请求地址 |
|
|||
注意 |
在网络延时情况下,接口处理失败或接口处理成功,调用方可能接收不到结果,需要支持重复提交
|
|||
接口名称 |
ackPayOrder |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result > … </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
缴费项列表 |
mzFeeIdList |
Y |
可以是1..n个缴费项,中间用逗号隔开 |
|
付款金额 |
payAmout |
Y |
|
|
总金额 |
totalAmout |
Y |
|
|
公众服务平台订单号 |
psOrdNum |
Y |
公众服务平台(微信公众号、支付宝服务窗)用于唯一标识一笔交易的流水号 |
|
收单机构流水号 |
agtOrdNum |
Y |
对应收单机构(如财付通、支付宝、银联等机构)用于标识一笔支付交易的流水号 |
|
收单机构代码 |
agtCode |
Y |
财付通账号、银行卡账号等 |
|
付款方式 |
payMode |
Y |
1:微信 2:支付宝 |
|
付款时间 |
payTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:已支付(输出按支付成功的返回值返回) 2:不符合医院限定,无法支付(超过支付截止时间等) |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
医院交易流水号 |
hisOrdNum |
Y |
用来唯一标识一笔门诊缴费交易 |
|
收据号 |
receiptNum |
N |
|
|
条形码 |
barCode |
N |
|
|
医院返回的信息 |
hisMessage |
Y |
|
1.1.6查询支付状态
请求地址 |
|
|||
注意 |
|
|||
接口名称 |
getPayStatus |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result > … </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
TransactionID |
微信支付订单号 |
Y |
|
|
PayTime |
支付时间 |
N |
|
|
ChargeTotal |
支付金额 |
N |
|
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功
|
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
ReceiptSn |
发票流水号 |
Y |
|
|
Guid |
指引信息 |
Y |
|
1.1.7支付单据提醒(HIS调用宁远接口)
当医生开出新的处方单,检查单,检验单等时,通知患者有新的支付单据。
入参名称 |
示例 |
data |
<request> <head> <key>hisRemind_common_payOrder</key> <hospcode>组织机构编码</hospcode> <token>权限验证</token> <time>时间如20130901150401</time> </head> <body> <cardNo>诊疗卡号</cardNo> <hisPayNo>支付单据号</hisPayNo> <phone>手机号码</phone> <patientName>患者姓名</patientName> <payAmt>支付金额</payAmt> <payType>检验费/</payType> <docName>医生姓名</docName> <depName>科室姓名</depName> </body> </request> |
|
|
-
-
-
- 入参data节点说明
-
-
入参 |
入参说明 |
类型 |
可空 |
patientName |
患者姓名 |
Varchar(20) |
N |
hisPayNo |
支付单据号 |
VARCHAR2(40) |
N |
phone |
电话号码 |
VARCHAR2(40) |
Y |
cardNo |
健康卡号/诊疗卡号 |
VARCHAR2(40) |
Y |
payAmt |
支付金额 |
Varchar(10,2) |
N |
payType |
费用类型说明,检验费,检查费,药费 |
Varchar(20) |
N |
docName |
开单医生 |
Varchar(20) |
N |
depName |
开单科室 |
Varchar(100) |
Y |
入参名称 |
示例 |
data |
<response> <head> <result>1</result> <desc>推送成功</desc> </head> </response> |
|
|
入参 |
入参说明 |
类型 |
可空 |
result |
返回值标志 1-成功 0-失败 |
Varchar(1) |
N |
desc |
返回值说明 |
Varchar(100) |
Y |
1.1.8诊间退费(his调用宁远接口)
-
-
-
-
- 服务说明(pay_refundFromOffline)
-
-
-
HIS在收费窗口直接调用退费接口,退费接口调用线上服务器实行退费申请.
注: 退费接口只是退费申请,费用的到帐并非实时到帐.如果是到钱包则在10分钟以内,如果原路返还到银行则需要2-5个工作日.不排除退费申请之后失败的情况发生(如卡已被锁或注销等情况).
-
-
-
-
- 输入
-
-
-
入参名称 |
示例 |
data |
<request> <head> <key>pay_Comm_RefundFee(住院退费用 pay_Comm_inHospitalRefundFromOffline)</key> <hospcode>组织机构编码</hospcode> <token>权限验证</token> <time>时间如20130901150401</time> </head> <body> <refundType>退费类型(1-诊中退费,2-挂号费退费)</refundType> <invoiceNo>发票号</invoiceNo> <payTradeNo>支付流水号</payTradeNo> <payMethod>weixin</payMethod> <refundAmt>退费金额</refundAmt> <refundTime>退费时间</refundTime> <refundMan>退费人</refundMan> </body> </request> |
JSON |
参照示例 |
-
-
-
-
- 入参data节点说明
-
-
-
入参 |
入参说明 |
类型 |
可空 |
invoiceNo |
发票号 |
VARCHAR2(40) |
NO |
payTradeNo |
支付流水号 |
VARCHAR2(40) |
NO |
payMethod |
支付方式 |
NUMBER(16,2) |
NO |
refundAmt |
支付金额 |
VARCHAR2(4) |
NO |
refundTime |
退费时间 |
VARCHAR2(64) |
NO |
refundMan |
退费人 |
VARCHAR2(20) |
NO |
-
-
-
-
- 返回
-
-
-
入参名称 |
示例 |
data |
成功: <response> <head> <result>1</result> <desc>退费申请成功</desc> </head> <body> <invoiceNo>发票号</<invoiceNo> <refundState>退费状态</<refundState> <refundTradeNo>退费流水号</refundTradeNo> <refundTime>退费成功时间</refundTime> </body> </response>
失败: <response> <head> <result>0</result> <desc>调用退费接口出错,请重试</desc> </head> </response>
|
|
|
-
-
-
-
- 返回节点说明
-
-
-
入参 |
入参说明 |
类型 |
可空 |
invoiceNo |
发票号 |
VARCHAR2(40) |
NO
|
refundState |
退费状态 |
VARCHAR2(1) |
NO |
refundTradeNo |
支付交易流水号 |
VARCHAR2(64) |
NO |
refundTime |
退费成功时间 |
VARCHAR2(20) |
NO |
1.1.9门诊缴费对账接口
1.数据交互流程
2.参数说明:
【函数定义】getMzPayList
【服务说明】门诊缴费对账接口
【参数示例】传入参数的具体的格式参照WeChat_GetOrganization
【参数说明】XmlParams:字符串XML参数。
【参数列表】
公用参数:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
AccessKey |
访问授权码 |
varchar(255) |
TRUE |
请咨询平台供应商 |
MethodName |
方法名 |
|
TRUE |
参考接口文档 |
参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
Organization |
机构编码 |
varchar(50) |
TRUE |
|
BeginDate |
开始时间 |
datetime |
TRUE |
必填 |
EndDate |
结束时间 |
datetime |
TRUE |
必填 |
patCardNo |
门诊号(就诊卡号) |
varchar(12) |
FALSE |
|
注:时间为空则返回该患者本年所有的缴费记录
3.、返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PatientName |
姓名 |
varchar(50) |
|
PatientID |
病人ID |
varchar(12) |
|
VisitTime |
住院时间 |
datetime |
|
HisPayNo |
单据号 |
varchar(20) |
病人ID^门诊流水号 |
ReceiptSn |
发票流水号 |
varchar(20) |
|
PayStatus |
支付状态 |
varchar(2) |
1已支付;-1已退费 |
PayType |
支付方式 |
varchar(10) |
w微信支付 |
ChargeDate |
支付时间 |
datetime |
|
ChargeTotal |
支付金额 |
Decimal(18,0) |
单位:分 |
TransactionID |
支付订单号 |
varchar(50) |
|
BusinessType |
类别 |
varchar(1) |
1:门诊 2:住院 |
RefundMan |
退费人 |
varchar(50) |
|
RefundTime |
退费时间 |
datetime |
|
RefundAmt |
退费金额 |
Decimal(18,0) |
|
RefundNo |
退费流水号 |
varchar(50) |
|
1.1.10 候诊查询(就诊队列)
1.数据交互流程
2.参数说明:
【函数定义】getDistInfo
【服务说明】候诊查询
【参数示例】
【参数说明】XmlParams:字符串XML参数。
【参数列表】:
参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
patCardNo |
门诊号,或就诊卡号 |
varchar(12) |
TRUE |
|
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
VisitDate |
就诊时间 |
datetime |
|
VisitDeptName |
就诊科室名称 |
varchar(50) |
|
VisitDoctName |
就诊医生姓名 |
varchar(50) |
|
Shift |
班次 |
Int |
|
PatWaitCount |
等待就诊人数 |
Int |
|
QueueSN |
就诊序号 |
Int |
|
PatientName |
姓名 |
varchar(50) |
|
BookTime |
预约时间 |
Datetime |
|
Status |
队列状态 |
varchar(2) |
1 已预约 3 已分诊 5 已就诊 7 取消就诊 8 取消预约 9 取消分诊 10 已通知 11 正在就诊 |
BookType |
预约类型 |
|
|
1.1.11检查结果列表查询
请求地址 |
|
|||
接口名称 |
getExamineList |
|||
|
|
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
N |
医院没有分院则传入空字符串; 医院不存在分院时不允许为空 |
诊疗卡类型 |
patCardType |
N |
||
诊疗卡号 |
patCardNo |
N |
|
|
开始日期 |
beginDate |
Y |
格式:YYYY-MM-DD |
|
结束日期 |
endDate |
Y |
格式:YYYY-MM-DD |
|
输出
|
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
检查结果集合 |
以下是集合的内容item |
|||
患者姓名 |
patName |
Y |
|
|
检查ID |
checkId |
Y |
唯一标识某次检查 |
|
检查名称 |
checkName |
Y |
|
|
报告类型 |
checkType |
Y |
|
|
报告类型名称 |
checkTypeName |
Y |
|
|
检查科室 |
deptName |
Y |
|
|
检查医生 |
doctorName |
Y |
|
|
检查时间 |
checkTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
开单医生姓名 |
orderDoctor |
Y |
|
|
开单医生编码 |
orderDoctorCode |
Y |
|
|
开单医生工号 |
orderDoctorNo |
N |
|
|
开单科室 |
orderDept |
Y |
|
|
报告时间 |
ReportTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
文件地址 |
fileAddress |
N |
报告图片url地址 |
1.1.12检查结果详情查询
请求地址 |
|
|||
接口名称 |
getExamineDetail |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> … </reault> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
检查ID |
checkId |
Y |
唯一标识某次检查 |
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
患者姓名 |
patName |
Y |
|
|
患者性别 |
patSex |
Y |
M:男,F:女 |
|
患者年龄 |
patAge |
Y |
|
|
申请科室名称 |
deptName |
Y |
|
|
报告医生姓名 |
reportDocName |
Y |
|
|
临床诊断 |
diagnosis |
N |
|
|
检查医生(技师)姓名 |
checkDocName |
Y |
|
|
检查日期 |
checkTime |
Y |
格式:YYYY-MM-DD HH:MM:SS |
|
检查部位 |
checkPart |
Y |
|
|
检查方法 |
checkMethod |
Y |
|
|
检查所见 |
checkSituation |
Y |
|
|
诊断意见 |
checkOption |
Y |
|
|
医嘱项 |
advice |
Y |
|
1.1.13检验报告列表查询
请求地址 |
|
|||
接口名称 |
getInspectList |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院代码 |
branchCode |
N |
医院没有分院则传入空字符串; 医院不存在分院时不允许为空 |
诊疗卡类型 |
patCardType |
N |
||
诊疗卡号 |
patCardNo |
N |
|
|
开始日期 |
beginDate |
Y |
格式:YYYY-MM-DD |
|
结束日期 |
endDate |
Y |
格式:YYYY-MM-DD |
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
Y |
当交易结果代码成功时,该字段返回空字符串 |
|
检验报告集合 |
以下是集合的内容item |
|||
患者姓名 |
patName |
Y |
|
|
患者性别 |
patSex |
Y |
M:男,F:女 |
|
患者年龄 |
patAge |
Y |
|
|
临床诊断 |
diagnosis |
N |
|
|
检验ID |
inspectId |
Y |
|
|
检验名称 |
inspectName |
Y |
|
|
送检科室 |
deptName |
Y |
|
|
送检医生 |
doctorName |
Y |
|
|
送检医生编码 |
doctorCode |
Y |
|
|
送检医生工号 |
doctorNo |
Y |
|
|
送检时间 |
inspectTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
审核医生 |
verifyDoctor |
Y |
|
|
审核时间 |
verifyTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
检验医生 |
inspectDoctor |
Y |
|
|
检验时间 |
provingTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
报告时间 |
reportTime |
Y |
格式:YYYY-MM-DD 24HH:MI:SS |
|
文件地址 |
fileAddress |
N |
图片或文件url地址 |
1.1.14检验报告详情查询
请求地址 |
|
|||
接口名称 |
getInspectDetail |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </ressult> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入
|
医院代码 |
branchCode |
y |
医院没有分院则传空; 医院存在分院则不能为空 |
检验ID |
inspectId |
Y |
|
|
输出 |
交易结果代码 |
resultCode |
Y |
-1:失败 0:成功 1:成功但没有查询到数据 |
错误消息 |
resultMessage |
y |
当交易结果代码成功时,该字段返回空字符串 |
|
报告详情集合 |
以下是集合的内容item |
|||
项目名称 |
itemName |
Y |
|
|
结果 |
result |
Y |
|
|
单位 |
unit |
Y |
|
|
参考范围 |
refRange |
Y |
|
|
结果异常提示 |
abnormal |
Y |
0:正常 1:偏高 2:偏低 |
1.1.15扫码支付
本文档是宁远前置机扫码支付接口文档,his方调用该接口,获得对应的url地址,生成二维码打印到处方单上供患者扫码进行支付
双方通过WebService(Soap Web Service,TCP 通讯)进行调用。
双方在协调测试和部署时,告知对方的接口调用地址,地址采用同一个URL。业务在POST的XML字符串中进行封装
调用方法:requestWS
1,请求消息结构:
<request>
<head>
<key>业务唯一标识</key>
<hospcode>组织机构编码</hospcode>
<token>权限验证</token>
<time>时间如20130901150401</time>
</head>
<body>业务参数</body>
</request>
应答消息结构:
<response>
<head>
<result>请求状态,0-失败 1-成功</result>
<desc>成功或失败原因</desc>
</head>
<body><表名>业务数据</表名></body>
</response>
-
-
-
-
- 宁远提供接口
- 服务说明
-
-
-
HIS调用此接口,传入金额,单据号,卡号等信息,宁远返回支付的url,his根据此url生成二维码,打印到处方单上。
-
-
-
-
- 输入
-
-
-
入参名称 |
示例 |
data |
<request> <head> <key>scanpay_comm_qrCode</key> <hospcode>138</hospcode> <token></token> <time></time> </head> <body> <card_no>8888888</card_no> <health_no>patientId^就诊次数</health_no> <unit_branch_id>分院id</unit_branch_id> <name>姓名</name> </body> </request> |
|
|
-
-
-
-
- 入参data节点说明
-
-
-
入参 |
入参说明 |
类型长度 |
可空 |
hospcode |
医院ID |
varchar(32) |
N |
card_no |
患者卡号或登记号或病人id,跟诊中绑卡一致 |
varchar(64) |
N |
Health_no |
就诊记录号或门诊流水号 |
Varchar(64) |
Y |
unit_branch_id |
分院id |
varchar(32) |
n |
name |
患者姓名 |
varchar(32) |
Y |
-
-
-
-
- 返回
-
-
-
入参名称 |
示例 |
data |
成功: <response> <head> <result>1</result> <desc>SUCCESS</desc> </head> <body> <url> https://wxistest.91160.com/wxis/anaCode.do?data={"c":"456","d":"","h":"000425885300^13","n":"%25E7%258E%258B%25E8%258F%25B2","s":"e9f66f8f3c","u":"262"} </url> </body> </response> 失败: <response> <head> <result>0</result> <desc>接口异常</desc> </head> </response>
|
|
|
1.1.16在线取号
请求地址 |
|
|||
接口名称 |
getOrderReg |
|||
示例代码 |
请求报文: <request> <params> … </params> </request>
响应报文: <response> … <result> <item> … </item> <item> … </item> </result> </response> |
|||
参数类型 |
参数名称 |
参数代码 |
必输 |
说明 |
输入 |
医院编码 |
hospitalcode |
Y |
医院没有分院则传空; 医院存在分院则不能为空 |
身份证号 |
SFZH |
Y |
无时传0 |
|
预约订单号 |
ORDERNO |
Y |
|
|
输出
|
病人门诊号码 |
bah |
Y |
|
门诊流水号 |
Mzlsh |
N |
|
|
社保流水号 |
Sblsh |
Y |
|
|
订单号 |
ORDERNO |
Y |
|
|
身份证号 |
Sfzh |
Y |
|
|
科室名称 |
DepartmentName |
Y |
|
|
科室地址 |
DepartmentPlace |
Y |
|
|
科室代码 |
DepartmentCode |
Y |
|
|
级别名称 |
DoctorType |
Y |
|
|
医生姓名 |
DoctorName |
Y |
|
|
医生工号 |
DoctorCode |
Y |
|
|
|
预约日期 |
RegistDate |
Y |
|
|
预约开始时间 |
BeginTime |
Y |
时间段格式:小时:分钟 |
|
预约结束时间 |
EndTime |
Y |
时间段格式:小时:分钟 |
|
支付标志 |
PayState |
Y |
-1未支付,0已支付 |
|
自费金额 |
Zfje |
Y |
|
|
社保金额 |
Sbje |
Y |
|
|
挂号费 |
Ghf |
Y |
|
1.1.17 体检报告清单查询
1.数据交互流程
2.参数说明:
【函数定义】getExaminationList
【服务说明】体检报告清单查询
【参数示例】
【参数说明】XmlParams:字符串XML参数。
【参数列表】
参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
patCardNo |
就诊卡号 |
varchar(12) |
FALSE |
|
empCheckNo |
体检号 |
varchar(20) |
FALSE |
|
beginDate |
开始时间 |
datetime |
TRUE |
|
endDate |
结束时间 |
datetime |
TRUE |
|
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PHY_ID |
体检单ID |
varchar(32) |
|
PatientId |
病人ID |
varchar(12) |
|
MOBILE |
手机号码 |
varchar(32) |
|
NAME |
用户姓名 |
varchar(32) |
|
SEX |
性别 |
varchar(64) |
|
PNO |
体检编号 |
varchar(128) |
|
AGE |
年龄 |
varchar(128) |
|
HOS_ID |
医院ID |
varchar(50) |
|
EXAM_DESC |
检查综述 |
varchar(50) |
|
DOC_PROPOSAL |
医生建议 |
varchar(40) |
|
REMARK |
说明 |
varchar(128) |
|
DOCTOR_NAME |
总检医生 |
varchar(32) |
|
TEL |
咨询电话 |
varchar(32) |
|
PHY_DATE |
总检日期 |
datetime |
|
REG_DATE |
登记日期 |
datetime |
|
1.1.18 体检报告明细查询
1. 数据交互流程
2.参数说明:
【函数定义】getExaminationDetail
【服务说明】体检报告明细查询
【参数说明】XmlParams:字符串XML参数。
【参数列表】
参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
PHY_ID |
体检单ID |
varchar(40) |
TRUE |
|
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PHY_ID |
体检单ID |
varchar(32) |
|
RES_TYPE |
检查类型 |
varchar(32) |
1检查,2检验,3其他 |
ITEM_NAME |
项目名称 |
varchar(40) |
|
ITEM_CODE |
项目编号 |
varchar(20) |
|
EXAM_DATE |
检查日期 |
varchar(40) |
|
DOCTOR_NAME1 |
检查医生 |
varchar(40) |
|
RAMARK1 |
备注 |
varchar(40) |
|
ASSAY_NAME |
项目名称 |
varchar(40) |
|
ASSAY_VALUE |
检查结果 |
varchar(40) |
|
UNIT |
单位 |
varchar(40) |
|
PROMPT |
提示 |
varchar(40) |
|
REFER |
参考值 |
varchar(40) |
|
小结 |
varchar(40) |
|
-
- 第二部分:住院
2.1.1WeChat_GetZyPatientInfo:获取住院患者资料
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetZyPatientInfo
【服务说明】获取住院患者资料
【参数示例】传入参数的具体的格式参照WeChat_GetOrganization
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
PatientName |
病人姓名 |
varchar(50) |
TRUE |
|
InpatientNo |
住院号 |
varchar(12) |
TRUE |
ID号、住院号、身份证号三者不能同时为空 |
PatientID |
病人ID |
varchar(12) |
TRUE |
ID号、住院号、身份证号三者不能同时为空 |
IDCard |
身份证号 |
varchar(18) |
TRUE |
ID号、住院号、身份证号三者不能同时为空 |
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PatientID |
病人ID |
varchar(12) |
|
PatientName |
病人姓名 |
varchar(100) |
|
InpatientNo |
住院号 |
varchar(12) |
|
AdmissTimes |
住院次数 |
int |
|
ReferPhysician |
管床医生工号 |
varchar(10) |
|
ReferPhysicianName |
主管医生姓名 |
vharchar(50) |
|
Dept |
当前科室 |
varchar(10) |
|
BedNo |
病床号 |
varchar(8) |
|
Status |
住院状态 |
varchar(10) |
in 住院;out 出院 |
AdmissDate |
入院日期 |
datetime |
格式:YYYY-MM-DD |
DisDate |
出院日期 |
datetime |
格式:YYYY-MM-DD,本次入院还未出院,则返回空字符串 |
2.1.2WeChat_GetZyInfos:查询住院信息(列表)详情
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetZyInfos
【服务说明】获取患者住院信息列表及详情。患者在手机上通过绑定一个住院号可以查询当次和历次的住院记录信息,当住院状态不为空时,可以根据住院状态查询。
【参数示例】传入参数的具体的格式参照WeChat_GetZyInfos
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
每次住院流水 |
varchar(50) |
TRUE |
住院流水及住院号两者不能同时为空 |
InpatientNo |
住院号 |
varchar(12) |
TRUE |
住院流水及住院号两者不能同时为空 |
BeginDate |
开始时间 |
varchar(20) |
FALSE |
开始时间 |
EndDate |
结束时间 |
Varchar(20) |
FALSE |
结束时间 |
ZYstate |
住院状态 |
Varchar(2) |
FALSE |
in 在院 out 出院 不传代表全部 |
Type |
查询列表标志 |
Varchar(2) |
TRUE |
查询列表的时候传1,查询明细的时候传2,当传2的时候,CheckinNo节点不能为空,其他节点为空。 |
备注:当begin_date和end_date 为空时默认查询一年的住院记录。
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
CheckinNo |
住院流水号 |
varchar(12) |
|
PatientName |
病人姓名 |
varchar(100) |
|
InpatientNo |
住院号 |
varchar(12) |
|
DepId |
住院科室ID |
int |
|
DeptName |
住院科室名称 |
varchar(10) |
|
BedNo |
床号 |
vharchar(50) |
|
Diagnose |
临床诊断 |
varchar(10) |
|
Status |
住院状态 |
varchar(10) |
in 在院 out 出院 |
AdmissDate |
入院日期 |
datetime |
格式:YYYY-MM-DD |
DisDate |
出院日期 |
datetime |
格式:YYYY-MM-DD,本次入院还未出院,则返回空字符串 |
DisDiag |
出院诊断 |
varchar(200) |
|
FeeTotal |
费用总额 |
Dec(18,0) |
单位:元 |
DepositfeeTotal |
押金总额 |
Dec(18,0) |
单位:元 |
DepositfeeBalance |
押金可用余额 |
Dec(18,0) |
单位:元 |
2.1.3WeChat_GetDailyLedgerList查询每日清单列表
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetDailyLedgerList
【服务说明】患者在通过住院号流水号可以查询关联的住院周期内费用清单(每日汇总).当开始时间结束时间为空时,默认传当次住院的所有费用单据。【参数示例】传入参数的具体的格式参照WeChat_GetDailyLedgerList
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
当次住院流水号
|
BeginDate |
开始时间 |
varchar(20) |
|
开始时间 YYYY-MM-DD |
EndDate |
结束时间 |
Varchar(20) |
|
结束时间YYYY-MM-DD |
备注:若时间为空,则返回当年1.1号到昨天的费用清单
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
CheckinNo |
住院流水号 |
varchar(12) |
|
LedgerId |
记账Id |
varchar(100) |
|
LedgerDate |
记账日期 |
datetime |
格式:yyyy-mm-dd |
FeeTotal |
费用总额 |
dec(18,2) |
单位:元 |
2.1.4WeChat_GetDailyLedger查询每日清单明细
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetDailyLedger
【服务说明】患者在通过住院号流水号+帐单id查询每日费用清单(详单),当账单id=all时,查询当前流水号的所有账单的明细。参数的具体的格式参照WeChat_GetDailyLedger
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
当次住院流水号 |
LedgerId |
记账ID |
varchar(100) |
TRUE |
每天的帐单id |
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
CheckinNo |
住院流水号 |
varchar(12) |
|
LedgerId |
记账Id |
varchar(30) |
|
LedgerDate |
记账日期 |
datetime |
格式:YYYY-MM-DD |
FeeItem |
费用项目 |
Varchar(20) |
|
FeeItemCode |
费用项目代码 |
Varchar(20) |
非空 |
ChargePrice |
单价 |
Dec(18,2) |
单位:元 |
Amt |
数量 |
Varchar(20) |
|
Unit |
单位 |
Varchar(20) |
|
Std |
规格 |
Varchar(20) |
|
FeeType |
费用项目类别 |
Varchar(20) |
如手术费、西药费、材料费 |
ItemTime |
费用执行时间 |
Varchar(20) |
格式:yyyy-mm-dd hh:mm:ss |
FeeTime |
费用产生时间 |
Varchar(20) |
格式:yyyy-mm-dd hh:mm:ss |
FeeItemTotal |
单项项目总额 |
Dec(18,0) |
单位:元 |
FeeTotal |
费用总额 |
Dec(18,0) |
单位:元 |
2.1.5WeChat_PayDepositFee住院押金缴入
1.数据交互流程
2.参数说明:
【函数定义】WeChat_PayDepositFee
【服务说明】住院押金缴入
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
当次住院流水号 |
OprId |
收费员 |
varchar(20) |
TRUE |
His是否需要 NY05 |
PayMethod |
支付方式 |
varchar(20) |
TRUE |
His是否需要 14 |
InpatientNo |
住院号 |
varchar(20) |
FALSE |
患者在院内信息系统的唯一号码 |
TradeNo |
支付交易流水号 |
varchar(20) |
TRUE |
使用网上支付的流水号 |
TradeTime |
支付交易时间 |
varchar(20) |
TRUE |
网上支付的时间 |
PayAmt |
支付金额 |
numberic(20) |
TRUE |
单位:元 |
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Rs |
结果 |
varchar(2) |
0:成功 -1:失败 |
Msg |
结果消息 |
varchar(5000) |
|
ReceiptNo |
押金回执单 |
varchar(12) |
His的发票号 |
2.1.6WeChat_GetDepositFee押金缴费记录查询
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetDepositFee
【服务说明】查询患者住院押金缴费记录.
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
|
InpatientNo |
住院号 |
varchar(20) |
FALSE |
患者在院内信息系统的唯一号码 |
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PayTime |
缴费时间 |
varchar(12) |
|
ChannelId |
支付渠道 |
varchar(30) |
支付的渠道,比如 91160/银行/窗口 |
PayMethodName |
支付方式 |
varchar(30) |
患者缴费的渠道,现金/weixin/alipay |
PayAmt |
缴费金额 |
Dec(18,0) |
缴纳的押金金额,单位元 |
2.1.7WeChat_QueryPayState押金缴入状态查询
1.数据交互流程
2.参数说明:
【函数定义】WeChat_QueryPayState
【服务说明】查询患者住院押金缴费记录.
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
|
TradeNo |
支付交易流水号 |
varchar(20) |
FALSE |
|
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
ReceiptNo |
押金回执单 |
varchar(12) |
也就是发票号 |
2.1.8WeChat_CheckInfoCount查看当次住院费用
1.数据交互流程
2.参数说明:
【函数定义】WeChat_CheckInfoCount
【服务说明】患者在通过住院号流水号,查询当前流水号的所有账单的统计。
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
CheckinNo |
住院流水号 |
varchar(50) |
TRUE |
当次住院流水号 |
3.返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
CheckinNo |
住院流水号 |
varchar(12) |
|
FeeType |
项目类别 |
varchar(30) |
|
FeeTypeTotal |
该类别费用总和 |
Dec(18,2) |
单位:元 |
FeeTotal |
总费用 |
Dec(18,2) |
单位:元 |
2.1.9WeChat_GetZyPayList:住院押金对账接口
1.数据交互流程
2.参数说明:
【函数定义】WeChat_GetZyPayList
【服务说明】住院押金对账接口
【参数示例】传入参数的具体的格式参照WeChat_GetOrganization
【参数说明】XmlParams:字符串XML参数。
【参数列表】
参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
Organization |
机构编码 |
varchar(50) |
TRUE |
|
BeginDate |
开始时间 |
datetime |
TRUE |
|
EndDate |
结束时间 |
datetime |
TRUE |
|
PatientID |
病人ID |
varchar(12) |
False |
|
注:时间为空则返回该患者本年所有的缴费记录
3.、返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
Result |
返回结果 |
varchar(30) |
0:成功 -1:失败 |
Error |
返回消息 |
varchar(32) |
|
【值列表】
返回值 |
中文意思 |
数据类型 |
注释 |
PatientName |
姓名 |
varchar(50) |
|
PatientID |
病人ID |
varchar(12) |
|
VisitTime |
住院时间 |
datetime |
|
HisPayNo |
住院单据号 |
varchar(20) |
病人ID^住院次数 |
ReceiptSn |
发票流水号 |
varchar(20) |
|
PayStatus |
支付状态 |
varchar(2) |
1已支付;-1已退费 |
PayType |
支付方式 |
varchar(10) |
w微信支付 |
AccountSn |
支付次数 |
int |
|
ChargeDate |
支付时间 |
datetime |
|
ChargeTotal |
支付金额 |
Decimal(18,0) |
单位:元 |
TransactionID |
支付订单号 |
varchar(50) |
|
BusinessType |
类别 |
varchar(1) |
1:门诊 2:住院 |
RefundMan |
退费人 |
varchar(50) |
住院不做微信退费,退费全为空 |
RefundTime |
退费时间 |
datetime |
住院不做微信退费,退费全为空 |
RefundAmt |
退费金额 |
Decimal(18,0) |
住院不做微信退费,退费全为空 |
RefundNo |
退费流水号 |
varchar(50) |
住院不做微信退费,退费全为空 |
2.1.10inHos_warnDeposit:住院押金提醒接口
1.数据交互流程
2.参数说明:
【函数定义】inHos_warnDeposit
【服务说明】住院押金提醒接口
【参数示例】传入参数的具体的格式参照inHos_warnDeposit
【参数说明】XmlParams:字符串XML参数。
【参数列表】
入参,参数列表:
字段名 |
中文意思 |
数据类型 |
强制标志 |
注释 |
unit_id |
医院编码 |
varchar(50) |
TRUE |
深圳儿童医院为111 |
checkin_no |
住院流水号 |
datetime |
TRUE |
|
patient_no |
住院号 |
datetime |
TRUE |
|
phone |
手机号 |
varchar(12) |
TRUE |
|
warn_msg |
提醒内容 |
varchar(20) |
TRUE |
您的住院押金余额较低(999.00),请及时充值 |
3.、返回信息:
返回值为XML参数字符串。
【参数列表】
返回值 |
中文意思 |
数据类型 |
注释 |
result |
返回结果 |
varchar(30) |
1-推动成功 0-推送失败 |
desc |
返回消息 |
varchar(32) |
|
4.押金提醒接口示例:
入参名称 |
示例 |
data |
<request> <head> <key>inHos_warnDeposit</key> <hospcode>111/hospcode> <token></token> <time></time> </head> <body> <checkin_no>住院流水号</checkin_no> <patient_no>住院号</patient_no> <phone>手机号码</phone> <warn_msg>您的住院押金余额较低(999.00),请及时充值额</warn_msg> </body> </request> |
|
|
出参:
入参名称 |
示例 |
data |
<response> <head> <result>1</result> <desc>推送成功</desc> </head> </response> |
|
|