HQMS数据对接软件开发说明书
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
说明：为了方便开发与调试，在返回 001007 错误码的情况下，可以加参数 isDev=1 来正常获得 Token，但此参数只适用于访问测试机，对生产机无效。
001008：当天已上传次数达到上限。
4/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
二、功能流程
•获取数据对接账户信息和帮助文档
第一步 •获取数据对接测试账户、对接接口标准和数据对接软件开发说明书等文档。
•设计开发数据信息转换程序 •根据数据对接接口标准及数据对接软件开发说明书，自行设计开发数据信息转换
第二步 程序，生成dbf文件。
•开发程序并上传测试数据包 •根据数据对接软件开发说明书中指定的测试系统请求地址，按分配的时间段利用
第六步 置。
•在生产系统中实现自动上传对接数据 •数据信息转换程序自动在每天规定时间段上传数据，生产系统每月定时自动生成
第七步 相关指标，医院数据录入员补填未自动生成的指标。
2/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
//grade1:入库达标，技术通道不达标记录数 //grade2:技术通道达标，接口标准不达标记录数 //grade3:接口标准达标记录数 //total:数据包记录总数 //grade:数据包等级 } } 错误代码： 003001：没有找到合适的数据-请检查 token 是否正确。 注意： 所有请求地址参数必须完整，如果没有值，请保持为空。datatype 参数为 JSON 格 式； 请求数据传送时，将压缩文件包以文件流的形式放置于 POST 内容中； 在数据传送请求时 token 必须在 10 分钟内使用，超时将失效； token 作为查询上传进度和校验结果的凭证，需要保存使用； 获取查询上传进度和校验结果时，编码格式为 UTF-8； 测试网址为：http://hqmststest.medidata.com.cn 请在不同环境下设置好相应的前辍域名。 5 查看数据对接报告： 利用数据对接测试系统账户登录 http://hqmststest.medidata.com.cn，点击左侧 “查 看数据对接”菜单项查看对接情况报告。 在查看数据对接列表中，根据“上传时间”找到相应数据对接记录，并点击查看数 据对接情况报告。 6 自行申请生产系统数据对接账户： 登录数据对接测试系统后点击“查看数据对接”菜单，确定每天定时上传的数据包
第三步 测试账户上传测试数据包。
•查看数据对接情况反馈报告
第四步 •利用数据对接测试账号登录数据对接测试系统，查看数据对接情况反馈报告。
•自行申请生产系统数据对接账号 •确认对接数据完整无误后，在测试系统点击“申请数据对接正式账户”按钮自行
第五步 开通生产系统数据对接账户。
•修改程序中数据请求地址 •将数据信息转换程序中的请求地址修改为生产系统数据对接账户及对接地址的配
1/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
注：系统会将数据对接账户信息和数据对接帮助文档发送到本医院 HQMS 系统数据填 报联系人邮箱中。
数据对接测试系统网址 http://hqmststest.medidata.com.cn
成功
对接成功
失败 （校验不通过、数据格式不符）
4.4 对接 API 接口说明： token 请求地址：
../docking/auto/gettoken.shtml?loginid=&pwd=&datatype=json 参数说明：
loginid：用户名 pwd：密码 datatype:返回结果为 JSON 格式
HQMS 数据对接软件开发说明书
发布日期：2012 年 11 月 2 日 本文档使用对象：医院软件开发人员
一、 概述
医院软件开发人员，所需文档如下： 《HQMS 数据对接技术通道工作说明书》（以下简称“技术通道说明书”） 《HQMS 数据对接软件开发说明书》（以下简称“开发说明书”） 《HQMS 数据对接接口标准》（以下简称“接口标准”） 《数据对接接口校验规则》 《RC020-ICD-10 诊断编码》 《RC021-ICD-10 形态学编码》 《RC022-ICD-9 手术编码》 Java 版本数据对接 Demo 程序
在数据对接测试系统中实现每天在规定时间段内自动获取最新的数据并成功上传的功 能后，可自行申请数据对接正式系统（以下简称“生产系统”）账户，申请成功后系统会自 动发送账户信息到本院 HQMS 系统数据填报联系人邮箱中。利用邮件中指定的生产系统网 址和对应的账户信息修改程序中的请求地址和账户配置，设置数据信息转换程序实现自动在 每天规定时间段内上传数据。生产系统会自动生成相关指标，医院数据填报人员补填未自动 生成的指标。
2 数据说明： 2.1 字段的先后顺序必须严格按照接口标准中指定的顺序进行排列。 2.2 数据类型说明： 字符：可以为任何字符； 数字：可以为整型或浮点型数据； 日期：格式为：日期时间型（yyyy-MM-dd HH:mm:ss）或日期型（yyyy-MM-dd）。 2.3 数据长度必须严格按照接口标准中进行限定，一个汉字占 2 个字节长度。 2.4 接口标准中“备注”里面有值域范围规定的，必须按照值域范围内的值进行填写。
succ:true|false,//成功｜失败，此参数只作为此次请求的结果 errorCode:'',//错误代码 errMsg :’XXX’, //错误描述 errorStack:'',//错误堆栈－JAVA 格式 result:{
id:'',//token date:''//上传文件所使用的时间（秒） } } 错误代码： 002000：无效或缺少参数值； 002001：无效的 token； 002002：token 已过期； 002003：token 已被使用； 002004：此 token 无权上传所请求的机构数据。 对接进度查询请求地址： ../docking/auto/findResult.shtml?token=&datatype=json 建议：此接口调用频率请设置为大于 1 分钟。 参数说明： token：通过上面的 token 请求地址获取，在数据传送请求后可随时使用 datatype: 返回结果为 JSON 格式 返回结果： { succ:true|false,//成功｜失败，此参数只作为此次请求的结果
3/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
获取对接数据 接口文档
调用接口获取 token
开发程序生成 数据文件
(完成格式、数据校验)
将数据文件打 包压缩为ZIP格
式
使用token进行 数据文件传输
使用token查询 对接结果
医院软件开发人员所需对接系统信息是以邮件形式发送至本院HQMS系统数据填报联 系人邮箱，内容包括：
1. 数据对接系统账户信息（密码只在第一次申请账户时发送）
2. 接收数据对接账户及文档相关信息的邮箱地址
3. 数据对接系统对应的（测试/正式）网址
4. 允Leabharlann Baidu上传对接数据的时间段
医院软件开发人员根据接口标准和开发说明书自行设计数据信息抽取转换程序，并生成 DBF 格式文件。利用数据对接账户、已分配的对接数据时间段和指定的对接系统网址上传 数据包，登录数据对接系统查看对接报告详情。
三、开发说明
1 文件说明： 1.1 上报文件格式：zip 1.2 生成数据文件格式：DBF 或 CSV 1.3 压缩包内最多可包含 2 个数据文件。 1.3.1 压缩包内 1 个数据文件：可生成大于 255 列字段的。 1.3.2 压缩包内 2 个数据文件：不能生成大于 255 列字段可生成 2 个数据文件。要 求文件命名必须以 part1 和 part2 字样结尾，并且 part1 和 part2 中数据以病案 号（P3）和入院日期（P22）进行关联，并可唯一标识出一条完整的病案信 息（要求在 part2 中 P3 为首列，P22 为第二列）。 1.4 数据对接周期： 1.4.1 每天在规定时间段内进行一次数据对接（数据对接测试系统中允许多次数据 对接）。 1.4.2 数据内容包括医院最新可上传的已出院患者病案数据。
可通过邮件中列出的生产系统数据对接账户信息，生产系统数据对接时间段，生产 系统网址修改相应的请求地址配置。 8 实现每天自动对接数据：
可通过邮件中列出的生产系统数据对接时间段修改数据信息转换程序实现自动在 每天规定时间段内上传数据。生产系统会自动生成相关指标，医院数据录入员补填未自 动生成的指标。
返回结果：
{ succ:true|false,//成功｜失败 errorCode:'',//错误代码 errorStack:'',//错误堆栈－JAVA 格式
result:{ token:''//token
} } 错误代码：
001001：用户名不存在； 001002：密码不正确； 001003：用户已被禁用； 001004：IP 被锁定（连续 5 次以上用户名或密码不正确）； 001005：没有数据对接权限。 001006:登录密码已到期，需要更改登录密码。 001007：当前时间不在允许对接数据的时间范围内。
6/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
均通过校验并处理完成。确认数据无误后医院软件开发人员可联系 HQMS 系统数据填 报联系人，告知可申请数据对接系统正式账户。数据填报联系人确认对接数据生成的指 标无误则点击“申请数据对接正式账户”按钮自行申请生产系统数据对接账户。系统会 自动将生产系统数据对接账户相关信息发送至本医院 HQMS 系统数据填报联系人邮箱 中。 7 获取生产系统账号信息修改 url：
说明：为了方便开发与调试，在返回 001008 错误码的情况下，可以加参数 isDev=1 来正常获得 Token，但此参数只适用于访问测试机，对生产机无效。 数据传送请求地址： ../ autoReqTran.shtml?token=&datatype=json 注意：请将放有数据文件的 ZIP 压缩包以文件流的形式放于请求的 POST 内容中。 参数说明：
token：通过上面请求地址获取的 token，有效期 10 分钟。需要在有效期内完 成数据上传，token 失效后不能再用于数据上传，但仍可用于查询对接结果。只有 在当前 token 失效后才可以申请一个新的 token（上传完成后 token 即失效）。
datatype: 返回结果为 JSON 格式。 返回结果 ： {
5/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
errorCode:'',//错误代码 errorStack:'',//错误堆栈－JAVA 格式 result:{
id:'',//token organid:'',//组织编号 loaddate:'',//上传时间 status:'',//当前状态；0：已上传，1：解压文件中，2：校验数据中，3：保 存数据中，4：处理成功，5：处理失败 errormsg:'',//如果处理失败，此处说明失败原因（如果错误信息过多将记 录在文件中，可登录对接系统点击查看相应的错误信息） checkgrade:'',//grade0:未入库记录数
3 校验规则： 3.1 请根据《数据对接接口校验规则》文档中要求完成对接数据的校验。 3.2 接口标准中定义的数据采集项必须符合值域范围要求。 3.3 费用相关的数据采集项要求保留两位小数。如位数不足，请以 0 补足。
4 实现自动对接： 4.1 医院软件开发人员自行开发数据信息抽取转换程序，实现自动数据对接功能。 4.2 使用 HTTP 协议调用对接 API 接口实现自动数据上传。调用程序不限制应用平台、 编程语言。 4.3 自动对接流程：
001008：当天已上传次数达到上限。
4/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
二、功能流程
•获取数据对接账户信息和帮助文档
第一步 •获取数据对接测试账户、对接接口标准和数据对接软件开发说明书等文档。
•设计开发数据信息转换程序 •根据数据对接接口标准及数据对接软件开发说明书，自行设计开发数据信息转换
第二步 程序，生成dbf文件。
•开发程序并上传测试数据包 •根据数据对接软件开发说明书中指定的测试系统请求地址，按分配的时间段利用
第六步 置。
•在生产系统中实现自动上传对接数据 •数据信息转换程序自动在每天规定时间段上传数据，生产系统每月定时自动生成
第七步 相关指标，医院数据录入员补填未自动生成的指标。
2/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
//grade1:入库达标，技术通道不达标记录数 //grade2:技术通道达标，接口标准不达标记录数 //grade3:接口标准达标记录数 //total:数据包记录总数 //grade:数据包等级 } } 错误代码： 003001：没有找到合适的数据-请检查 token 是否正确。 注意： 所有请求地址参数必须完整，如果没有值，请保持为空。datatype 参数为 JSON 格 式； 请求数据传送时，将压缩文件包以文件流的形式放置于 POST 内容中； 在数据传送请求时 token 必须在 10 分钟内使用，超时将失效； token 作为查询上传进度和校验结果的凭证，需要保存使用； 获取查询上传进度和校验结果时，编码格式为 UTF-8； 测试网址为：http://hqmststest.medidata.com.cn 请在不同环境下设置好相应的前辍域名。 5 查看数据对接报告： 利用数据对接测试系统账户登录 http://hqmststest.medidata.com.cn，点击左侧 “查 看数据对接”菜单项查看对接情况报告。 在查看数据对接列表中，根据“上传时间”找到相应数据对接记录，并点击查看数 据对接情况报告。 6 自行申请生产系统数据对接账户： 登录数据对接测试系统后点击“查看数据对接”菜单，确定每天定时上传的数据包
第三步 测试账户上传测试数据包。
•查看数据对接情况反馈报告
第四步 •利用数据对接测试账号登录数据对接测试系统，查看数据对接情况反馈报告。
•自行申请生产系统数据对接账号 •确认对接数据完整无误后，在测试系统点击“申请数据对接正式账户”按钮自行
第五步 开通生产系统数据对接账户。
•修改程序中数据请求地址 •将数据信息转换程序中的请求地址修改为生产系统数据对接账户及对接地址的配
1/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
注：系统会将数据对接账户信息和数据对接帮助文档发送到本医院 HQMS 系统数据填 报联系人邮箱中。
数据对接测试系统网址 http://hqmststest.medidata.com.cn
成功
对接成功
失败 （校验不通过、数据格式不符）
4.4 对接 API 接口说明： token 请求地址：
../docking/auto/gettoken.shtml?loginid=&pwd=&datatype=json 参数说明：
loginid：用户名 pwd：密码 datatype:返回结果为 JSON 格式
HQMS 数据对接软件开发说明书
发布日期：2012 年 11 月 2 日 本文档使用对象：医院软件开发人员
一、 概述
医院软件开发人员，所需文档如下： 《HQMS 数据对接技术通道工作说明书》（以下简称“技术通道说明书”） 《HQMS 数据对接软件开发说明书》（以下简称“开发说明书”） 《HQMS 数据对接接口标准》（以下简称“接口标准”） 《数据对接接口校验规则》 《RC020-ICD-10 诊断编码》 《RC021-ICD-10 形态学编码》 《RC022-ICD-9 手术编码》 Java 版本数据对接 Demo 程序
在数据对接测试系统中实现每天在规定时间段内自动获取最新的数据并成功上传的功 能后，可自行申请数据对接正式系统（以下简称“生产系统”）账户，申请成功后系统会自 动发送账户信息到本院 HQMS 系统数据填报联系人邮箱中。利用邮件中指定的生产系统网 址和对应的账户信息修改程序中的请求地址和账户配置，设置数据信息转换程序实现自动在 每天规定时间段内上传数据。生产系统会自动生成相关指标，医院数据填报人员补填未自动 生成的指标。
2 数据说明： 2.1 字段的先后顺序必须严格按照接口标准中指定的顺序进行排列。 2.2 数据类型说明： 字符：可以为任何字符； 数字：可以为整型或浮点型数据； 日期：格式为：日期时间型（yyyy-MM-dd HH:mm:ss）或日期型（yyyy-MM-dd）。 2.3 数据长度必须严格按照接口标准中进行限定，一个汉字占 2 个字节长度。 2.4 接口标准中“备注”里面有值域范围规定的，必须按照值域范围内的值进行填写。
succ:true|false,//成功｜失败，此参数只作为此次请求的结果 errorCode:'',//错误代码 errMsg :’XXX’, //错误描述 errorStack:'',//错误堆栈－JAVA 格式 result:{
id:'',//token date:''//上传文件所使用的时间（秒） } } 错误代码： 002000：无效或缺少参数值； 002001：无效的 token； 002002：token 已过期； 002003：token 已被使用； 002004：此 token 无权上传所请求的机构数据。 对接进度查询请求地址： ../docking/auto/findResult.shtml?token=&datatype=json 建议：此接口调用频率请设置为大于 1 分钟。 参数说明： token：通过上面的 token 请求地址获取，在数据传送请求后可随时使用 datatype: 返回结果为 JSON 格式 返回结果： { succ:true|false,//成功｜失败，此参数只作为此次请求的结果
3/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
获取对接数据 接口文档
调用接口获取 token
开发程序生成 数据文件
(完成格式、数据校验)
将数据文件打 包压缩为ZIP格
式
使用token进行 数据文件传输
使用token查询 对接结果
医院软件开发人员所需对接系统信息是以邮件形式发送至本院HQMS系统数据填报联 系人邮箱，内容包括：
1. 数据对接系统账户信息（密码只在第一次申请账户时发送）
2. 接收数据对接账户及文档相关信息的邮箱地址
3. 数据对接系统对应的（测试/正式）网址
4. 允Leabharlann Baidu上传对接数据的时间段
医院软件开发人员根据接口标准和开发说明书自行设计数据信息抽取转换程序，并生成 DBF 格式文件。利用数据对接账户、已分配的对接数据时间段和指定的对接系统网址上传 数据包，登录数据对接系统查看对接报告详情。
三、开发说明
1 文件说明： 1.1 上报文件格式：zip 1.2 生成数据文件格式：DBF 或 CSV 1.3 压缩包内最多可包含 2 个数据文件。 1.3.1 压缩包内 1 个数据文件：可生成大于 255 列字段的。 1.3.2 压缩包内 2 个数据文件：不能生成大于 255 列字段可生成 2 个数据文件。要 求文件命名必须以 part1 和 part2 字样结尾，并且 part1 和 part2 中数据以病案 号（P3）和入院日期（P22）进行关联，并可唯一标识出一条完整的病案信 息（要求在 part2 中 P3 为首列，P22 为第二列）。 1.4 数据对接周期： 1.4.1 每天在规定时间段内进行一次数据对接（数据对接测试系统中允许多次数据 对接）。 1.4.2 数据内容包括医院最新可上传的已出院患者病案数据。
可通过邮件中列出的生产系统数据对接账户信息，生产系统数据对接时间段，生产 系统网址修改相应的请求地址配置。 8 实现每天自动对接数据：
可通过邮件中列出的生产系统数据对接时间段修改数据信息转换程序实现自动在 每天规定时间段内上传数据。生产系统会自动生成相关指标，医院数据录入员补填未自 动生成的指标。
返回结果：
{ succ:true|false,//成功｜失败 errorCode:'',//错误代码 errorStack:'',//错误堆栈－JAVA 格式
result:{ token:''//token
} } 错误代码：
001001：用户名不存在； 001002：密码不正确； 001003：用户已被禁用； 001004：IP 被锁定（连续 5 次以上用户名或密码不正确）； 001005：没有数据对接权限。 001006:登录密码已到期，需要更改登录密码。 001007：当前时间不在允许对接数据的时间范围内。
6/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
均通过校验并处理完成。确认数据无误后医院软件开发人员可联系 HQMS 系统数据填 报联系人，告知可申请数据对接系统正式账户。数据填报联系人确认对接数据生成的指 标无误则点击“申请数据对接正式账户”按钮自行申请生产系统数据对接账户。系统会 自动将生产系统数据对接账户相关信息发送至本医院 HQMS 系统数据填报联系人邮箱 中。 7 获取生产系统账号信息修改 url：
说明：为了方便开发与调试，在返回 001008 错误码的情况下，可以加参数 isDev=1 来正常获得 Token，但此参数只适用于访问测试机，对生产机无效。 数据传送请求地址： ../ autoReqTran.shtml?token=&datatype=json 注意：请将放有数据文件的 ZIP 压缩包以文件流的形式放于请求的 POST 内容中。 参数说明：
token：通过上面请求地址获取的 token，有效期 10 分钟。需要在有效期内完 成数据上传，token 失效后不能再用于数据上传，但仍可用于查询对接结果。只有 在当前 token 失效后才可以申请一个新的 token（上传完成后 token 即失效）。
datatype: 返回结果为 JSON 格式。 返回结果 ： {
5/7 医院质量监测系统研究中心 电话: 4006 686 836 传真: 0755-33319061 网址: www.hqms.org.cn
errorCode:'',//错误代码 errorStack:'',//错误堆栈－JAVA 格式 result:{
id:'',//token organid:'',//组织编号 loaddate:'',//上传时间 status:'',//当前状态；0：已上传，1：解压文件中，2：校验数据中，3：保 存数据中，4：处理成功，5：处理失败 errormsg:'',//如果处理失败，此处说明失败原因（如果错误信息过多将记 录在文件中，可登录对接系统点击查看相应的错误信息） checkgrade:'',//grade0:未入库记录数
3 校验规则： 3.1 请根据《数据对接接口校验规则》文档中要求完成对接数据的校验。 3.2 接口标准中定义的数据采集项必须符合值域范围要求。 3.3 费用相关的数据采集项要求保留两位小数。如位数不足，请以 0 补足。
4 实现自动对接： 4.1 医院软件开发人员自行开发数据信息抽取转换程序，实现自动数据对接功能。 4.2 使用 HTTP 协议调用对接 API 接口实现自动数据上传。调用程序不限制应用平台、 编程语言。 4.3 自动对接流程：