门诊住院预约平台与医院预约对接说明

门诊住院预约平台与医院预约对接说明医院自行开发接口规范）WebService版本Ver3.0.0江苏建康无忧网络科技有限公司前言本接口定义了门诊住院预约挂号服务平台与各医院或接入平台预约之间进行数据交换的方式方法。本平台集中整合了区域内各级医疗服务机构的门诊诊疗挂号资源，为广大患者提供便捷的基于互联网络的预约诊疗服务。为提高对接数据的准确性，平台预约采用直调院端预约接口的方式。接口介绍接口分为两部分，一为基础数据，包括科室、医生、排班数据，由12320预约挂号服务平台提供webservice，医院调用接口上传；二是预约以及统计功能，包括预约下单、取消预约、预约统计等，由院端提供webservice，12320预约平台调用接口完成业务。包含以下接口：修订记录修订日期修订内容修订人Vl.l2018/6/201.1.4增加字段；1.2.1增加字段；1.2.7增加字段曹阳平台提供基础数据上传服务接口所有请求都必须包含soapHeader信息，用于权限校验<soapenv:Header><AccountToken><username>test</username><password>test2018</password></AccountToken></soapenv:Header>上传医院名称：UpdateHospital

说明：上传医院函数名UpdateHospital(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：xml节点描述编号数据项类型说明备注1hoscodeString医院编号必填2hosnameString医院名称必填3hosintroString医院简介必填4hosphoString预约号码必填5hostrafficString交通简介必填6hosonlineString医院接入状态0-未接入1-已接入默认07hoslevelString医院所属级别0：省部；1：市属；2:区属;3:部队;4:其他必填8hostypeString医院类型10：—级未评；11:一级甲等；12:—级一等；20:二级未评；21:二级甲等；22:二级乙等；30:三级未评；31:三级甲等;32:三级乙等必填9hosurlString医院网址10hosshortnamString医院简称11platcodeString接入平台编号由省平台分配XML格式定义为：<UpdateHospitalPara><Hospitals><!--Hospital节点为多个--><Hospital><hoscode></hoscode><hosname></hosname><hosintro></hosintro><hospho></hospho><hostraffic></hostraffic><hosonline></hosonline><hoslevel></hoslevel><hostype></hostype><hosurl></hosurl><hosshortnam></hosshortnam></Hospital></Hospitals></UpdateHospitalPara>返回值：XML字段描述编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息返回值：XML格式定义为<UpdateHospitalResult><ResultInfo><Successful></Successful><Info><Flag></Flag><Msg></Msg></Info></ResultInfo></UpdateHospitalResult>上传科室名称：UpdateDepartment说明：上传科室函数名UpdateDepartment(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：xml节点描述编号数据项类型说明备注hoscodeString医院编号必填depcodeString科室编号必填depnameString科室名称必填depintroString科室简介bigcodeString大科室编号bignameString大科室名称subcodeString科室类别编号默认1XML格式定义为：<UpdateDepartmentPara><Departments><!--Department节点为多个--><Department><hoscode></hoscode><depcode></depcode><depname></depname><depintro></depintro><bigcode></bigcode><bigname></bigname><subcode></subcode></Department></Departments>

</UpdateDepartmentPara>返回值：XML字段描述编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息返回值：XML格式定义为<UpdateDepartmentResult><ResultInfo><Successful></Successful><Info><Flag></Flag><Msg></Msg></Info></ResultInfo></UpdateDepartmentResult>上传医生名称：UpdateDoctor说明：上传医生函数名UpdateDoctor(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：xml节点描述编号数据项类型说明备注hoscodeString医院编号必填depcodeString科室编号必填doccodeString医生编号必填docnameString医生姓名必填imgUrlString医生图片url全路径principalshipString医生职称docintroString医生简介XML格式定义为：<UpdateDoctorPara><Doctors><!--Doctor节点为多个--><Doctor><hoscode></hoscode><depcode></depcode><doccode></doccode><docname></docname><imgUrl></imgUrl><principalship></principalship><docintro></docintro></Doctor></Doctors></UpdateDoctorPara>返回值：XML字段描述编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息返回值：XML格式定义为<UpdateDoctorResult><ResultInfo><Successful></Successful><Info><Flag></Flag><Msg></Msg></Info></ResultInfo></UpdateDoctorResult>上传排班名称：UpdateSchedule说明：上传排班和在医院编码和排班编号相同情况下更新排班函数名UpdateSchedule(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：xml节点描述编号数据项类型说明备注hoscodeString医院编号必填depcodeString科室编号必填doccodeString医生编号必填workdateString排班日期(yyyy-MM-dd)必填worktimeString排班时间（上午，下午）必填reservedNumberString总预约数必填availableNumberString剩余预约数必填reserveTypeString预约类型（1专科号,2专家号）必填chargeString-P-P口井，a挂号费必填resNumStringleftNumStringresFrontNumStringleftFrontNumStringstateString排班状态（T：停诊；0：停约；1：可约）必填，默认1可约frontSchIdString排班编号（纯数字，长度限制8位）必填，医院自己的排班表主键ScheduleNo节点为多个schNoString排班号序，多个号序用逗号隔开，例如：1,2,3存在号序的医院，此三个字段必填schTimeString号序所在时段，例如08:00-09:00fetchTimeString时段的建议取号时间，例如07:30XML格式定义为：<UpdateSchedulePara><Schedules><!--Schedule节点为多个--><Schedule><hoscode></hoscode><depcode></depcode><doccode></doccode><workdate></workdate><worktime></worktime><reservedNumber></reservedNumber><availableNumber></availableNumber><reservedType></reservedType><charge></charge><resNum></resNum><leftNum></leftNum><resFrontNum></resFrontNum><leftFrontNum></leftFrontNum><state></state><frontSchId></frontSchId><scheduleNos><!--ScheduleNo节点为多个--><scheduleNo><schNo>1,2,3</schNo><schTime>08:00-09:00</schTime><fetchTime>07:30</fetchTime></scheduleNo></scheduleNos></Schedule></Schedules></UpdateSchedulePara>返回值：XML字段描述编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息返回值：XML格式定义为<UpdateScheduleResult><ResultInfo><Successful></Successful><Info><Flag></Flag><Msg></Msg></Info></ResultInfo></UpdateScheduleResult>医院提供预约业务服务接口IP:由卫生信息中心统一分配专网IP端口：医院自行定义工程名：HosResURL：/servicesServiceName：HosResService命名空间(targetNamespace):http://service.{hoscode}.详细可参看demo发布成功后如下图左边单元格内，其中“L03317”为医院代码

详细代码参考附压缩包内的示例1・2・1预约下单名称：createReservation说明：预约下单方法名createReservation(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注hosCodeStringY医院编号depCodeStringY科室编号docCodeStringY/N医生编号当reserveType为2时必填reserveTypeStringY排班类型1专科号2专家号reserveDateStringY排班日期格式yyyy-MM-ddreserveTimeStringY排班时间schNoStringY/N排班号序如:1schTimeStringY/N号序所在时段，如：08:00-09:00idCardNoStringY患者身份证号nameStringY患者姓名genderStringY1男性2女性birthdayStringY出生日期yyyy-MM-ddphoneStringY患者手机frontSchIdStringY排班编号XML格式定义为：<createReservationPara><hosCode></hosCode><depCode></depCode><docCode></docCode><reserveType></reserveType><reserveDate></reserveDate><reserveTime></reserveTime><idCardNo></idCardNo><name></name><gender></gender><birthday></birthday><phone></phone><frontSchId></frontSchId></createReservationPara>返回值：XML字段描述数据项类型说明备注successfulString结果标识0失败1成功FlagString错误编码MsgString错误文字描述flag1：科室编号不存在2：专家编号不存在3：预约日期不合法4：排班不存在5：挂号已满6：排班已停诊7：已经预约了8：身份证号码错误9：患者姓名错误10：患者账号被锁定11：其他错误rescodeString预约记录唯一标识医院数据库中预约记录主键resNoString预约号序fetchTimeString建议患者取号时间takePlaceString取号地点reservedNumberString排班可预约数方便冋步最新的排班信息availableNumberString排班剩余可预约数ScheduleNo节点为多个schNoString排班号序多个号序用逗号隔开，例如：1,2,3schTimeString号序所在时段，例如08:00-09:00fetchTimeString时段的建议取号时间，例如07:30XML格式定义为<createReservationResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉〈msg〉〈/msg〉〈/info〉〈/resultInfo〉〈reservationInfo〉〈rescode〉〈/rescode〉〈resNo〉〈/resNo〉〈fetchTime〉〈/fetchTime〉〈takePlace〉〈/takePlace〉〈/reservationInfo〉〈Schedule〉〈reservedNumber〉〈/reservedNumber〉〈availableNumber〉〈/availableNumber〉〈scheduleNos〉〈!--ScheduleNo节点为多个--〉〈scheduleNo〉〈schNo〉1,2,3〈/schNo〉〈schTime〉08:00-09:00〈/schTime〉〈fetchTime〉07:30〈/fetchTime〉〈/scheduleNo〉〈/scheduleNos〉〈/Schedule〉〈/createReservationResult〉确认预约名称：confirmReservation说明：主要用于预约下单后的挂号缴费确认方法名confirmReservation(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注rescodeStringY预约记录唯一标识医院数据库中预约记录主键orderNumberStringY支付订单号payModeCodeStringY支付方式编号02:支付宝；03:微信XML格式定义为：<confirmReservation><rescode></rescode><orderNumber></orderNumber><payModeCode></payModeCode></confirmReservation>返回值：XML字段描述数据项类型说明备注successfulString结果标识0失败1成功FlagString错误编码MsgString错误文字描述flag1：预约编号不存在2：重复确认3：确认失败9：其他错误XML格式定义为<confirmReservationResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉<msg></msg></info></resultInfo></createReservationResult>1.2.3取消预约名称：cancelReservation说明：取消预约方法名cancelReservation(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注rescodeStringY预约记录唯一标识医院数据库中预约记录主键idCardNoStringY患者身份证号nameStringY患者姓名XML格式定义为：<cancelReservationPara><rescode></rescode><idCardNo></idCardNo><name></name></cancelReservationPara>返回值：XML字段描述数据项类型说明备注successfulString结果标识0失败1成功flagString错误编码msgString错误文字描述flag1：没有预约2：预约已取消3：预约已就诊4身份证号码错误5：患者姓名错误6：不允许取消7：其他错误XML格式定义为<cancelReservationResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉〈msg〉〈/msg〉〈/info〉〈/resultInfo〉〈/cancelReservationResult〉更新预约支付状态名称：updatePayState说明：更新预约支付状态,请注意，预约下单后默认为未支付状态。方法名updatePayState(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注rescodeStringY预约记录唯一标识医院数据库中预约记录主键idCardNoStringY患者身份证号nameStringY患者姓名payStateStringY预约支付状态状态：0=未支付；1=已支付orderNoStringY支付成功的订单号XML格式定义为：〈updatePayStatePara〉〈rescode〉〈/rescode〉〈idCardNo〉〈/idCardNo〉〈name〉〈/name〉<payState></payState><orderNo></orderNo></updatePayStatePara>返回值：XML字段描述数据项类型说明备注successfulString结果标识0失败1成功flagString错误编码msgString错误文字描述flag1：没有预约2：预约已取消3：预约已就诊4身份证号码错误5：患者姓名错误6：其他错误XML格式定义为<updatePayStateParaResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉〈msg〉〈/msg〉〈/info〉〈/resultInfo〉〈/updatePayStateParaResult〉1・2・5查询预约状态名称：searchReservation说明：查询预约状态方法名searchReservation(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注rescodeStringN预约记录唯一标识医院数据库中预约记录主键idnumStringN患者身份证号workdateStringN就诊日期yyyy-MM-dd二个参数至少有一个必填,rescode查询指定的一条预约记录;idnum查询某个患者的预约记录;orkdate查询某天的预约记录XML格式定义为：<searchReservationPara><rescode></rescode><idnum></idnum><workdate></workdate></searchReservationPara>返回值：XML字段描述数据项类型说明备注successfulString结果标识0失败1成功flagString错误编码msgString错误文字描述rescodeString预约记录唯一标识idnumString患者身份证号stateString预约状态1待取号2已取号3：退约4：违约XML格式定义为<searchReservationResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉〈msg〉〈/msg〉〈/info〉〈/resultInfo〉<reservations><reservation><!--此节点可以是多个--><rescode></rescode><idnum></idnum><state></state></reservation></reservations></searchReservationResult>1.2.6预约统计名称：resStatistics说明：预约统计方法名resStatistics(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注startTimeStringN开始时间格式：yyyy-MM-ddendTimeStringN结束时间格式：yyyy-MM-ddresWayStringN预约途径0：全部1：诊间2：护士站3：住院4：电话5：其他resStateStringN预约状态0：全部1：成功预约2：已就诊3：退约4：违约XML格式定义为：<resStatisticsPara><startTime></startTime><endTime></endTime><resWay></resWay><resState></resState></resStatisticsPara>返回值：XML字段描述数据项类型说明备注resWayString预约途径0：全部1：诊间2：护士站3：住院4：电话5：其他resStateString预约状态0：全部1：成功预约2：已就诊3：退约4：违约countString预约数量successfulString结果标识0失败1成功flagString错误编码msgString错误文字描述flag1：开始时间格式错误2：结束时间格式错误XML格式定义为<resStatisticsResult><resultInfo><successful>0</successful>〈!--如果为1成功，则没有Info节点--〉<info>〈flag〉〈/flag〉〈msg〉〈/msg〉〈/info〉〈/resultInfo〉〈statisticsInfo〉〈!--statistics节点为一个或多个--〉<statistics><resWay></resWay><resState></resState><count></count></statistics></statisticsInfo></resStatisticsResult>1・2・7查询排班名称：searchSchedule说明：排班查询-主要用于验证排班信息、获取当日号方法名searchSchedule(Stringarg)AsString参数XML格式字符串返回值XML格式字符串参数：XML节点描述数据项类型必填默认值说明备注hoscodeStringN医院编号depcodeStringN科室编号doccodeStringN医生编号frontSchIdStringN排班编号医院自己的排班表主键schTimeStringN排班时间startDateStringY排班开始日期格式：yyyy-MM-ddendDateStringY排班结束日期格式：yyyy-MM-ddreserveTypeStringN排班类型1专科号2专家号如果frontSchld不为空，则查询指定的一条排班记录XML格式定义为：<searchSchedulePara><hoscode></hoscode>

<depcode></depcode><doccode></doccode><frontSchId></frontSchId><schTime></schTime><startDate></startDate><endDate></endDate><reserveType></reserveType></searchSchedulePara>返回值：XML字段描述编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息编号数据项类型说明备注SuccessfulString操作结果0失败，1成功InfoString错误提示信息Successful为1无此节点FlagString错误代码MsgString错误详细信息hoscodeString医院编号必填depcodeString科室编号必填doccodeString医生编号必填workdateString排班日期（yyyy-MM-dd）必填worktimeString排班时间（上午，下午）必填reservedNumberString总预约数必填availableNumberString剩余预约数必填reserveTypeString预约类型（1专科号,2专家号）必填chargeString-P-P口井，a挂号费必填resNumStringleftNumStringresFrontNumStringleftFrontNumStringstateString排班状态（T：停诊；0：停约；1：可约）frontSchIdString排班编号（纯数字，长度限制8必填位）ScheduleNo节点为多个schNoschNoschNoschTimeschTimeschTimefetchTimefetchTimefetchTimeXML格式定义为<searchScheduleResult><ResultInfo><Successful></Successful><Info><Flag></Flag><Msg></Msg></Info></ResultInfo><Schedules><!--Schedule节点为多个--><Schedule><hoscode></hoscode><depcode></depcode><doccode></doccode><workdate></workdate><worktime></worktime><reservedNumber></reservedNumber><availableNumber></availableNumber><reservedType></reservedType><charge></charge><resNum></resNum><leftNum></leftNum><resFrontNum></resFrontNum><leftFrontNum></leftFrontNum><state></state><frontSchId></frontSchId><scheduleNos><!--ScheduleNo节点为多个--><scheduleNo><schNo>1,2,3</schNo><schTime>08:00-09:00</schTime><fetchTime>07:30</fetchTime></scheduleNo></scheduleNos></Schedule></Schedules></searchScheduleResult>1.2.8查询用户名称：getPatientlnfo说明：用户信息查询和用户信息