湖北健康一体机接口规范V1.0.doc

湖北基层卫生系统调用健康一体机数据集成接口V1.0备注：如果健康档案系统是蓝星公司，不需要将此文档发给蓝星，我们跟蓝星已对接；如果健康档案系统是其他公司，需使用我们提供的接口规范，请将此文档发给第三方公司。北京好医生2015-3-1文档信息项目名称作者审核建立日期文档编号密级接口规范全体2015/01/12项目内部用户信息用户名称 湖北省卫生计生委版本信息版本号最近更新日期V1.02015年3月18版本修订记录版本日期修订说明修订人1.02015/03/18新建田芦飒1、1 一体机接口服务设计一体机管理系统提供了面向电子健康档案系统的接口调用服务；保障电子健康档案系统能获取健康一体机的检测数据。1.1 通讯技术在一体机管理系统中开放的服务中涉及如下技术：XMLXML（Extensible Markup Language）即可扩展标记语言，本规范中的数据交换格式都采用XML格式。 SOAP 简单对象访问协议(Simple Object Access Protocol)，SOAP 是基于 XML 的简易协议，可使应用程序在 HTTP 之上进行信息交换。或者更简单地说：SOAP 是用于访问网络服务的协议。WSDL WSDL 指网络服务描述语言 (Web Services Description Language)。 WSDL 是一种使用 XML 编写的文档。这种文档可描述某个 Web service。它可规定服务的位置，以及此服务提供的操作（或方法）。UDDI 通用描述、发现与集成服务(Universal Description, Discovery and Integration)； UDDI 是一个独立于平台的框架，用于通过使用 Internet 来描述服务，发现企业，并对企业服务进行集成。Web Service Web Services 可使您的应用程序成为 Web 应用程序。Web Services 通过 Web 进行发布、查找和使用。基础的 Web Services 平台是 XML + HTTP；HTTP 协议是最常用的因特网协议，XML 提供了一种可用于不同的平台和编程语言之间的语言。 Web services 平台的元素： SOAP (简易对象访问协议) UDDI (通用描述、发现及整合) WSDL (Web services 描述语言)。1.2 服务接口设计介绍一体机管理系统提供的服务采用通用的接口函数，接口的规范说明参照如下章节说明。1.2.1 通用接口主函数系统统一公开的WebService函数统一命名为：serviceMain。输入和返回值均为字符串。服务方法定义String serviceMain (String header,String body)输入参数：header消息头,XML格式。body消息体，XML格式。具体格式规范参考消息结构定义返 回 值： 返回服务处理结果，返回的result格式规范参考消息结构定义部分函数有xml示例。示例只说明字符串信息样式，传输字段名以文档中规范为准。注意事项：l xml格式信息中的encoding字段的值必须是GBK；l 数据项的值如果为空，也必须有数据项，只是内容为空，如； l 在本文的XML接口中，info属性仅作为文档中的注释用于接口说明，不需作为正式传入传出的参数。如其中“info=”临时码”均为注释信息，在入参、出参中都将不会出现。字段约定：l 字段信息中“是否为空”栏目：Y 字段可以为空； N 字段不允许为空；l 字段信息中“数据规范及说明”中如果有值，传递参数和获取参数时，值为所标明字典目录值或所说明的规定格式。1.2.2 个性化接口函数本期接口暂不考虑，后期扩展。1.2.3 重要说明String在本规范中表示不定长度的字符串数据类型，这里采用最常见的字符”String”来表示，由于在不同的计算机语言中字符串会有不同的类型名，因此如果发现所用计算机语言没有String类型，应以正在使用的计算机语言为准Int在本规范中用来表示整型数据类型，亦有计算机语言中使用”integer”来表示整型，这采用了最常见的字符”int”来表示事件是指一次消息传送的过程、与服务器的交互过程，亦有称之为“交易”、“服务”。1.3 接口参数结构定义在访问服务过程中，由客户端发送的带有格式的数据统称之为消息，消息有两部分构成，分别为消息头(header)和消息体(body)，消息头和消息体都是XML结构的字符串。1.3.1 消息头（header）消息头用来定义一个消息的摘要，通过摘要可以获得发起消息的类型，服务编号、创建时间、来源机构信息等，消息头是根节点为的XML字符串，下表详细定义了消息头应包含的信息。各交易中节点名称都为小写字母。定义节点描述servicecode服务编号，如13120001（查询一体机结果）apiversion接口版本号（暂不填）createtime消息创建时间，格式为 yyyy-MM-dd hh:mm:ssgovcode操作员用户机构编码（必填项）systemid给第三方系统分配的固定编码（暂不填）username给第三方系统分配的固定用户（暂不填）userpass给第三方系统分配的固定密码（暂不填）例子 13120001 1.0 yyyy-MM-dd hh:mm:ss 1.3.2 消息体（body）消息体是消息的主体，是采用符合XML结构的字符串，用以存放客户端在本次事件中的输入参数，消息体的具体内容装配需要借助具体的服务定义。消息体中的XML节点根据服务的定义而定，但要求使用作为XML的根节点，具体内容如下：定义 参数值 注意：具体XML格式内容参考对应服务编号的定义。各交易中节点名称均为小写字母，不会出现大写字母。1.3.3 返回信息结构说明（result）定义： 说明返回信息以result为根节点state节点当属性success=0时，该操作成功；当success=1时该操作失败；state包括两类子节点，其中属性code是信息编码，属性info是具体信息。output节点内是服务返回的数据结果集。该字段中的内容为XML结构子节点用于显示操作的失败信息，当属性success=0时，该操作成功，子节点中不会出现子节点，但是可能有节点；当success=1时该操作失败，则至少有一条字节点，显示该操作的失败原因；子节点用于显示操作中一些需要操作员注意的事项，不论操作成功与否，都可能出现子节点，且子节点可能是多条；2 业务系统与一体机接口说明 说明：本节为第三方业务系统（公共卫生系统、村HIS系统调用部署在县区的健康一体机管理系统接口服务完成相应的操作）2.1 13120201查询一体机结果本服务请求用于业务系统向县区一体机管理系统请求检查人员及检查结果信息数据。说明：按身份证号、日期范围等信息查询检查结果。接口类型：通用接口函数名称：serviceMain服务编号：13120201入口参数header(请参考消息头结构定义)入口参数body格式： 001301012014-05-012014-05-03节点必输项说明useridY操作员编码useridtypeY操作员编码类型，无useridtype节点，则默认为01idnoN检查人身份证号码startdateY检查时间范围-开始YYYY-MM-DD 或YYYY-MM-DD hh:mm:ssenddateY检查时间范围-结束YYYY-MM-DD 或YYYY-MM-DD hh:mm:ssIcpcodeY检查机构编码平台使用的机构编码devicesnN终端编号设备终端编号（目前不用，保留）pagenoY当前页为减轻服务压力，客户端每次调用时从第1页开始pernumY每页显示条数每页显示条数不超过100；SystemorcY调用系统标识1：HIS调用；2：健康档案调用；9：其他系统调用numberofcaseY检查单号用于查询具体已知检查单号的情况，此时结果中最多只有一条记录，。返回结果： 节点名称节点说明注释checknum检查结果数符合检索条件的结果数目numberofcase检查单号cardno身份证号username姓名sex性别数据字典：GB/T 2261.1-2003birthday生日YYYY-MM-DDphone电话nation民族数据字典：GB 3304-1991address地址checkdate检查时间YYYY-MM-DD HH:MM:SSsbp收缩压dbp舒张压oximeter血氧glu血糖fetalheart心率pulse脉率height身高(cm)weight体重(kg)temp体温mean平均压anal心电图自动诊断结果描述icpcode检查机构编码icpname检查机构名称numberofcase检查单号ncg_ph尿常规phncg_ubg尿常规ubgncg_blo尿常规bloncg_pro尿常规proncg_ket尿常规ketncg_nit尿常规nitncg_glu尿常规gluncg_bil尿常规bilncg_leu尿常规leuncg_sg尿常规sgncg_vc尿常规vccrtime检查上传时间YYYY-MM-DD HH:MM:SSisetc该次检查是否有心电图0：无心电图1：有心电图客户端如果不进行相关扩展功能时，则不需下载心电图checkbrowserurl检查浏览器URL该次检查信息在区县一体机管理平台中浏览页面的URL，可直接在浏览器中打开本链接访问，不需另开发展现页面。2.2 13120203查询检查调阅页面URL 说明：本服务为可选服务，是否有必要实现由电子健康档案系统开发商根据自身业务确定，用于业务系统向一体机管理系统获取检查浏览页面URL， 说明：业务系统按检查单号调用服务，获取该检查浏览器页面的URL地址（本URL地址信息与13120201服务中checkbrowserurl节点信息相同，如果访问了13120201服务，则不需再访问本服务）。接口类型：通用接口函数名称：serviceMain服务编号：13120203入口参数header(请参考消息头结构定义)入口参数body格式： 00130101节点必输项说明useridY操作员编码useridtypeY操作员编码类型，无useridtype节点，则默认为01标识userid的含义：01-userid为平台端用户编码02-userid为用户工号(用于和平台用户对照的唯一号)