医院信息平台-业务系统接口规范V2.0.docx

医院信息平台接口规范新奥博为技术有限公司2015-04更改页序号版本号更改内容描述更改人更改日期12.0.0创建文档，定义WS交互点，基础字典同步下载接口李长松2015-04-2122.0.1平台服务部分接口请求参数结构中添加服务版本参数李长松2015-05-1332.0.2添加A00、A02、A03、A04部分交换服务说明李长松、李峥、王立新2015-05-1942.0.3添加消息发布HTTP接口方式，修改A0000参数结构，添加了SERVICE_TYPE参数李长松2015-06-2552.0.4添加C2406，C2407，C2408及物资申领信息发布服务接口说明李长松2015-07-01表单流程：项目负责人编制 立项部门审核 上一级部门批准 研发中心存档本表单为一份，由研发中心留存目 录1文档说明42引用标准43接口方式43.1WS消息方式53.2业务协同与数据交换流程63.3安全访问机制74平台服务接口74.1获取令牌服务接口74.1.1接口说明74.1.2场景说明84.1.3调用地址84.1.4WS接口定义84.2消息发布服务接口104.2.1接口说明104.2.2场景说明104.2.3调用地址114.2.4WS接口定义114.3业务交换服务接口124.3.1接口说明124.3.2场景说明134.3.3调用地址134.3.4WS接口定义135业务交换服务155.1业务交互服务概述155.2基础交换服务（A）155.2.1消息订阅服务（A00）155.2.2患者服务（A01）175.2.3医疗卫生人员服务（A02）175.2.4医疗卫生机构（科室）服务（A03）335.2.5术语和字典服务（A04）385.3临床业务交换服务（B）385.4医院管理交换服务（C）386服务异常编码381 文档说明本文档定义了医院信息平台（后续简称平台）和院内业务系统（HIS、LIS、PACS、EMR）的接口方式、接口规范。2 引用标准 基于电子病历的医院信息平台建设技术解决方案（1.0 版）2011-03； 河南省数字化医院建设指南（2014版）2014-05； 电子病历基本架构与数据标准（试行)，2009-12； 基于电子病历的医院信息平台技术规范，2014-10-01 电子病历基本数据集，2014-5-30； 河南省基于健康档案的卫生信息平台接口库说明（医疗服务V1.7.1)试行 河南省基于健康档案的卫生信息平台接口库说明（卫生资源V1.0.1)试行3 接口方式医院信息集成平台业务协同与数据交换采用SOA架构设计，需要ESB企业总线支持实现医院业务系统业务协同和数据的交换。数据交换总线功能主要包括：SOA支持，遵循SOA设计原则和技术标准，提供松耦合模式，实现业务逻辑和应用逻辑、数据逻辑等分离； 智能路由支持，采用灵活的消息路由方式，支持基于消息内容的处理和路由； XML支持，支持标准XML数据的格式转换，可以通过图形化映射组件、XSLT、客户化Java程序等多种方式实现转换功能； 消息发布/订阅功能，支持队列和主题两种订阅模式；3.1 WS消息方式Web service是一个跨语言的，松耦合、平台独立的、基于可编程的web的应用程序，可使用开放的XML标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的互操作的应用程序。医院信息平台定义的WS消息交换接口满足SOAP 1.1 SOAP 1.2、WSDL1.1 WSDL2.0标准规范。WS接口定义说明性描述主要由以下几部分组成： 接口说明：定义和说明接口的作用和适用范围 场景说明：定义和描述WS服务接口的调用和使用场景、说明业务处理流程； 服务地址：描述WS服务的调用URL地址； 请求数据结构：定义和描述WS服务的请求数据结构和参数说明； 响应数据结构：定义和描述WS服务的响应数据结构和参数说明； 3.2 业务协同与数据交换流程说明：1、 业务系统A（入LIS）订阅相关业务消息，医院信息平台接收消息订阅，并存储订阅信息；2、 业务系统B（如HIS）处理业务过程中生成业务关键数据（如医生工作站生成实验室化验申请单），然后业务系统B生成业务关键数据后，把业务关键数据调用医院信息平台相关接口发送到医院信息平台。3、 医院信息平台接收业务系统B发送的关键业务数据（实验室化验单申请），将数据存储入医院信息平台数据中心，同时将新增或更新业务关键数据的信息生成消息（实验室化验申请单消息）通知推送给已经订阅了相关内容消息的业务系统A(如LIS)4、 业务系统A（LIS）接收通知消息，消息内容中包括消息关联业务数据ID（实验室化验申请单ID）、消息类型（实验室化验申请单类型消息）、获取业务数据所需要的服务接口地址、获取业务数据所需要的服务编码（实验室化验申请单查询服务编码）；5、 业务系统A（LIS）根据消息内容调用消息中包含的服务接口地址，调用相关接口服务（实验室化验申请单查询服务）获取指定ID业务数据；6、 医院信息平台根据业务系统A（LIS）传递的服务编码和业务数据ID，从医院信息平台数据中心获取指定数据；7、 医院信息平台将查询到的业务数据封装为标准接口数据结构（XML）结构数据，返回业务系统A（LIS）；8、 业务系统A（LIS）获取指定业务数据后进行后续业务处理。3.3 安全访问机制满足数字化医院信息安全要求，建立健全的信息安全保障体系是保障院内系统安全的基础。可靠有效的安全访问机制，是保证医院信息平台接口库和各业务系统WS服务的安全，通过身份验证防止非法用户、匿名用户和恶意用户的非法访问。WS接口方式安全访问机制依赖医院信息平台的令牌动态口令算法，平台定义令牌加密算法，每次产生的令牌在设置时间内是有效的，超过令牌的有效期这个令牌就失效了，必须重新产生一个令牌。4 平台服务接口4.1 获取令牌服务接口4.1.1 接口说明医院信息平台在每次调用接口时需要带上accessToken参数，accessToken参数由systemCode和systemPassword换取。systemCode是第三方系统编码，每个第三方应用系统拥有一个唯一的systemCode，systemPassword是系统凭证密码。医院信息平台系统管理员可以通过管理端的权限分配给第三方系统一个唯一的systemPassword。当第三方系统调用医院信息平台接口时，医院信息平台会根据此次访问的accessToken，校验访问的合法权限以返回相应的结果。accessToken令牌有时效性，医院信息平台默认设置为7200秒，平台管理员可以通过系统参数修改时效参数。如果第三方系统调用本接口时accessToken未过期，医院信息平台会自动延长accessToken到期时间。如果调用本接口时accessToken过期，则医院信息平台会生成新的accessToken令牌并返回。4.1.2 场景说明第三方系统调用医院信息平台业务交换服务接口前，先需要通过本接口获取accessToken，然后使用accessToken再调用平台其他业务服务接口。4.1.3 调用地址http:/ip:port/hipService/GetTokenPort4.1.4 WS接口定义 WSDL文档：参数说明请求参数（GetTokenRequest）：参数数据类型是否必须说明requestId字符串是UUIDrequestIP字符串是第三方系统所在服务器的IP地址systemCode字符串是第三方系统编码systemPassword字符串是第三方系统请求密码响应参数（GetTokenResponse）：参数数据类型是否必须说明requestId字符串是请求是携带的参数requestIdmsgCode字符串是请求消息编码（0000为请求正常，其他为处理异常，具体异常编码参考平台服务消息编码部分）msgDesc字符串是请求消息描述accessToken字符串是返回的第三方系统调用接口令牌4.2 消息发布服务接口4.2.1 接口说明本接口主要提供消息通知服务，当医院信息平台数据中心相关业务数据发生变化，本接口会生成相关消息，然后推送到已经订阅了本消息的三方系统。本接口推送消息如果失败，医院信息平台5分钟第二次推送消息，如果第二次推送消息失败，在过30分钟第三次推送消息，如果第三次推送消息失败，再过90分钟第四次推送消息，依次类推。医院信息平台在七次推送消息都失败后，平台停止消息推送。平台管理员可以设置每次消息推送失败间隔时间。七次推送失败的消息医院信息平台提供推送消息失败日志查询。4.2.2 场景说明当医院信息平台数据中心相应业务数据发生变化时，通过本接口发布给已经订阅了相关消息的第三方系统。4.2.3 调用地址业务系统提供4.2.4 接口定义 Web Service接口方式说明Web Service方式指业务系统作为Web Service服务端，医院平台作为Web Service客户端，业务系统在消息订阅时提供服务端调用地址（参见A0000服务的RECEIVE_URL参数说明）。当有消息需要发布时，医院平台根据订阅信息，将信息数据通过消息发布接口推送至业务系统。WSDL定义WSDL文档：参数说明请求参数：参数数据类型是否必须说明notifyCode字符串是消息编码，具体编码参考各个信息发布接口定义callBackServiceVersion字符串是回调服务版本号callBackServiceCode字符串是回调服务编码，具体编码参考业务交换服务编码定义callBackWsUrl字符串是回调服务地址data字符串是消息附带业务数据，多个数据用分隔，例如：abc123456adminpubCount整型是消息推送次数响应参数：无响应参数，消息发布服务接口负责发布相关业务数据新增、更新消息，消息发布未返回异常医院信息平台即认为消息发送成功 HTTP接口方式说明HTTP方式指业务系统作为服务端提供HTTP服务，医院平台作为调用HTTP服务的客户端，业务系统在消息订阅时提供服务端调用地址（参见A0000服务的RECEIVE_URL参数说明）。当有消息需要发布时，医院平台根据订阅信息，将信息数据通过消息发布接口推送至业务系统。参数以POST方式作为HTTP请求参数传递到服务端。参数说明请求参数：参数数据类型是否必须说明notifyCode字符串是消息编码，具体编码参考各个信息发布接口定义callBackServiceVersion字符串是回调服务版本号callBackServiceCode字符串是回调服务编码，具体编码参考业务交换服务编码定义callBackWsUrl字符串是回调服务地址data字符串是消息附带业务数据，多个数据用分隔，例如：abc123456adminpubCount整型是消息推送次数响应参数：无响应参数，消息发布服务接口负责发布相关业务数据新增、更新消息，消息发布未返回异常医院信息平台即认为消息发送成功4.3 业务交换服务接口4.3.1 接口说明业务交换服务接口主要完成各类业务交换过程中的功能接口，每个不同的业务功能由服务编码区分（具体编码见业务交换服务部分的服务编码说明）。4.3.2 场景说明当业务系统需要进行数据交换时，首先需要获取令牌，然后使用令牌调用本接口调用指定服务编码服务，完成数据交换过程。4.3.3 调用地址http:/ip:port/hipService/CommonPort4.3.4 WS接口定义WSDL文档：参数说明请求参数参数数据类型是否必须说明requestId字符串是UUIDaccessToken字符串是第三方系统调用接口令牌，参考获取令牌服务接口定义requestIP字符串是第三方系统中相应用户所在客户端的IP地址requestUserAccount字符串是第三方系统中相应用户账户serviceVersion字符串是调用的服务版本号serviceCode字符串是调用的服务编码，具体编码参考业务交换服务中的定义requestData字符串是调用服务需要的请求数据，具体定义参考相应服务定义响应参数参数数据类型是否必须说明requestId字符串是消息编码，具体编码参考各个信息发布接口定义msgCode字符串是请求消息编码（0000为请求正常，其他为处理异常，具体异常编码参考平台服务消息编码部分）msgDesc字符串是请求消息描述responseData字符串否服务返回的响应数据，具体定义参考相应服务定义5 业务交换服务5.1 业务交互服务概述约定： 所有日期时间转成字符串 请求和返回的xml信息的标签均为大写5.2 基础交换服务（A）5.2.1 消息订阅服务（A00） 订阅消息服务（A0000） 服务编码服务编码：A0000 服务说明本服务提供业务系统订阅平台各种消息通知，订阅消息通知后，平台根据订阅主题会推送相关消息到订阅制定通知地址 请求参数 参数说明序号参数名称参数类型是否必需参数说明1OPERATION_TYPEInt是操作类型 0-订阅消息 1-取消订阅2TOPICSString是消息主题序列，多个消息主题需要用半角逗号分隔。3SERVICE_TYPEInt否接口服务方式 0-WS方式 1-HTTP方式4RECEIVE_URLString否接收消息URL，如果OPERATION_TYPE为0，则此参数必需，此URL提供的接收消息的服务方式，具体定义参照本文档【4.2 消息发布服务接口】定义。XML示例：0String0String 响应参数无5.2.2 患者服务（A01）暂未定5.2.3 医疗卫生人员服务（A02） 医护人员业务系统编码上传（A0201） 服务编码服务编码：A0201 服务说明本服务主要实现各个业务系统对医疗服务人员进行自定义编码后，将自定义编码上传平台，平台对医疗服务人员在不同业务系统的编码形成对照索引。 请求参数参数说明序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString是32平台对医疗服务人员的编码（工号）2OPERATION_STAFF_CODEString是32请求的业务系统对医疗服务人员的编码（工号）XML示例：StringString 响应参数参数说明：无 医护人员信息查询（A0202） 服务编码服务编码：A0202 服务说明本服务主要实现对平台中维护的医疗服务人员信息的查询功能。 请求参数 参数说明：序号参数名称参数类型是否必需取值范围参数说明1HIP_DEPT_CODESString否平台科室编码序列，多个科室编码之间用半角逗号分隔。2HIP_STAFF_CODESString否平台医疗服务人员编码序列，多个医疗服务人员编码之间用半角逗号分隔。3OPERATION_DEPT_CODESString否业务系统科室编码序列，多个科室编码之间用半角逗号分隔。4OPERATION_STAFF_CODESString否业务系统医疗服务人员编码序列，多个医疗服务人员编码之间用半角逗号分隔。5NAME_KEYString否医疗服务人员姓名关键字注意：5个参数中，在一次请求中只能包含一个参数，如果有多个参数，则以第一个参数为准进行医疗服务人员相关信息查询。XML示例：StringStringStringStringString 响应参数参数说明：序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString是平台人员编码2STAFF_NAMEString否人员姓名3GENDERString否人员性别编码4LOGINNAMEString否人员登录名（与平台人员编码相同）5CA_IDString否集成CA身份验证证书唯一标识6CERTIFICATE_NOString否身份证号7BRITHDATEString否出生日期 yyyy-MM-dd8NATIONALSString否民族9INHOSPITAL_DATEString否来院时间 yyyy-MM-dd10STAFFSORTString否人员类别编码11MARITAL_STATUSString否婚姻状态12GRADUATE_COLLEGEString否毕业院校13MAJORString否所学专业14EDUCATIONString否最高学历编码15DEGREEString否最高学位编码16GRADUATION_DATEString否毕业时间 yyyy-MM-dd17MOBILEString否手机号码18TELEPHONEString否联系电话19ADDRESSString否家庭住址20POSTCODEString否邮政编码21EMAILString否电子邮箱地址22REMARKString否备注23VALIDString否有效性 0-停用 1-有效 2-废弃24STAFF_CODE_MAP/ SYSTEM_CODEString否业务系统编码25STAFF_CODE_MAP/ OPERATION_STAFF_CODEString否业务系统人员编码XML示例：StringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringStringString0StringString 医护人员密码查询（A0203） 服务编码服务编码：A0203 服务说明本服务主要实现通过平台人员编码或业务系统人员编码查询人员登录密码的功能。 请求参数 参数说明序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString否平台人员编码2OPERATION_STAFF_CODEString否业务系统人员编码注意：2个参数请求过程中必需包含一个XML示例：StringString 响应参数参数说明：序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString是32平台人员编码2OPERATION_STAFF_CODEString否32业务系统人员编码3PASSWORDString是64人员登录密码（MD5加密后的密文）XML示例：StringStringString 人员科室职务查询（A0204） 服务编码服务编码：A0204 服务说明本服务主要提供通过人员编码或人员姓名关键词，查询人员所在不同科室的不同职务信息。 请求参数参数说明序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString否32平台医疗服务人员编码。2OPERATION_STAFF_CODEString否32业务系统医疗服务人员编码。3NAME_KEYString否64医疗服务人员姓名关键字注意：3个参数中，在一次请求中只能包含一个参数，如果有多个参数，则以第一个参数为准进行医疗服务人员相关信息查询。XML示例：StringStringString 响应参数参数说明：序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString是32平台医疗服务人员编码。2OPERATION_STAFF_CODEString否32业务系统医疗服务人员编码。3POSITION/HIP_DEPT_CODEString是32平台部门编码4POSITION/OPERATION_DEPT_CODEString是32业务系统部门编码5POSITION/POSITION_CODEString是32职务编码6POSITION/POSITION_NAMEString是64职务名称XML示例：StringStringStringStringStringString 人员职级查询（A0205） 服务编码服务编码：A0205 服务说明本服务主要提供通过人员编码或人员姓名关键词，查询人员职级信息。 请求参数 参数说明序号参数名称参数类型是否必需取值范围参数说明1HIP_STAFF_CODEString否32平台医疗服务人员编码。2OPER