湖北健康一体机接口规范V10Word格式.docx
《湖北健康一体机接口规范V10Word格式.docx》由会员分享，可在线阅读，更多相关《湖北健康一体机接口规范V10Word格式.docx（15页珍藏版）》请在冰豆网上搜索。
日期
修订说明
修订人
1.0
2015/03/18
新建
田芦飒
1、
1一体机接口服务设计
一体机管理系统提供了面向电子健康档案系统的接口调用服务；
保障电子健康档案系统能获取健康一体机的检测数据。
通讯技术
在一体机管理系统中开放的服务中涉及如下技术：
XML
XML（ExtensibleMarkupLanguage）即可扩展标记语言，本规范中的数据交换格式都采用XML格式。
SOAP
简单对象访问协议（SimpleObjectAccessProtocol），SOAP是基于XML的简易协议，可使应用程序在HTTP之上进行信息交换。
或者更简单地说：
SOAP是用于访问网络服务的协议。
WSDL
WSDL指网络服务描述语言（WebServicesDescriptionLanguage）。
WSDL是一种使用XML编写的文档。
这种文档可描述某个Webservice。
它可规定服务的位置，以及此服务提供的操作（或方法）。
UDDI
通用描述、发现与集成服务（UniversalDescription,DiscoveryandIntegration）；
UDDI是一个独立于平台的框架，用于通过使用Internet来描述服务，发现企业，并对企业服务进行集成。
WebService
WebServices可使您的应用程序成为Web应用程序。
WebServices通过Web进行发布、查找和使用。
基础的WebServices平台是XML+HTTP；
HTTP协议是最常用的因特网协议，XML提供了一种可用于不同的平台和编程语言之间的语言。
Webservices平台的元素：
SOAP（简易对象访问协议）UDDI（通用描述、发现及整合）WSDL（Webservices描述语言）。
服务接口设计介绍
一体机管理系统提供的服务采用通用的接口函数，接口的规范说明参照如下章节说明。
通用接口主函数
系统统一公开的WebService函数统一命名为：
serviceMain。
输入和返回值均为字符串。
服务方法定义
StringserviceMain（Stringheader,Stringbody）
输入参数：
header消息头,XML格式。
body消息体，XML格式。
具体格式规范参考消息结构定义
返回值：
返回服务处理结果，返回的result格式规范参考消息结构定义
部分函数有xml示例。
示例只说明字符串信息样式，传输字段名以文档中规范为准。
注意事项：
●xml格式信息中的encoding字段的值必须是GBK；
●数据项的值如果为空，也必须有数据项，只是内容为空，如<
arg02>
<
/arg02>
；
●在本文的XML接口中，info属性仅作为文档中的注释用于接口说明，不需作为正式传入传出的参数。
如<
temp_pwdinfo=”临时码”>
其中“info=”临时码”均为注释信息，在入参、出参中都将不会出现。
字段约定：
●字段信息中“是否为空”栏目：
Y字段可以为空；
N字段不允许为空；
●字段信息中“数据规范及说明”中如果有值，传递参数和获取参数时，值为所标明字典目录值或所说明的规定格式。
个性化接口函数
本期接口暂不考虑，后期扩展。
重要说明
String
在本规范中表示不定长度的字符串数据类型，这里采用最常见的字符”String”来表示，由于在不同的计算机语言中字符串会有不同的类型名，因此如果发现所用计算机语言没有String类型，应以正在使用的计算机语言为准
Int
在本规范中用来表示整型数据类型，亦有计算机语言中使用”integer”来表示整型，这采用了最常见的字符”int”来表示
事件
是指一次消息传送的过程、与服务器的交互过程，亦有称之为“交易”、“服务”。
接口参数结构定义
在访问服务过程中，由客户端发送的带有格式的数据统称之为消息，消息有两部分构成，分别为消息头（header）和消息体（body），消息头和消息体都是XML结构的字符串。
消息头（header）
消息头用来定义一个消息的摘要，通过摘要可以获得发起消息的类型，服务编号、创建时间、来源机构信息等，消息头是根节点为<
header>
的XML字符串，下表详细定义了消息头应包含的信息。
各交易中节点名称都为小写字母。
定义
节点
描述
servicecode
服务编号，如（查询一体机结果）
apiversion
接口版本号（暂不填）
createtime
消息创建时间，格式为yyyy-MM-ddhh:
mm:
ss
govcode
操作员用户机构编码（必填项）
systemid
给第三方系统分配的固定编码（暂不填）
username
给第三方系统分配的固定用户（暂不填）
userpass
给第三方系统分配的固定密码（暂不填）
例子
?
xmlversion="
1.0"
encoding="
GBK"
>
servicecode>
/servicecode>
apiversion>
1.0<
/apiversion>
<
createtime>
yyyy-MM-ddhh:
ss<
/createtime>
govcode>
/govcode>
systemid>
/systemid>
username>
/username>
userpass>
/userpass>
/header>
消息体（body）
消息体是消息的主体，是采用符合XML结构的字符串，用以存放客户端在本次事件中的输入参数，消息体的具体内容装配需要借助具体的服务定义。
消息体中的XML节点根据服务的定义而定，但要求使用<
body>
作为XML的根节点，具体内容如下：
paramname=“参数名”>
参数值<
/param>
…<
……
/body>
注意：
具体XML格式内容参考对应服务编号的定义。
各交易中节点名称均为小写字母，不会出现大写字母。
返回信息结构说明（result）
定义：
GBK"
result>
statesuccess="
1"
warningcode="
"
message="
用户名无效"
/>
******"
errorcode="
用户名或密码错误"
/state>
output>
<
info01>
……<
/info01>
info02>
/info02>
/output>
/result>
说明
返回信息以result为根节点
state节点
当属性success="
0"
时，该操作成功；
当success="
时该操作失败；
state包括两类子节点<
error>
，<
warning>
，其中属性code是信息编码，属性info是具体信息。
output节点内是服务返回的数据结果集。
该字段中的内容为XML结构
子节点用于显示操作的失败信息，当属性success="
时，该操作成功，子节点中不会出现<
子节点，但是可能有<
节点；
时该操作失败，则至少有一条<
字节点，显示该操作的失败原因；
子节点用于显示操作中一些需要操作员注意的事项，不论操作成功与否，都可能出现<
子节点，且<
子节点可能是多条；
2业务系统与一体机接口说明
说明：
本节为第三方业务系统（公共卫生系统、村HIS系统调用部署在县区的健康一体机管理系统接口服务完成相应的操作）
查询一体机结果
本服务请求用于业务系统向县区一体机管理系统请求检查人员及检查结果信息数据。
按身份证号、日期范围等信息查询检查结果。
接口类型：
通用接口
函数名称：
serviceMain
服务编号：
入口参数header（请参考消息头结构定义）
入口参数body格式：
useridinfo="
操作员编码"
001301<
/userid>
useridtypeinfo="
操作员编码类型"
01<
/useridtype>
idnoinfo="
检查人身份证号码"
/idno>
startdateinfo="
检查时间范围-开始"
2014-05-01<
/startdate>
enddateinfo="
检查时间范围-结束"
2014-05-03<
/enddate>
icpcodeinfo="
检查机构编码"
/icpcode>
devicesninfo="
设备编号"
/devicesn>
pagenoinfo=“当前页”>
/pageno>
pernuminfo=“每页显示条数”>
/pernum>
systemorcinfo="
调用系统标识"
/systemorc>
numberofcaseinfo=”检查单号”>
/numberase>
/body>
必输项
userid
Y
操作员编码
useridtype
操作员编码类型，无useridtype节点，则默认为01
idno
N
检查人身份证号码
startdate
检查时间范围-开始
YYYY-MM-DD或YYYY-MM-DDhh:
enddate
检查时间范围-结束
Icpcode
检查机构编码
平台使用的机构编码
devicesn
终端编号
设备终端编号（目前不用，保留）
pageno
当前页
为减轻服务压力，客户端每次调用时从第1页开始
pernum
每页显示条数
每页显示条数不超过100；
Systemorc
调用系统标识
1：
HIS调用；
2：
健康档案调用；
9：
其他系统调用
numberofcase
检查单号
用于查询具体已知检查单号的情况，此时结果中最多只有一条记录，。
返回结果：
encoding=
升级会员 