大白云诊-患者端接口文档.docx

云门诊接口文档-患者端版本号：1.2 文档编号： Change HistoryDateVerChange TypeChange DescriptionsPerson2015-06-151.0Create创建文档。周培培2015-06-171.1Modify咨询详情返回调整周培培2015-08-051.2Modify同步新版本接口调整周培培2016-4-131.3Modify自助购药：新增我的够药咨询列表接口蔺海凤目录Change History11. 引言52. 接口规范51.1. 协议51.2. 地址51.3. 公共参数51.4. 返回值53. 接口详细说明62. 63.1. 登录流程63.1.1. 注册弃用 见3.1.263.1.2. 注册&绑定 -修改73.1.3. DM引流注册加绑定83.1.4. 登录93.1.5. 获取医生简报103.1.6. 获取患者简报103.1.7. 取消关注公众号113.1.8. 获取患者私人医生信息113.1.9. 获取openId123.2. 基础数据123.2.1. 患者端基础数据123.2.2. 获取某城市内医院列表143.3. 我的医生153.3.1. 绑定医生153.3.2. 我的医生-修改2.0163.3.3. 关注医生173.3.4. 取消关注183.3.5. 查找医生183.3.6. 医生详情-修改2.0203.4. 我的咨询213.4.1. 我的咨询213.4.2. 咨询详情（参见IM接口文档）223.4.3. 评价医生223.4.4. 我的问诊记录-2.0233.4.5. 获取推荐用药列表243.4.6. 问诊支付信息-2.0（2.2取消）253.4.7. 支付（2.2取消）263.4.8. 获取当前用户支付状态273.4.9. 获取问诊评价信息2.2增加273.4.10. 评价问诊2.2增加283.4.11. 我的处方药购药咨询列表（患者端）283.5. 个人中心303.5.1. 查看基础信息303.5.2. 提交基础信息(单个信息编辑)303.5.3. 保存个人信息（全部保存）-修改313.5.4. 编辑手机号-修改323.5.5. 查看个人档案333.5.6. 保存个人档案353.5.7. 提交意见373.5.8. 获取短信验证码373.5.9. 个人-2.0（2.2取消）383.5.10. 赚取诊金任务-（2.2取消）383.5.11. 钱包明细-2.0（2.2取消）393.6. 病历档案403.6.1. 病例档案列表（患者端）403.6.2. 病例档案详情（患者端）413.6.3. 保存病例档案-修改423.6.4. 更新病历档案图片443.6.5. 删除病例档案453.6.6. 获取最近扫描医生信息463.6.7. 搜索医院473.7. cms相关-已迁移至CMS服务473.7.1. 病例档案列表（cms）473.7.2. 病例档案图片信息查看（cms）483.7.3. 删除病例档案图片（cms）494. 附录503. 503.1. 关于异常状态码定义的建议501. 引言本文档用于描述微药店服务接口规范(不涉及用户购买流程)，主要包括：网络传输协议、数据传输协议,参数及返回值说明等内容。2. 接口规范1.1. 协议接口基于HTTP协议，支持GET/POST请求，以JSON格式返回数据。1.2. 地址接口地址为(开发)：http:/ap.7lk.me接口地址为(正式)：1.3. 公共参数参数名参数含义必选取值_p平台Y0：wx 1：andorid 2：iphone _v客户端版本号Y格式：x.x.x 例如：1.0.0_m设备的mac地址Y_cJSONP的回调函数名N说明：如上参数为公共参数，请在Http Header中传递1.4. 返回值返回值的基本结构如下：code:, msg:, data:,返回值结构描述属性含义取值code本次请求状态码0：表示成功；其他数字表示异常。msg状态码对应的信息状态码对应的提示信息。data业务相关数据JSON数组。不同接口返回的JSON数据对象3. 接口详细说明2.3.1. 登录流程3.1.1. 注册弃用 见3.1.2描述患者用户注册(独立注册服务，不含医生绑定操作)地址/patient/regist参数参数名类型必须备注dataJsonY用户微信账户信息方法POST响应成功 code: 0, msg: success, data: patient: patientId: 215315, unionKey: , qlkId : 22232 , old: true, havePersonal: true , couponFee: 5 请求状态提示信息患者信息患者id患者用户签名七乐康用户id是否老用户是否有私人医生赠送诊金失败code的值不为0的时候，请直接显示msg的值备注data举例： subscribe: 1, openid: o6_bmjrPTlm6_2sgVt7hMZOPfL2M, nickname: Band, sex: 1, language: zh_CN, city: 广州, province: 广东, country: 中国, headimgurl: , subscribe_time: 1382694957, unionid: o6_bmasdasdsad6_2sgVt7hMZOPfL remark: , groupid: 03.1.2. 注册&绑定 -修改描述患者用户关注公众号，扫码关注的话为医生推荐需传医生id，否则为自主关注首次关注赠送诊金券，地址/patient/registAndBind参数参数名类型必须备注dataJsonY用户微信账户信息doctorIdN医生id。空为自主注册，否则为推荐注册方法POST响应成功 code: 0, msg: success, data: patient: patientId: 215315, unionKey: , qlkId : 22232 , havePersonal: true, old: true, canTalk: true , doctor: doctorId: 12, name: 张三, photo: , authStatus: 0, consultCost: 4500, giftRecharge: value: 5 , createAt: 2015-11-04 16:16:16 请求状态提示信息患者id患者用户签名七乐康用户id是否老用户是否有私人医生是否老用户能否聊天医生id姓名头像认证状态诊费，单位：分。null为未开启赠送诊金绑定时间失败code的值不为0的时候，请直接显示msg的值备注3.1.3. DM引流注册加绑定描述患者用户注册(独立注册服务，不含医生绑定操作)地址/patient/dmRegist参数参数名类型必须备注dataJsonY用户微信账户信息方法POST响应成功 code: 0, msg: success, data: patient: patientId: 215315, unionKey: , qlkId : 22232 , old: true, havePersonal: true, canTalk: true , doctor: doctorId: 12, name: 张三, photo: , authStatus: 0 ,createAt: 2015-11-04 16:16:16,couponType: 0, couponLink: 请求状态提示信息患者id患者用户签名七乐康用户id是否老用户是否有私人医生是否可以咨询医生id医生姓名头像图片认证状态绑定时间优惠券类型。0：无；1：5元；2：10元；3：20元优惠券连接失败code的值不为0的时候，请直接显示msg的值备注data举例： subscribe: 1, openid: o6_bmjrPTlm6_2sgVt7hMZOPfL2M, nickname: Band, sex: 1, language: zh_CN, city: 广州, province: 广东, country: 中国, headimgurl: , subscribe_time: 1382694957, unionid: o6_bmasdasdsad6_2sgVt7hMZOPfL remark: , groupid: 03.1.4. 登录描述患者登录，获取患者用户信息以及七乐康b2c用户信息。地址/patient/login参数参数名类型必须备注openId字符串Y用户微信openId方法GET/POST响应成功 code: 0, msg: success, data: patientId: 215315, unionKey: ， qlkId ：22232 ， 请求状态提示信息医生id患者用户签名七乐康用户id失败code的值不为0的时候，请直接显示msg的值备注3.1.5. 获取医生简报描述获取医生简报信息地址/patient/doctor/simple参数参数名类型必须备注doctorId数字Y患者id方法GET/POST响应成功 code: 0, msg: 成功, data: doctorId: 15, name: 医生名, photo: , authStatus:0 请求状态提示信息患者id医生名头像医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）失败code的值不为0的时候，请直接显示msg的值备注3.1.6. 获取患者简报描述获取患者简报信息地址/patient/simple参数参数名类型必须备注patientId数字Y患者id方法GET/POST响应成功 code: 0, msg: 成功, data: patientId: 10, name: 乐得福3, openId: o6_bmjrPZOPfL2M, photo: /mmofHe/0, unionKey: Serwkfjrewkjvlwe3483ddf, “canTalk”:true， “personalNum”:2, “qlkId”：“3241234”, “defaultDr”:12 请求状态提示信息患者id患者名openId头像密钥资料是否全私人医生数量七乐康用户id只一个私人医生时医生id失败code的值不为0的时候，请直接显示msg的值备注3.1.7. 取消关注公众号描述获取患者私人医生相关信息地址/patient/cancel参数参数名类型必须备注openId数字Y患者openId方法GET/POST响应成功 code: 0, msg: 成功, data: 请求状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.1.8. 获取患者私人医生信息描述获取患者私人医生相关信息地址/patient/personal/info参数参数名类型必须备注patientId数字Y患者id方法GET/POST响应成功 code: 0, msg: 成功, data: patientId: 16, unionKey: Serwkfjrewkjvlwe3483ddf, havePersonal: true 请求状态提示信息患者id密钥是否有私人医生失败code的值不为0的时候，请直接显示msg的值备注3.1.9. 获取openId描述获取患者私人医生相关信息地址/patient/openId参数参数名类型必须备注unionId数字Y患者unionId方法GET/POST响应成功 code: 0, msg: 成功, data: patientId: 16, openId: “onor7s-xV0DfkJsVLjrHmIayMhCE” 请求状态提示信息患者idopenId失败code的值不为0的时候，请直接显示msg的值备注3.2. 基础数据3.2.1. 患者端基础数据描述获取患者端基础数据地址/patient/params参数参数名类型必须备注方法GET/POST响应成功 code: 0, msg: 成功, data: documParam: defMedications: id: 1, name: 青霉素 , defFamDisease: id: 14, name: 高血压 , defPastDes: id: 14, name: 高血压 , defWines: id: 24, name: 白酒 , firstDepartments: id: 1, name: 内科, parentId: 0, childs: id: 8, name: 肿瘤内科, parentId: 0 , departments: id: 8, name: 肿瘤内科, parentId: 0 , cities: id: 2, name: 北京, parentId: 1, childs: id: 52, name: 北京, parentId: 2, childs: id: 52, name: 北京, parentId: 2 请求状态提示信息档案基础数据过敏药物Id名称家族病基础数据Id名称过往疾病基础数据Id名称酒类基础数据Id名称所有一级科室（含各子科室）科室id科室名父级科室id所有二级科室科室id科室名父级科室id省省id名称父级id市Id名称父级id区Id名称父级id失败code的值不为0的时候，请直接显示msg的值备注3.2.2. 获取某城市内医院列表描述获取城市内医院列表地址/patient/hospitals参数参数名类型必须备注cityId数字Y城市id方法POST响应成功 code: 0, msg: 成功, data: id: 3, name: 人民医院 请求状态提示信息医院id医院名失败code的值不为0的时候，请直接显示msg的值备注3.3. 我的医生3.3.1. 绑定医生描述患者扫描医生二维码，绑定医生为私人医生。地址/patient/doctor/bind参数参数名类型必须备注doctorId数字Y医生idpatientId数字Y患者idunionKey字符串Y密钥firstRecom数字Y记录是否通过此医生关注公众号，0否，1是。根据注册接口返回的old属性判断，old为true，传1；否则传0isOld数字Y是否扫描1.0旧二维码绑定，1：是；0：否方法POST响应成功 code: 0, msg: success, data: patient: patientId：3， nickName: ddsa， canTalk：true , doctor: “doctorId”:12, name: 张三, photo: , authStatus:0 , createAt: 2015-6-21 14:25:00 请求状态提示信息患者id患者昵称是否可聊天（资料全不全）医生id医生名医生头像地址医生认证状态关系创建时间失败code的值不为0的时候，请直接显示msg的值备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.3.2. 我的医生-修改2.0描述获取我的医生列表，包括私人医生和关注医生地址/patient/doctor/my参数参数名类型必须备注patientId数字Y患者idtype数字N医生类型 0：私人医生；1：关注医生。默认为0page数字N页码，默认为1num数字N每页数量。默认为10unionKey字符串Y密钥方法POST响应成功 code: 0, msg: success, data: pageNo: 1, pageSize: 1, orderBy: null, order: null, result: doctorId: 1, name: 张三, authStatus: 0, photo: http:/i.7o/doc/1.jpg, department: 儿科, hospital: 人民医院, consultCost:4500, balanceDiscount:4500, realPay:0, noPayNum:1 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 请求状态提示信息结果总数总页数排序字段顺序asc:升序 desc:降序结果列表医生id医生名称医生认证状态头像科室医院图文咨询费用，单位：分余额抵扣，单位：分实付金额，单位：分未支付账单数结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码是否有上一页上一页页码失败code的值不为0的时候，请直接显示msg的值备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.3.3. 关注医生描述关注某个医生成为其粉丝地址/patient/doctor/attend参数参数名类型必须备注doctorId数字Y医生idpatientId数字Y患者idunionKey字符串Y密钥方法POST响应成功 code: 0, msg: success,data: “fansNum”:3, “relation”:1 粉丝数关系（1：私人医生；2：关注；-1：没关系）失败code的值不为0的时候，请直接显示msg的值备注3.3.4. 取消关注描述取消对某个医生的关注地址/patient/doctor/cancel参数参数名类型必须备注doctorId数字Y医生idpatientId数字Y患者idunionKey字符串Y密钥方法POST响应成功 code: 0, msg: success,data: “fansNum”:3, “relation”:1 粉丝数关系（1：私人医生；2：关注；-1：没关系）失败code的值不为0的时候，请直接显示msg的值备注3.3.5. 查找医生描述搜索所有医生（医生端用户），可以关注，不可绑定。已关注的可以咨询地址/patient/doctor/find参数参数名类型必须备注keyword字符串N关键字departmentId数字N科室idcityId数字N城市idpatientId数字N患者idunionKey字符串N/Y密钥（有患者id时，必传）page数字N页码，默认1num数字N每页数量，默认10方法POST响应成功 code: 0, msg: success, data: totalCount: 1, totalPages: 1, orderBy: null, order: null, result: doctorId: 1, name: 张三, authStatus:0, photo: /pc/1.jpg, status: 0, department: 1, title: 主治医师, hospital: 人民医院, expertise: 专长 praiseNum:234, relation:0 ， totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 请求状态提示信息总数总页数排序字段顺序asc:升序 desc:降序医生id医生名称医生认证状态头像在线状态0否1是部门职位医院专长好评数与当前用户关系：0无1私人2关注结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码是否有上一页上一页页码失败code的值不为0的时候，请直接显示msg的值备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.3.6. 医生详情-修改2.0描述登录页点击登录获取店铺首页信息(供首页展示使用)地址/patient/doctor/detail参数参数名类型必须备注doctorId数字Y医生id方法GET/POST响应成功 code: 0, msg: success, data: doctorId: 1257439, name: 张三, authStatus:0, photo: /photo/doc/12439.jpg,status: 0, department: 骨科, title: 专家, hospital: 人民医院, expertise: 专长, praiseNum: 234, fansNum: 120,introduction: 简介, consultCost:45, balanceDiscount:45, realPay:,0, noPayNum: onlineTime: 周一 09：00-22：00,周一 09：00-22：00,周一 09：00-22：00 , outlineTime: 周一 上午 晚上 , outlineOn: 广州市中山二路106号, relation: 0 返回状态提示信息医生id医生姓名医生认证状态头像在线状态0否1在部门职称医院专长好评数粉丝数简介图文咨询费用，单位：分余额抵扣，单位：分实付金额，单位：分未支付账单数大白线上时间线下问诊时间门诊地址与当前用户关系：-1无0私人1关注失败code的值不为0的时候备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.4. 我的咨询3.4.1. 我的咨询描述咨询列表地址/patient/doctor/chat/list参数参数名类型必须备注patientIdY患者标识unionKeyY密钥pageN页码，默认1numN每页数量，默认10方法GET/POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: doctorId: 8, doctorName: 周星星,authStatus:0, department: 产科, doctorPhoto: http:/yun.dabai.79359.jpg, patientId: 18, message: type: 1, time: 1438744653080, content: 周星星医生:建议您服用 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息页码每页数量排序字段顺序asc:升序 desc:降序医生id医生姓名医生认证状态科室头像患者id消息类型发送时间文本内容结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码是否有上一页上一页页码失败code的值不为0的时候 备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.4.2. 咨询详情（参见IM接口文档）3.4.3. 评价医生描述对医生的服务进行评价地址/patient/doctor/comment参数参数名类型必须备注patientId数字Y患者idunionKey字符串Y密钥doctorId数字N医生idresult数字N1：好评；2：一般；3：差评方法GET/POST响应成功 code: 0, msg: 成功, data: doctorId: 14, authStatus:0, praiseNum: 1, commentResult: 1 返回状态提示信息医生id医生认证状态好评数评论结果失败code的值不为0的时候 备注医生认证状态（0：未认证，1：已认证，2：认证未通过，3：再次申请认证，4：未提交资料）3.4.4. 我的问诊记录-2.0描述我的问诊记录列表，含问诊收费信息、支付信息等。医生主动发起的、患者主动发起的都有，不含未结束的问诊地址/patient/consult/list参数参数名类型必须备注patientIdY患者标识unionKeyY密钥pageN页码，默认1numN每页数量，默认10方法GET/POST响应成功 code: 0, msg: success, data: pageNo: 1, pageSize: 1, orderBy: null, order: null, result: id: 1, doctor: doctorName: 张三, department: 儿科, authStatus: 0, hospital: 人民医院 , amount: 45, status:未评价, haveRecom: true, needPay:true, havePay: false, haveAppraise: false, startTime:2016-01-09 15:23:00, endTime:2016-01-10 15:23:00 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, pre