【公共篇】数据采集接口说明.docx

PAGE42

区域卫生信息平台

数据采集接口说明

2017年11月

文档修改记录

版本

修改内容

修改人

修改日期

v1.0.0

新建

王春东

2016-6-16

v1.0.1

修改文档结构，增加数据对账服务

王龙宇

2017-9-25

V1.0.2

发布

陈慧

2017-11-01

目录

TOC\o1-3\h\z1 引言 4

1.1 编写目的 4

1.2 术语和定义 4

1.3 交换报文结构说明 5

1.3.1请求报文结构 5

1.3.2响应报文结构 8

2 数据采集介绍 10

2.1 采集步骤介绍 10

2.2 数据标准要求 12

2.3 接口程序要求 12

3 数据采集接入流程 12

3.1 接入前期准备 12

3.2 开发数据上传接口程序 13

3.3 联调阶段 13

3.4 历史数据上传阶段 13

3.5 增量数据上传阶段 13

4 服务规范说明 13

4.1.1xml入参说明 14

4.1.2xml出参说明 18

4.1.3管理字段填写说明 19

4.2 数据采集结果接收服务 20

4.2.1xml入参说明 21

4.2.2xml出参说明 24

4.3 数据对账接收服务 25

4.3.1xml入参说明 26

4.3.2xml出参说明 31

5 交换标准列表 33

6 常见问题及其他 33

引言

编写目的

本文档用于描述区域卫生信息平台为建立数据中心，完成数据采集汇聚工作，对各业务系统，即数据上传方，开发数据上传接口的工作规范约束。重点围绕相关各方职责及数据上传厂商的开发工作进行约束说明。

本文档适用于项目建设单位各相关机构、各医疗机构内部信息系统承建单位、及基于平台完成数据对接的各信息系统承建单位。

术语和定义

以下对本文所提及相关术语及定义进行阐述说明：

数据上传方

产生或提供数据给区域平台的第三方，其负责数据的清洗转换，并将数据传输给区域平台。

数据采集上传服务

区域平台提供的用于接收xml数据的webService服务。数据上传方通过将数据生成要求格式的xml文件后，调用xml数据采集服务将数据传输给区域卫生平台。

数据采集结果接收服务

数据上传方提供的用于接收区域平台处理数据结果的webService服务。

前置机、前置库

前置机：前置交换服务器的简称，用于解决网络问题。

前置库：前置mysql数据库，用于缓冲上传的数据。

交换标准

服务交互的统一的交换报文结构，即用于规定数据上传时所遵循的统一的xml格式及内容。由区域平台统一标准管理系统统一发布。

校验报告

区域平台对于数据上传方所上传的数据进行审核验证后所出具的是否符合规范标准的说明报告。主要校验内容为值域、格式、必填等，所有校验的结果将生成一个可直观展现的HTML，作为校验报告返回给数据上传方。

数据对账

数据上传方除上传数据采集XML数据外，需要记录每次上传数据的相关信息，通过调用数据对账接收服务用于与区域平台进行账目核对，以追踪确认双方数据的差异性。

数据对账包括业务量对账、数据量对账。

交换报文结构说明

区域平台接口服务统一的交换报文格式，其基本如下：

?xmlversion=1.0encoding=UTF-8?

messages

heartbeat/

switchset/

business/

extendset/

/messages

交换报文格式为典型的XML格式，它使用messages节点作为根节点，在根节点下包含heartbeat节点，switchset节点，business节点和extendset节点:

heartbeat节点检测服务认证信息；

switchset节点用于承载与服务相关的安全、配置和路由信息等；

business节点承载与服务相关的标准信息和业务数据等；

extendset节点用于特定需求及未来扩展；

根据服务请求和响应动作的不同，交换报文结构又分为请求类交换报文结构和响应类交换报文结构，分别对应服务的入参封装格式和出参封装格式即请求报文结构和响应报文结构，具体如下：

请求报文结构

入参节点说明

字段名称

填写方

必填

字段描述

heartbeat节点

用于检测服务活性，整型，可选值为0（非服务活性检测），1（服务活性检测），默认值为0

switchset节点下的authority节点

用于消息交换的定义

authoritytype

服务调用方

是

用于定义消息交换的安全配置类型，整型，可取值为0（无安全配置），1（使用用户名/密码），2（使用授权码），3（使用数字证书），9（其他安全配置