08全民健康保障信息化工程

全民健康保障信息化工程集成规范（用户）二o九年二月目录1. 概述 111.文档目的1读者对象13术语与缩写解释12. 用户信息同步规范 2Z1. 目标2ZZ 集成介绍2二1集成效果2丄集成要求2H集成分工32 3接口说明3接口协议说明3丄“接口方法列表3二接口设计4丄丄丨SchemaService 接口4丄丄UserCreateService接口64UserUpdateService接口8.UUserDeleteService接口92 5集成步骤10:集成流程图10数据供应11一联调测试11I上线113. 附表 123 1用户信息123. 2.机构信息3. 3.职务信息3. 4.性别信息3.5.代码示例.12.1920201. 概述1.1.文档目的本文档描述了与统一用户管理系统用户集成的方式，用户信息同步的流程式和关键步骤，旨在为集成人员、应用开发人员提供快速实施指引。1. 2.读者对象本文档的阅读对象为需要与统一用户管理系统集成的集成人员、应用开发人员。1.3.术语与缩写解释缩写、术语解释RESTful一种软件架构风格、设计风格，提供了一组设计原则和约束条 件。它主要用于客户端和服务器交互类的软件。基于这个风格 设计的软件可以更简洁，更有层次，更易于实现缓存等机制。OAuthOAUTH协议为用户资源的授权提供了一个安全的、开放而又简 易的标准。与以往的授权方式不冋之处是OAUTH的授权不会使 第三方触及到用户的帐号信息（如用户名与密码），即第三方无 需使用用户的用户名与密码就可以申请获得该用户资源的授 权，因此OAUTH是安全的。BIM身份管控系统，主要对各类型用户身份进行管控，冋时管控用 户的账号所有权以及应用访问权限。2. 用户信息同步规范Z 1.目标本章节详细描述了应用系统与统一用户管理系统使用推送数据的方式的说 明和流程，目的在于明确集成流程，使阅读本文档的相关干系人对于各自的职责 和工作内容有一个比较清晰与明确的认识，使得集成工作能够顺利、有效的开展。才才集成介绍111.集成效果通过统一标准的接口服务以及连接器，实现统一用户管理系统对应用系统账 号的新增、修改、删除的管理。应用系统依据标准的接口服务开发数据同步接口服务，统一身份管理平台使用标准统一的连接器实现实时数据同步功能。集成要求应用系统需要依据接口标准文档开发账号同步的接口服务。其中基础功能需 要实现账号新增、修改、删除功能。应用系统中账号除了由统一用户管理系统推送的属性，可能存在应用系统自 身维护的属性。应用系统管理员只能对自身维护的属性进行修改，而不能对统一 用户管理系统推送的属性自行维护。应用系统账号的密码应由统一用户管理系统统一管理，包括密码的生成和修 改。统一用户管理系统提供统一的自服务来进行密码修改操作，当用户进行密码 修改操作时，会把该用户所有的应用系统账号的密码统一进行修改。I?:集成分工统一用户管理系统：提供标准接口服务文档；联调测试；应用系统：完成标准数据同步的接口开发；提供应用系统基本信息：系统远程接口地址（必须能访问的地址），接口调用账号，调用密码（账号密码在接口同步时做校验用）提供应用系统账号创建时需要的属性；2. 3.接口说明彳接口协议说明应用接口服务器端与统一身份管理平台客户端采用HTTP协议通信，RESTful 接口。口丄接口方法列表接口名描述接口地址SchemaService对象属性字段查询http:/host:port/./SchemaServiceUserCreateService账号创建http:/host:port/UserCreateServiceUserUpdateService账号修改http:/host:port/UserUpdateServiceUserDeleteService账号删除http:/host:port/./UserDeleteService接口接收请求方式为http post方式，接收和返回报文为json格式。接口地址后端的方法名需要按照上面表格定义实现。2, 4.接口设计2,4.1.SchemaService 接口功能说明SchemaService的功能是获取第三方目标系统中“账号等对象全部属性信 息，包括属性名称、类型、是否必填字段、是否多值。用以建立起BIM平台用户 字段和三方目标系统账号字段的映射关系。集成的三方目标系统必须要实现此接 口。BIM 请求报文说明1）报文示例：bimRequestId: 9e928d12ec8a4c1bb75283b8df71308d,bimRemotePwd: password,bimRemoteUser: BIMadmin2）报文字段说明： bimRequestld : BIM每次调用生成的随机ID，应用系统每次响应返 回此ID， St ring类型。 bimRemoteUser : BIM调用三方应用接口的授权账号，由应用分配给 BIM系统，St ring类型。 bimRemotePwd : BIM调用三方应用接口的密码，由应用分配给BIM系统，St ring类型。响应报文说明1）报文示例：bimRequestId: 9e928d12ec8a4c1bb75283b8df71308d, account: multivalued: false,name: loginName,required: true,丄c丄*type: String, multivalued: false,T 1 name: orgId,required: true,丄C丄*type: String, multivalued: false,name: fullName,required: true,丄C丄*type: String,2）报文字段说明： bimReques tld :BIM每次调用接口发送的请求ID，字段为St ring类 型。 account :此接口定义的对象类型，可选值为account （账号）。字段为数组类型。 name :定义对象的属性字段名称。字段为St ring类型。 t ype ：定义对象的属性字段类型，可选值为St ring、int、double、 floa t、long、byte、boolean。字段为 St ring 类型。 required :定义对象的属性字段在创建时是否为必填字段。可选值 true或者false。字段为boolean类型。 multivalued :定义对象的属性字段是否为多值。可选值true或者 false。字段为boolean类型。账号所需字段参考用户信息附表3.1。2,4.2. UserCreateService 接口功能说明UserCreateService接口是应用系统的账号创建方法。BIM 请求报文说明1) 报文示例：bimRequestId: 11928d12ec8a4c1bb75283b8df71308d, bimRemoteUser: BIMadmin,bimRemotePwd: password,loginName: zhangsan,orgId: D01-0110-0110654,fullName: 张三2) 报文字段说明： bimRequestld/bimRemotePwd/bimRemoteUser :BIM 接口调用的必传字段, 说明见 SchemaService。 loginName/ orgId/ fullName : 三方应用系统 SchemaService 接口中定 义的账号字段属性。响应报文说明1) 报文示例:成功:bimRequestId: 11928d12ec8a4c1bb75283b8df71308d,uid: 89746776,resultCode: 0, message: success失败:bimRequestId: 11928d12ec8a4c1bb75283b8df71308d,resultCode: 500,message: 字段不全，账号创建失败2) 报文字段说明: uid :应用系统账号创建后，形成的全局唯一 ID,此ID不能被修改， 建议为数据库表主键。此ID返回至BIM系统，此后账号的修改和删除都以此ID 为主键。字段为St ring类型，必传字段。 resultCode :接口调用处理的结果码，0为正常处理，其它值由应用系 统定义。字段为St ring类型，必传字段。 message :接口调用处理的信息。字段为St ring类型。 bimReques tld :BIM每次调用接口发送的请求ID，字段为St ring类型， 必传字段。2,4 : UserUpdateService 接口功能说明UserUpdateService接口是应用系统的账号修改方法。BIM 请求报文说明1）报文示例：bimRequestId: 22928d12ec8a4c1bb75283b8df71308d,bimRemoteUser: BIMadmin,bimRemotePwd: password,bimUid: 89746776,/ -1 NT =loginName: lisi,fullName: 李四2）报文字段说明： bimRequestId/bimRemotePwd/bimRemoteUser :BIM 接口调用的必传字段, 说明见 SchemaService。 bimUid :三方应用系统账号创建时，返回给BIM应用系统的账号主键 uid。必传字段。 loginName/ fullName :需要修改的账号字段属性。响应报文说明1）报文示例:bimRequestId: 22928d12ec8a4c1bb75283b8df71308d, resultCode: 0, message: success2）报文字段说明： resultCode :接口调用处理的结果码，0为正常处理，其它值由应用系 统定义。字段为St ring类型，必传字段。 message :接口调用处理的信息。字段为St ring类型。 bimReques tld :BIM每次调用接口发送的请求ID，字段为St ring类型, 必传字段。2 4.4. UserDeleteService 接口功能说明UserDeleteService接口是应用系统的账号删除方法。BIM 请求报文说明1）报文示例:bimRequestId: 33928d12ec8a4c1bb75283b8df71308d,bimRemoteUser: BIMadmin,bimRemotePwd: password,bimUid: 897467762）报文字段说明: bimRequestId/bimRemotePwd/bimRemoteUser :BIM 接口调用的必传字段，说明见SchemaService。 bimUid :三方应用系统账号创建时，返回给BIM应用系统的账号主 键uid。必传字段。响应报文说明1）报文示例：bimRequestId: 33928d12ec8a4c1bb75283b8df71308d, resultCode: 0, message: success 2）报文字段说明： resultCode :接口调用处理的结果码，0为正常处理，其它值由应用系 统定义。字段为St ring类型，必传字段。 message :接口调用处理的信息。字段为St ring类型。 bimReques tld :BIM每次调用接口发送的请求ID，字段为St ring类型, 必传字段。2. 5.集成步骤、丨.集成流程图下图为推送集成流程图，描述了应用系统和统一用户管理系统认证集成工作 中双方的主要任务和流程。数据供应BIM 通过内置 connector 请求下游集成应用系统的 API 接口服务，请求调用接口定义的接口方法。下游集成应用在UserCreateService 、UserUpdateService 、UserDeleteService 方法体内实现对本应用系统账号数据的增、改、删操作。联调测试集成应用系统与统一用户管理系统共同完成相关的集成测试工作，在功能和 业务上满足相关要求。上线集成应用系统与统一用户管理系统共同完成相关的集成内容的上线。3. 附表3. 1.用户信息属性代码属性描述备注orga niza tionld所属机构代码必填，代码参考3.2orga niza tionN ame所属机构名称路径必填，如：/卫健委/计生协会/log inN ame用户名必填，唯一主键fullName姓名必填，IDCard身份证号mobile手机sex性别代码参考附表3.4email邮箱post职务代码参考附表3.3birthday出生日期3一 2.机构信息机构代码机构名称01卫健委02公安部03发改委04人社部05市场监督总局0101办公厅0102人事司0103规化司0104财务司0105法规司0106体改司0107疾控局0108医政医管局0109基层司0110应急办0111科教司0112监督局0113药政司0114食品司0115老龄司0116妇幼司0117职健司0118人口家庭司0119宣传司0120国际司0121保健局0122机关党委0123离退局0124医科院0125疾控中心0126监管中心0127药具管理中心0128机关服务局（中心）0129食品评估中心0130北京医院0131北京协和医院0132中日医院0133科研所0134健康教育中心0135宣教中心0136统计信息中心0137干部培训中心（党校）0138卫生发展中心0139人发中心0140项目监管中心0141医管中心0142医学考试中心0143医院研究所0144国际交流中心0145人才中心0146继续教育中心0147科技发展中心0148心血管中心0149癌症中心0150职业卫生中心0151人口文化中心0152流动人口中心0153南京培训中心0154家庭保健中心0155计生协会0156医学会0157预防医学会0158人口基金会0159人口学会0160健康报社0161人口报社0162人卫社0163人口初版社010101委主任办公室010102综合处010103研究室010104督杳室010105文档处010106政务信息处010107秘书联络处010108信访处010109保密安全处010201综合处010202干部处010203监督教育处010204专业人才管理处010205劳动工资处010301综合处010302发展规划处010303建设装备处010304大数据办公室010305爱卫工作办010401扶贫处010402经济管理处010403预算管理处010404资产装备处010405审计评价处010406机关财务处010407会记核算中心010501综合与标准处010502立法处010503法制审核处010504行政复议处010601综合协调处010602政策研究处010603督导评价处010604公立医院改革处010701综合处010702监测与评价处010703传染病防控处010704免疫规划处010705艾滋病防控处010706结核病防控处010707寄生虫病与地方病防控处010708慢性病与营养管理处010709精神卫生处010710环境健康处010801综合处010802医疗资源处010803医疗机构处010804医疗管理处010805医疗质量与评价处010806医疗安全与血液处010807护理与康复处010808行风建设处010809公共卫生医疗管理处010901综合处010902运行评价处010903家庭医生处010904基本公共卫生处011001综合协调处011002监测预警处011003应急指导处011004应急处理处011005平台办011101综合处011102重大专项处011103规划评估处011104生物安全处011105医学教育处011201综合处011202督查处011203公共卫牛监督处011204公共卫生监督二处011205传染病防治监督处011206医疗监督处011301综合处011302药物政策处011303药品目录管理处011304药品供应保障协调处011305药品使用管理处011401综合处011402安全标准管理处011403风险监测与评估处011404食品营养处011501综合协调处011502健康服务处011503医养结合处011601综合处011602妇女卫生处011603儿童卫牛处011604出生缺陷防治处011701综合处011702预防处011703技术服务管理处011704职业病管理处011801综合处011802政策协调处011803监测评估处011804家庭发展指导处011901综合处011902新闻网络处011903宣传处011904健康促进处012001综合处012002国际组织处012003欧美处012004亚太处012005非洲处012006港澳台处012101综合处012102保健一处012103保健二处012104预防处012105财务处012201办公室012202纪委办公室012203组织处012204群工处012301综合处012302组织处012303生活处012304健康处012305服务处013601统计处013602调查评价处013603信息技术处013604信息标准处013605电子政务处013606基层信息化与健康卡管理处013607药物信息管理处013608健康医疗大数据办公室3. 3.职务信息职务代码职务名称01国家级正职02国家级副职03省部级正职04省部级副职05厅局级正职06厅局级副职07县处级正职08县处级副职09乡科级正职10乡科级副职11巡视员12副巡视员13调研员14副调研员15主任科员16副主任科员17科员18办事员3. 4.性别信息代码名称0未知的性别1男性2女性9未说明的性别3. 5代码示例restful-server-demo 文件夹提供了数据同步集成的代码示例。示例代码采 用 JAVA 语言，其他开发语言根据开发环境进行具体操作，该目录代码可以直接 导入 Eclipse 查看或者直接打开 java 文件查看。