大诊-患者端接口

1、云门诊接口文档-患者端版本号：1.2文档： 2015-06-151.0Create创建文档。2015-06-171.1Modify详情返回调整2015-08-051.2Modify同步新版本接口调整目录Change History1目录21. 引言42. 接口规范..协议4地址4公共参数4返回值42. 接口详细说明53.1. 登录流程5 5登录6获取医生简报6获取患者简报73.2.医生8绑定医生8医生8关注医生9取消关注10查找医生11医生详情123.3. 12 12详情（参见IM 接口文档）13评价医生133.4. 个人中心14查看基础信息14提交基础信息15查

2、看个人 15保存个人 17提交意见17获取 184. 附录184.1. 关于异常状态码定义的建议181. 引言本文档用于描述微药店服务接口规范(不涉及用户流程)，主要包括：网络传输协议、数据传输协议,参数及返回值说明等内容。2. 接口规范1.1. 协议接口基于HTTP 协议，支持GET/T 请求，以JSON 格式返回数据。1.2. 地址接口地址为(开发)：mon/order/order.jsp接口地址为(正式)：http:1.3. 公共参数1.4. 返回值返回值的基本结构如下：code:, msg:, data:,参数名参数含义必选取值_pY0：wx 1：andorid 2：_v客户端版本号Y

3、格式：例如：1.0.0_m设备的mac 地址Y_cJSONP 的回调函数名N说明：如上参数为公共参数，请在Http Header 中传递返回值结构描述2. 接口详细说明3.1. 登录流程描述患者用户(独立服务，不含医生绑定操作)地址/patient/regist参数参数名类型必须备注dataJsonY用户账户信息方法T响应成功code: 0,msg: sucs, data: patientId: 215315, unionKey: ， qlkId ：22232 ，请求状态提示信息患者id患者用户签名七乐康用户id属性含义取值code本次请求状态码0：表示成功；其他数字表示异常。msg状态码对应

4、的信息状态码对应的提示信息。data业务相关数据JSON 数组。不同接口返回的JSON 数据对象data 举例：subscribe: 1,openid: o6_bmjrPTlm6_2sgVt7hMZOPfL2M,nickname: Band,sex: 1,language: ,city: 广州,province: ,country: 中国,headimgurl:,subscribe_time: 1382694957,unionid: o6_bmasdasdsad6_2sgVt7hMZOPfLremark: ,grou: 0登录描述患者登录，获取患者用户信息以及七乐康 b2c 用户信息。地址/p

5、atient/loginold：true， haveal:true是否老用户是否有私人医生失败code 的值不为 0 的时候，请直接显示msg 的值备注获取医生简报描述获取医生简报信息地址/patient/doctor/simple参数参数名类型必须备注doctorId数字Y患者 id方法GET/T响应成功code: 0, msg: 成功,请求状态提示信息参数参数名类型必须备注openId字符串Y用户openId方法GET/T响应成功code: 0,msg: sucs, data: patientId: 215315, unionKey: ， qlkId ：22232 ，请求状态提示信息医生i

6、d患者用户签名七乐康用户id失败code 的值不为 0 的时候，请直接显示msg 的值备注获取患者简报描述获取患者简报信息地址/patient/simple参数参数名类型必须备注patientId数字Y患者 id方法GET/T响应成功code: 0, msg: 成功, data: patientId: 10,name: 乐得福 3,openId: o6_bmjrPZOPfL2M,photo: h/mmofHe/0,请求状态提示信息患者id患者名 openId头像密钥data: doctorId: 15, name: ,photo: 患者id医生名头像失败code 的值不为 0 的时候，请直接显

7、示msg 的值备注3.2.医生绑定医生描述患者扫描医生，绑定医生为私人医生。地址/patient/doctor/bind参数参数名类型必须备注doctorId数字Y医生 idpatientId数字Y患者 idunionKey字符串Y密钥数字Y是否通过此医生号，0 否，1 是。根据接口返回的old 属性判断，old 为true，传 1；否则传 0isOld数字Y是否扫描 1.0 旧绑定，1：是；0：否方法T响应成功code: 0,请求状态unionKey: Serwkfjrewkjvlwe3483ddf,“canTalk”:true， “alNum”:2,“qlkId”：“3241234”,“d

8、efaur”:12资料是否全 私人医生数量七乐康用户id只一个私人医生时医生id失败code 的值不为 0 的时候，请直接显示msg 的值备注医生描述获取医生列表，包括私人医生和关注医生地址/patient/doctor/my参数参数名类型必须备注patientId数字Y患者 idtype数字N医生类型 0：私人医生；1：关注医生。默认为 0msg: sucs, data: patient: patientId：3， nickName: ddsa， canTalk：true,doctor: “doctorId”:12, name: ,photo: ,createAt: 2015-6-21 14

9、:25:00提示信息患者id患者昵称是否可聊天（资料全不全）医生id医生名医生头像地址关系创建时间失败code 的值不为 0 的时候，请直接显示msg 的值备注page数字N页码，默认为 1num数字N每页数量。默认为 10unionKey字符串Y密钥方法T响应成功code: 0,msg: sucs, data: totalCount: 1,totalPages: 1, orderBy: null, order: null,result: doctorId: 1, name: ,photo: ,sus: 0,department: 儿科,title: 主治医师,hospital: 人民医院,e

10、xpertise: 专长 praiseNum：23， commentResult:0，请求状态提示信息结果总数总页数 排序字段顺序asc:升序 desc:降序结果列表医生id 医生名称头像状态 0 否 1 在科室职位 医院 专长 好评数当天评论结果1 好评 2 一般 3 差关注医生描述关注某个医生成为其粉丝地址/patient/doctor/attend参数参数名类型必须备注doctorId数字Y医生 idpatientId数字Y患者 idunionKey字符串Y密钥方法T响应成功code: 0,totalCount: 2,: 0,orderBySetted: false, totalPage

11、s: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1空为当天没有评价结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码 是否有上一页上一页页码失败code 的值不为 0 的时候，请直接显示msg 的值备注取消关注描述取消对某个医生的关注地址/patient/doctor/cancel参数参数名类型必须备注doctorId数字Y医生 idpatientId数字Y患者 idunionKey字符串Y密钥方法T响应成功code: 0,msg: sucs, data: “fansNum”:3,粉丝数关系（1

12、：私人医生；2：关注；-1：没关系）msg: sucs, data: “fansNum”:3, “relation”:1粉丝数关系（1：私人医生；2：关注；-1：没关系）失败code 的值不为 0 的时候，请直接显示msg 的值备注查找医生描述搜索所有医生（医生端用户），可以关注，不可绑定。已关注的可以地址/patient/doctor/find参数参数名类型必须备注keyword字符串关键字departmentId数字N科室 idcityId数字N城市 idpatientId数字N患者 idunionKey字符串N密钥（有患者 id 时，必传）page数字N页码，默认 1num数字N每页数量

13、，默认 10方法T响应成功code: 0,msg: sucs, data: totalCount: 1,totalPages: 1,请求状态提示信息总数 总页数“relation”:1失败code 的值不为 0 的时候，请直接显示msg 的值备注orderBy: null, order: null,result: doctorId: 1, name: ,photo: /pc/1.jpg,sus: 0,department: 1, title: 主治医师,hospital: 人民医院,expertise: 专长 praiseNum:234, relation:0， totalCount: 2,:

14、 0,orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1排序字段顺序asc:升序 desc:降序医生id 医生名称头像状态 0 否 1 是部门职位 医院 专长 好评数与当前用户关系：0 无 1 私人 2 关注结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码 是否有上一页上一页页码医生详情描述登录页点击登录获取首页信息(供首页展示使用)地址/patient/doctor/detail参数参数名类型必须备注doctorId数字Y医生 i

15、d方法GET/T响应成功code: 0,msg: sucs, data: doctorId: 1257439, doctorName: ,photo: /photo/doc/1257439.jpg, sus: 0,department: 骨科,title: ,hospital: 人民医院,expertise: 专长, praiseNum: 234,fansNum: 120,roduction: 简介, onlineTime: 周一 9 点12 点,返回状态提示信息医生id医生 头像状态 0 否 1 在部门医院 专长 好评数粉丝数简介大白线上时间失败code 的值不为 0 的时候，请直接显示ms

16、g 的值备注3.3.描述列表地址/patient/doctor/chist参数参数名类型必须备注patientIdY患者标识unionKeyY密钥pageN页码，默认 1numN每页数量，默认 10方法GET/T响应成功code: 0, msg: 成功, data: pageNo: 1,pageSize: 10,返回状态提示信息页码每页数量outlineTime: 周一、四下午，周三上午, outlineOn: 广州市中山二路 106 号, relation:0线下问诊时间门诊地址与当前用户关系：0 无 1 私人 2 关注失败code 的值不为 0 的时候备注orderBy: null, or

17、der: null,result: doctorId: 8, doctorName: ,department: 产科,doctorPhoto: ,patientId: 18, message: type: 1,time: 1438744653080,content: 医生:建议您服用,totalCount: 2,: 0,orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1排序字段顺序asc:升序 desc:降序医生id医生 科室 头像 患者id消息 类型发送时间文本

18、内容结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码 是否有上一页上一页页码失败code 的值不为 0 的时候详情（参见 IM 接口文档）评价医生描述对医生的服务进行评价地址/ment参数参数名类型必须备注patientId数字Y患者 idunionKey字符串Y密钥doctorId数字N医生 idresult数字N1：好评；2：一般；3：差评方法GET/T响应成功code: 0, msg: 成功, data: doctorId: 14,praiseNum: 1,commentResult: 1返回状态提示信息医生id 好评数 评论结果失败code 的值不为 0

19、 的时候备注备注3.4. 个人中心查看基础信息描述患者个人基本资料信息地址/patient/base参数参数名类型必须备注patientId数字Y患者 idunionKey字符串Y加密串方法GET/T响应成功code: 0,msg: sucs, data: “patientId”：8382， name: ,photo: /2.jpg,gender: 女, age: 65,cityId:3,city：“”，phone:123245647675返回状态提示信息患者id头像城市id城市名失败code 的值不为 0 的时候，请直接显示msg 的值备注提交基础信息描述保存对基础信息的编辑地址/patie

20、nt/save参数参数名类型必须备注patientId数字Y患者 idunionKey字符串Y密钥actionType数字Y针对号，0：新增，1：修改name字符串Ngender字符串Nage字符串NcityId字符串N城市 idphone字符串Ncode字符串N，在有号码是必传方法T响应成功code: 0,msg: sucs, data: “patientId”：8382， name: ,photo: /2.jpg,gender: 女, age: 65,cityId:3,city：“”，phone:123245647675返回状态提示信息患者id头像城市id城市名查看个人描述查看病例地址/p

21、atient/get参数参数名类型必须备注patientId数字Y患者 idunionKey字符串Y密钥方法T响应成功code: 0, msg: 成功, data: height: 163,weight: 55,maritalSus: 0, medicAllergys: sus: 1,defaultSelect: 磺胺，青霉素, others: 某药,defaultNames: 磺胺，青霉素，某药返回状态提示信息身高体重状况 0 未婚；1 已婚药物过敏史，null 表示请选择状态：0 无；1 有选中的默认药物，逗号分隔其他（手动输入内容）全部过敏药物信息失败code 的值不为 0 的时候，请直

22、接显示msg 的值备注,pastDiseases: sus: 1,defaultSelect: 冠心病，, others: 某病,defaultNames: 冠心病，某病,familyDiseases: member: 2,disease: defaultSelect: 冠心病，,others: 某病, defaultNames: 冠心病，某病,hereditaryDiseases: sus: 1, defaultSelect: ,others: 哈哈,过往病史，null 表示没请选择状态：0：无；1 有选中的默认疾病，逗号分隔其他疾病（手动输入内容）全部过往疾病病史（数组），null 表示请

23、选择数组大小为 0，表示无成员：0 父亲 1 母亲 2 兄妹 3选中的默认疾病，逗号分隔其他疾病（手动输入内容）全部疾病信息遗传病，null 表示请选择状态：0 无；1 有选中的默认疾病（没有默认遗传病）其他疾病（手动输入）defaultNames: 哈哈,smoke: perdayNum: 1,smokeStart: 18,sus: 1,drink: frequency: 1,perdayNum: 1,drinkStart: 18, “drinkSus”:0, stopAge: , wines: defaultSelect: 啤酒,红酒, others: , defaultNames: 啤酒

24、,红酒全部疾病信息吸烟，null 表示请选择吸烟量开始吸烟现状态：0 已戒烟 1 吸烟 2不吸烟饮酒，null 表示请选择频率 0：从不；1：偶尔；2；经常；3：每天饮酒量饮酒开始饮酒状态：0 未戒酒 1 已戒酒戒酒饮酒类型选中的默认酒类，逗号分隔其他酒类（手动输入）全部酒信息失败code 的值不为 0 的时候，请直接显示msg 的值备注保存个人提交意见描述用户意见地址/patient/doctor/suggest参数参数名类型必须备注patientId数字Y患者 idunionKey字符串Y密钥suggestion字符串Y意见内容方法T响应成功code: ，msg: sucs,返回状态提示信

25、息描述保存个人相关编辑地址/patient/save参数参数名类型必须备注patientId数字Y患者 iddataJsonY编辑数据。格式参照个人接口返回data方法T响应成功code: ，msg: sucs,data: 返回状态提示信息失败code 的值不为 0 的时候，请直接显示msg 的值备注获取3.5.病例列表（患者端）描述患者列表地址/patient/case/list描述用户在或忘记时需要发送进行认证，调此接口进行下发(注：发送失败情况可能存在示例情况：今日发送量已达上限/运营商业务繁忙 等)。地址/sms/send参数参数名类型必须备注phoneNumY用户输入号码action

26、TypeY0:资料完善，新增号；1：修改号方法T响应成功data: ,msg: sucs, code: 0消息提示：sucs；(示例：发送失败/)结果码：0/发送成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候，请直接显示msg 的值备注data: 失败code 的值不为 0 的时候，请直接显示msg 的值备注参数参数名类型必须备注patientIdY患者标识unionKeyY密钥pageN页码，默认 1numN每页数量，默认 10方法GET/T响应成功code: 0, msg: 成功, data: pageNo: 1,pageSize: 10, orderBy: null,

27、 order: null,result: caseId: ekjwalf, hospitalId: 2,hospital: 省人民医院, departmentId:3, department: 产科, vistingTime: 2015-07-17, discription: 病情描述, imgs: ,返回状态提示信息页码每页数量排序字段顺序asc:升序 desc:降序病例id医院id医院名科室id科室问诊时间描述列表（上传，最多 4）地址病例详情（患者端）描述病例详情地址/patient/case/detail参数参数名类型必须备注patientIdY患者标识unionKeyY密钥caseI

28、dY病例 id,totalCount: 2,: 0,orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1结果总数返回第一条在总结果集中位置是否已设置排序字段总页数是否有下一页下一页页码 是否有上一页上一页页码失败code 的值不为 0 的时候备注方法GET/T响应成功code: 0, msg: 成功, data: caseId: skdjskfjs, hospitalId: 4,hospital: 省人民医院, departmentId: 2, department

29、: 产科,doctor: , vistingTime: 2015-07-17, discription: 病情描述, adviceList: uploadTime: 326732832,imgUrl: ht/79359.jpg,prescriptionList: uploadTime: 326732832,imgUrl: ht/79359.jpg,checkList: 返回状态提示信息医生id 医院id 医院名称科室id 科室医生问诊时间病情描述上传时间地址上传时间地址保存病例描述保存病例编辑地址/patient/case/save参数参数名类型必须备注patientIdY患者标识unionK

30、eyY密钥dataY病例信息，参见详情接口返回中的data，其中 caseId为空表示新增病例，否则为修改。方法GET/T响应成功code: 0, msg: 成功, data: caseId: mmddsajkd, hospitalId：3，返回状态提示信息医生id医院id医院名称uploadTime: 326732832,imgUrl: ht/79359.jpg上传时间地址失败code 的值不为 0 的时候备注hospital: 省人民医院, departmentId：1， department: 产科,doctor: , vistingTime: 2015-07-17, discripti

31、on: 病情描述, adviceList: imgUrl: ht/79359.jpg,prescriptionList: imgUrl: ht/79359.jpg,checkList: imgUrl: ht/79359.jpg科室id科室 医生问诊时间病情描述地址地址地址失败code 的值不为 0 的时候备注删除病例获取最近扫描医生信息描述获取最近扫描绑定的医生信息地址/patient/doctor/new参数参数名类型必须备注patientIdY患者标识unionKeyY密钥方法GET/T响应成功描述删除病例地址/patient/case/delete参数参数名类型必须备注patientId

32、Y患者标识unionKeyY密钥caseIdYid方法GET/T响应成功code: 0, msg: 成功, data: 返回状态提示信息失败code 的值不为 0 的时候备注3.6.cms 相关病例列表（cms）描述患者列表地址cms/patient/case/list参数参数名类型必须备注patientIdY患者标识pageN页码，默认 1numN每页数量，默认 10方法GET/Tcode: 0, msg: 成功, data: hospitalId:9,hospital: 省人民医院, departmentId:4, department: 产科,doctor: 返回状态提示信息医院id医院名科室id科室 医生名失败code 的值不为 0 的时