云HIS平台接口文档.doc

。成都义幻网络技术有限公司HIS标准接口文档资料修订记录版本修订日期修订内容修订人V1.02015-12-17初稿程文强V1.12016-03-161、 就诊记录列表2、 处方查询3、 缴费查询4、 住院记录查询接口5、 住院每日费用查询魏建V1.112016-03-17增加体检中心接口黎辉 V1.212016-05-051、检验，检查报告查询2、检验，检查报告明细查询 黎辉1.应用场景42.接口的使用43.数据加密44.医院HIS接口54.1.基本信息接口54.1.1.获取所有科室列表(app,服务窗口，微信公众号通用)54.1.2.获取所有医生列表(app,服务窗口，微信公众号通用)64.2.患者接口84.2.1.获取患者信息(app,服务窗口，微信公众号通用)84.2.2.更新病人基本信息(app,服务窗口，微信公众号通用)94.3.挂号相关接口134.3.1.值班科室查询(app,服务窗口，微信公众号通用)134.3.2.值班医生查询(app,服务窗口，微信公众号通用)154.3.3.医生可用号源查询(app,服务窗口，微信公众号通用)164.3.4.患者可挂号检查(app,服务窗口，微信公众号通用)184.3.5.锁定号源(app,服务窗口，微信公众号通用)194.3.6.取消锁号214.3.7.取号(app,服务窗口，微信公众号通用)214.3.8.取消挂号(app,服务窗口，微信公众号通用)234.3.9.自费用户线下预约记录（线下挂号转线上支付）(app,服务窗口，微信公众号通用)234.4.无卡挂号254.4.1.用户注册(app,服务窗口，微信公众号通用)254.4.2.无卡锁号(app,服务窗口，微信公众号通用)264.5.缴费接口274.5.1.获取病人就诊的医嘱信息(app,服务窗口，微信公众号通用)274.5.2.缴费(app,服务窗口，微信公众号通用)304.6.就诊记录314.6.1.就诊记录列表查询(app,服务窗口，微信公众号通用)324.6.2.获取处方信息(app,服务窗口，微信公众号通用)344.6.3.获取缴费信息(app,服务窗口，微信公众号通用)364.7.检验检查报告查询394.7.1.检验检查报告查询(app,服务窗口，微信公众号通用)394.7.2.检验检查报告明细查询(app,服务窗口，微信公众号通用)414.8.住院相关接口434.8.1.获取患者住院信息(app,服务窗口，微信公众号通用)434.8.2.住院记录查询接口(app,服务窗口，微信公众号通用)454.8.3.住院每日费用明细(app,服务窗口，微信公众号通用)484.8.4.预交费(住院预交金)(app,服务窗口，微信公众号通用)504.9.对账接口524.9.1.对账 微信-HIS(app,服务窗口，微信公众号通用)524.9.2.对账 HIS-微信(app,服务窗口，微信公众号通用)554.9.3.根据订单号查询交易是否成功(app,服务窗口，微信公众号通用)574.10.其他接口574.10.1.获取候诊信息574.10.2.获取加号信息(app,服务窗口，微信公众号通用)594.10.3.停诊通知(app,服务窗口，微信公众号通用)614.11.HIS主动接口624.11.1.排队候诊接口(app,服务窗口，微信公众号通用)634.11.2.缴费提醒接口(app,服务窗口，微信公众号通用)634.11.3.检查检验报告提醒接口(app,服务窗口，微信公众号通用)644.12.个人体检相关接口654.12.1.获取体检套餐(app,服务窗口，微信公众号通用)654.12.2.缴纳体检费(app,服务窗口，微信公众号通用)664.12.3.体检预约(app,服务窗口，微信公众号通用)674.13.团队体检相关接口694.13.1.查询团队体检信息(app,服务窗口，微信公众号通用)694.13.2.完善个人资料(app,服务窗口，微信公众号通用)724.14.查询体检结果734.14.1.查询体检结果(app,服务窗口，微信公众号通用)734.15.便民门诊774.15.1.需求提交(app,服务窗口，微信公众号通用)774.15.2.需求回执(app,服务窗口，微信公众号通用)784.16.B超相关接口内容784.16.1.检查提示(app,服务窗口，微信公众号通用)784.16.2.获取患者信息(app,服务窗口，微信公众号通用)784.16.3.获取检查时间段设置(app,服务窗口，微信公众号通用)794.16.4.获取检查时间日历(app,服务窗口，微信公众号通用)794.16.5.确认预约(app,服务窗口，微信公众号通用)79APP接口列表80微信公众号接口列表81服务窗接口列表811. 应用场景HIS为医院核心业务承载系统，打通了整个就医的各个环节，但只能在内部业务系统中使用，随着移动互联网的快速发展，人们越来越习惯于通过手机去快速完成一些事情，外部系统接入HIS的需求越来越强烈，为了解决这一问题，一套标准的HIS对外接口应运而生，本接口将说明HIS对外的接口标准。2. 接口的使用采用RESTful架构，是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。3. 数据加密将url地址的参数key进行字典排序后签名；接收方对签名进行验证。signature 签名方法（例子使用PHP伪代码）signature = Sha1(params. time . key) 注：params- 对key进行字典排序后前的值key value对应。如： url为a=1&c=3&b=2,params则为 a=1b=2c=3time - 当前时间戳（秒级别）key - 双方约定的加密串4. 医院HIS接口定义各类接口信息4.1. 基本信息接口4.1.1. 获取所有科室列表(app,服务窗口，微信公众号通用)实体：获取所有科室列表接口地址/allDept接口描述获取所有科室列表请求消息：请求示例GET无标签名数据类型长度必填说明应答消息：说明示例json格式 status: 0, error_msg: , data: dept_id: , dept_name: , dept_intro: , dept_address: , dept_position: , dept_tel: 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空dept_idstring30Y科室ID/唯一标识符dept_namestring20Y科室名称dept_introstring30N科室介绍dept_addressstring50N科室地址dept_positionint11N科室经纬度dept_telstring30N科室电话4.1.2. 获取所有医生列表(app,服务窗口，微信公众号通用)实体：获取所有医生列表接口地址/alldoctor接口描述获取所有医生列表请求消息：请求示例GET标签名数据类型长度必填说明应答消息：说明示例json格式 status: 0, error_msg: , data: doctor_id: 10001, doctor_name: 李浩, title: 教授, be_good_at: , description: , dept_name: 内科 doctor_head_img: , dept_id: 10, profession: , 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空doctor_idint11Y医生iddoctor_nameString18Y医生姓名titleString16Y职称be_good_atstring30Y擅长descriptionstring255N描术dept_namestring30N科室名doctor_head_imgstring50N头像dept_idint11N科室IDprofessionstring30N专业4.2. 患者接口4.2.1. 获取患者信息(app,服务窗口，微信公众号通用)实体：患者资源接口地址/patient接口描述通过就诊卡得到病人信息请求消息：请求示例GETcard_no=00000000标签名数据类型长度必填说明card_noString16Y就诊卡卡号应答消息：说明示例json格式 status: 0, error_msg: , data: name: 曾孟群, identity_card: card_no: 000002905977, create_date: 2015-05-02, patient_id: 07341271, mobile:标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空nameString20Y病人姓名identity_cardString18Y身份证号card_noString16Y卡号create_dateInt11Y建卡时间（秒级时间戳）patient_idInt11N患者编号（无则不返回）mobilestring30N电话号码4.2.2. 更新病人基本信息(app,服务窗口，微信公众号通用)接口说明：更新病人基本信息接口地址/updateUser接口描述根据病人提供的身份证，姓名，卡号，更新他的基本信息请求消息说明示例GETname=王宏&card_id=0000&identify_id=0002886946545643664&phone=1369541255标签名数据类型长度必填说明nameString10Y姓名card_noString2Y卡号Identify_idString16Y身份证号phonestring20Y电话应答消息说明示例json格式 status: 0, error_msg: , 字段说明标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空4.3. 挂号相关接口4.3.1. 值班科室查询(app,服务窗口，微信公众号通用)接口说明：可挂号科室资源接口地址/dutyDept接口描述根据挂号时间查询对应时间可挂号的科室信息请求消息说明示例GETdate=2015-12-11&period=am&card_no=0002886946标签名数据类型长度必填说明dateDate10N就诊日期periodString2Nam-上午，pm-下午card_noString16N就诊卡卡号应答消息说明示例json格式 status: 0, error_msg: , data: dept_duty_id: 2, dept_id: 2, title: 妇科门诊 , dept_duty_id: 3, dept_id: 3, title: 产科门诊 字段说明标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空data数据dept_duty_idInt8N值班部门编号dept_idInt8Y部门编号titleString50Y部门名称4.3.2. 值班医生查询(app,服务窗口，微信公众号通用)接口说明：可挂号医生资源接口地址/dutyDoctor接口描述获取指定专业下值班医生信息请求消息说明示例GETdept_id=1&date=2015-12-12&period=am标签名数据类型长度必填说明dept_idint8Y部门编号datedate11N挂号日期periodString2Nam-上午，pm-下午dept_duty_idInt8N部门值班编号应答消息说明示例json格式status: 0,errorMsg: , data: dept_duty_id: 3308, doctor_id: 3308, name: 梁占光 , dept_duty_id: 3308, doctor_id: 3308, name: 梁占光 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空dept_duty_idInt8Y医生的值班编号doctor_idInt8Y医生编号nameString20Y医生姓名4.3.3. 医生可用号源查询(app,服务窗口，微信公众号通用)接口说明：医生资源接口地址/doctor接口描述查询医生基本信息及值班信息接口调用说明示例GETdoctor_id=1&date=2015-12-12&period=am标签名数据类型长度必填说明doctor_idint8Y医生编号datedate8N挂号日期periodString2N挂号时段（am上午，pm下午）应答消息：说明示例json格式 result: 0, errorMsg: ,data: info: name:张教授, title: 四级专家, fee:10.00 , duty: date: 2015-09-09, am: yes, pm: yes, total: 10, use: 1 duty_doc_id: 3294|775 , date: 2015-09-10, am: yes, pm: yes, total: 10, use: 1 duty_doc_id: 3294|775 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空Info-医生基本信息nameString30Y医生姓名titleString30Y医生职称feeInt10Y医生出诊费用duty-医生出诊列表datedate10Y出诊时间amString3Y上午是否出诊yes或nopmString3Y下午是否出诊yes或nototalInt8Y挂号总数量useInt8Y已挂号数量duty_doc_idString20Y医生出诊编号（用于挂号）4.3.4. 患者可挂号检查(app,服务窗口，微信公众号通用)接口说明：挂号接口接口地址/registration接口描述检查是否可挂号接口调用说明示例GETact=check&duty_doc_id=1&date=2015-12-12&period=am&card_no=0000000标签名数据类型长度必填说明actString8Ycheck-固定不变意为挂号检查duty_doc_idInt8Y医生值班编号dateDateY挂号日期periodString2Yam-上午，pm-下午card_nostring20Y卡号应答消息：说明示例json格式 status: 0, errorMsg: , data: result: 1, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败errorMsgString100Y错误信息，无则空resultString10Y1-可挂号，其他-不可挂号5. 锁定号源(app,服务窗口，微信公众号通用)接口说明：挂号锁号接口地址/registration接口描述锁定某一个挂号号源说明示例PUTact=lock&duty_doc_id=1&doc_id=1&day=2015-12-12&period=am&type=1标签名数据类型长度必填说明actString8Ylock-固定不变意为锁号duty_doc_idInt8Y医生值班编号doc_idint8Y医生编号dayDateN挂号日期periodString2Nam-上午，pm-下午typeint1Y1为短时间锁号 2为长时间锁号（预约）应答消息：说明示例json格式 status: 0, error_msg: , data: appt_id: 3203|2339|7, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空appt_idString100Y锁定的号,空则锁号失败5.1.1. 取消锁号5.1.2. 取号(app,服务窗口，微信公众号通用)接口说明：挂号锁号接口地址/registration接口描述取得某一个挂号号源说明示例PUTact=fetch&appt_id=1&card_no=00000000&bank_no=1000000022&fee=10标签名数据类型长度必填说明actString8Yfetch-固定不变意为取号appt_idString20Y号源编号（锁定）card_noString20Y挂号的就诊卡卡号bank_noString50Y收费流水号feeString10Y收费金额应答消息：说明示例json格式 status: 0, error_msg: , data: date: 2015, ser_no: 63902, appt_id:11111111, card_no: 000002727654, pat_name: 黄丽鹃 queue_no: 3, dept_name: 产科门诊, doctor_name: 张力(上午), doctor_title: 产科三级专家, address: 二楼02诊断室, fee: 43, invoice_no: 13725796, time_info: 请于上午8点至9点到医院就诊, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空data-挂号基本信息datedate8Y挂号时间appt_idString20Y号源编号（锁定）ser_noString20N全院挂号序号card_noString20N患者就诊卡卡号pat_nameString20N患者姓名queue_noString20Y当前科室挂号序号dept_nameString20Y就诊科室名称doctor_nameString20Y医生姓名doctor_titleString20Y医生级别addressString30Y就诊科室位置feeString30Y挂号费用invoice_noString50Y发票编号time_infoString50Y就诊时间提醒信息5.1.3. 取消挂号(app,服务窗口，微信公众号通用)接口说明：取消挂号（包括当日和预约）接口地址/cancelReg接口描述用户取消挂号说明示例PUTorder_id =3131342341& reason改期标签名数据类型长度必填说明order_idString50Y订单号reasonString取消原因应答消息：说明示例json格式 status: 0, error_msg: ,标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空5.1.4. 自费用户线下预约记录（线下挂号转线上支付）(app,服务窗口，微信公众号通用)接口说明：（支持线下窗口挂号转线上支付）接口地址/ lineUnPayRegList接口描述支持线下窗口挂号转线上支付说明示例GETcard_no=0000032321标签名数据类型长度必填说明card_noString20Y就诊卡卡号应答消息：说明示例json格式 status: 0,errorMsg: 查询成功.,data: appt_id : 3131343, card_no: 07480189, pat_name: 汤雪梅, pat_age: 26岁10月, pat_sex: 女,queue_no : 3, fee:200.00 is_pay: 0, ,标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空data线下挂号基本信息card_noString20Y就诊卡卡号adv_idString20Y医嘱编号pat_nameString10Y患者姓名pat_ageString20N患者年龄pat_sexString3N患者性别queue_noInt3Y号源序号feeStringY挂号费用is_payString3Y是否支付（1支付，0则未支付）5.2. 无卡挂号5.2.1. 用户注册(app,服务窗口，微信公众号通用)接口地址/patientRegister接口描述无卡用户注册请求消息：请求示例POST标签名数据类型长度必填说明nameString16Y身份证号sexString10Y姓名birth_dateString10Y出身年月identity_nostring30Y身份证号码addressstring50Y地址relationstring20Y关系occupationstring20Y职业 telephonestring20Y电话identity_typeint11Y证件类型nationstring30Y民族应答消息：说明示例json格式 status: 0, error_msg: ,data: patient_id: 07341271, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空patient_idInt10Y患者ID（患者唯一标识）5.2.2. 无卡锁号(app,服务窗口，微信公众号通用)接口地址/AppRegisterForNoCard接口描述无卡锁号请求消息：请求示例POST参数标签名数据类型长度必填说明patient_idString16Y病人idas_row_idString10Y排班号reg_dateString10Y挂号日期reg_rangestring30Y挂号时段应答消息：说明示例json格式 status: 0, error_msg: ,data: appt_id: 3250|929|25, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空appt_idstring20Y号源id5.3. 缴费接口5.3.1. 获取病人就诊的医嘱信息(app,服务窗口，微信公众号通用)接口说明：挂号锁号接口地址/doctorAdvice接口描述获取指定病人医嘱请求消息：说明示例GETcard_no=00000000&date=2015-09-09&adv_id=标签名数据类型长度必填说明card_noString20Y就诊卡卡号dateDate8Y指定日期adv_idString8N获取指定医嘱时使用应答消息：说明示例json格式 status: 0,error_msg: 获取费用信息成功.,data: info: adv_id: 111111, card_no: 07480189, pat_name: 汤雪梅, pat_age: 26岁10月, pat_sex: 女, fee_sum:200.00 is_pay: yes, , categories: cate_name:西药口服药, cate_fee:120.60, items: item_name:力蜚能(150mg*10片)农, price:10.00, quantity:10, fee:100.00, address:MZYF-门诊药房, , item_name:力蜚能(150mg*10片)农, price:10.00, quantity:10, fee:100.00, address:MZYF-门诊药房, 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空data-info挂号基本信息card_noString20Y就诊卡卡号adv_idString20Y医嘱编号pat_nameString10Y患者姓名pat_ageString20N患者年龄pat_sexString3N患者性别is_payString3Y是否支付（yes支付，则未支付）data-categories 医嘱大类列表cate_nameString20Y大类cate_feeString20Y大类金额data-categories-items 医嘱项目列表item_nameString50Y医嘱描述priceString10Y单价quantityInt5Y数量feeString10Y总价departmentString30Y所属科室5.3.2. 缴费(app,服务窗口，微信公众号通用)接口定义：缴费接口地址/pay接口描述结算病人的就诊医嘱费用请求消息：说明示例PUTcard_no=00000000&adv_id=111111&fee=10&bank_no=111标签名数据类型长度必填说明card_noString20Y就诊卡卡号adv_idString10Y医嘱编号feeString20Y缴费金额bank_noString30Y缴费流水号应答消息：说明示例json格式 status: 0, error_msg: 结算成功, data: invoice_no: 24541924, invoice_fee: 285.70, guide: 超声科(请到4楼预约窗口编号) 产科彩超胎儿及其宫腔彩色常规检查1|门诊药房6号窗口, bar_codes: bar_code:123444444, bar_code:123444445 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_msgString100Y错误信息，无则空data 信息invoice_noString30Y发票编号invoice_feeString30Y发票金额guideTextY导诊信息data-barCodes 检验条码信息bar_codeString30N条码信息5.4. 就诊记录通过就诊卡（或身份证号码）查询患者历史就诊记录，记录需包含医生编号，以便实现我的医生功能。5.4.1. 就诊记录列表查询(app,服务窗口，微信公众号通用)接口说明：获取历次门诊记录接口地址/outpatientHistory接口描述获取历次门诊记录请求消息：说明示例GETcard_no=00000000&page=1标签名数据类型长度必填说明card_noString20Y就诊卡卡号pageint11N请求第几页应答消息：说明示例json格式 status: 0,error_msg: 获取住院病人信息成功., data: page_count: 5, page: 1 every_page: 10, all_count: 256, info_list: number: 1009690926201510151200049718, date_time: 2015-10-15 07:21:14, diagnosis: 感冒, dept: 儿科门诊, master_doctor: 张光 master_doctor_id: 1254 fee: 236 , number: 1009690926201510151200049718, date_time: 2015-10-15 07:21:14, diagnosis: 感冒, dept: 儿科门诊, master_doctor: 张光 master_doctor_id: 1254 fee: 236 , 标签名数据类型长度必填说明statusInt4Y交易结果：0：成功 1：失败error_ms