业务协同平台HIS调用方案.DOC

1、业务协同平台 HIS 调用方案目录1 引言 .31.1 标识及修改历史 .31.2 系统概述 .31.3 文档概述 .32 引用文件 .43 需求 .53.1 接口调用流程 .53.2 接口设计 .63.2.1 设计原则 .63.2.2 接口发布 .63.2.3 调用规范 .63.2.4 接口方法 .63.2.5 方法入参 .63.2.5.1 入参说明（业务 XML） .73.2.5.1.1 登录数据 XML.73.2.5.1.2 业务数据 XML.73.2.5.2 入参说明（注意事项） .123.2.6 方法出参 .123.2.6.1.1 调用失败出参格式 .123.2.6.1.2 调用成功

2、出参格式 .133.2.7 调用出入参示例 .134 需求可追踪性 .175 接口数据字典 .175.1 医疗机构 .175.2 医护人员 .175.3 科室 .175.4 卡类型 .175.5 性别 .185.6 诊断类型 .185.7 中药使用类别 .185.8 药物类型 .195.9 药物剂型 .245.10 用药途径 .255.11 入院途径 .265.12 入院情况 .265.13 出院情况 .275.14 医疗付费方式 .271 引言1.1 标识及修改历史本文档中的接口定义、发布方式适合于业务协同平台 HIS 调用的所有业务模块。标识号标题 业务协同平台 HIS 调用缩略词语版本号

3、 V1.0发行号1.2 系统概述1.3 文档概述本文档针对业务协同平台 HIS 调用的业务模块的接口定义、发布方式进行约定。重点定义了接口的实现模式、信息的交换格式、接口的调用方法。本文档仅限于买方对本系统进行验收和直接维护的人员和卖方软件研发人员，保密原则根据开发合同中的约定执行。本文档对项目投资方和用户的保密要求如下： 保密内容：文档的所有内容。 涉密人员范围：仅限于对本系统进行验收和直接维护的人员。 保密期限：大于 20 年。 泄密责任：赔偿开发方的损失。2 引用文件1. 卫生部健康档案基本架构与数据标准（试行） 2009 年2. 卫生部2010 国家卫生统计调查制度2010 年3. 卫

4、生部城乡居民健康档案基本数据集2011 年 8 月3 需求3.1 接口调用流程选择病人传入病人基本信息获取协同工作列表获取协同工作列表是否有协同任务并进行操作 ？传入病人基本信息和诊疗信息诊疗业务协同业务操作是开始结束否否是否有协同任务并进行操作 ？是协同业务操作虚线框内为业务协同操作平台已注册 ？否平台个人注册注册成功 ？是是否说明：1、业务协同平台调用的前提是，病人必须在平台上进行过注册，传入的病人基本信息，必须带有“平台患者唯一标识号” 。3.2 接口设计3.2.1 设计原则业务协同平台接口牵扯到多家厂商，使用了不同的开发技术，为了兼容所有厂家的 HIS，统一将接口封装为本地 restf

5、ul 接口，HIS 厂商统一通过本地restful 接口调用方式访问接口，所有调阅经过本地验证，确认无误后，再进行远程调用，在一定程度上确保了接口的安全。3.2.2 接口发布具体的发布的接口项目根据实际情况进行约定和发布。3.2.3 调用规范为了实现 HIS 系统与业务协同平台的“单点登录” ，在 HIS 系统调阅业务协同平台时，接口采用客户端注册的协议打开客户端，采用本地 http 接口方式进行数据的交互。我公司提供客户端调用 API 协议。3.2.4 调用方法3.2.4.1 URL 协议 APIUrl 协议 API 适用于 web 形式的 his，通过协同客户端安装程序安装完毕后，Wind

6、ows操作系统就已自动注册了启动协同客户端的自定义 Url 协议，然后即可在 web 中启动协同客户端。Url 协议如下：项 描述协议名 Synergyurl 格式 Synergy:/encode 便后后的 json 字符串关键调用代码 调用客户端或 window.location.href = “Synergy:/“ + encodeJson;3.2.4.2 Exe 命令行 APIExe 命令行 API 适用于客户端形式的 his，通过协同客户端安装程序安装完毕后，即可用通过命令行传参执行 SynergyCall.exe 来启动协同客户端。使用时建议将 SynergyCall.exe 文件放

7、在 his 客户端程序同目录中。命令行格式如下：项 描述命令说明协同客户端调用工具，因受命令行规则限制，json 参数中的双引号需用转义或用单引号代替，如：SynergyCall “a“: “A“, b: B, c: 100 参数说明 json 字符串关键调用代码 SynergyCall “a“: “A“, b: B, c: 100 3.2.4.3 RESTful API项 描述地址 http:/127.0.0.1:8081/open说明 请求协同客户端打开 web 网页请求类型 PostContent-Type 因跨域，必须为 application/x-www-form-urlencode

8、d参数 因跨域，必须通过 JSON.stringify 将对象转为 json 字符串传递响应对象 json 对象3.2.5 方法入参统一采用 JSON 格式的入参：名称 代码 类型 必填 注释业务JSON YWJSON String 是 规定格式的 JSON。3.2.5.1 入参说明（业务信息）业务信息又分为两部分，一是“登录数据” ，二是“业务数据”3.2.5.1.1 登录数据登录数据，结构体内容如下：名称 代码 数据类型 必填 注释机构代码 JGDM varchar(22) 是 编码，具体参照“医疗机构”字典说明机构名称 JGMC varchar(70) 是登录用户 DLYH varcha

9、r(40) 是 由业务协同平台分配给 HIS 系统的，一个机构固定一个用户登录密码 DLMM varchar(50) 是由业务协同平台分配给 HIS 系统的，一个机构固定一个密码，明码医生工号 YSGH varchar(64) 是HIS 系统登录“医生工号” 。编码，具体参照“医护人员”字典说明。医生姓名 YSXM varchar(30) 是 HIS 系统登录“医生姓名”3.2.5.1.2 业务数据业务数据分 12 部分：基本信息（JBXX） 、体征信息（TZXX） 、诊断信息（ZDXX） 、用药信息（YYXX） 、检验信息（JYXX） 、检查信息（ JCXX） 、手术信息（SSXX） 、门诊

10、就诊信息(MZJZXX)、入院信息(RYXX)、出院信息 (CYXX)、转诊信息(转出申请)(ZZXX_ZCSQ)、转诊信息（接诊信息） (ZZXX_JZXX)。下面具体说明各个部分的出参结构体内容：1、基本信息（一条记录）数据项 字段名 数据类型 必填 注释患者主索引 EMPI Varchar(64) 否 业务协同平台注册的患者唯一标识。卡类型代码 KLXDM Varchar(1) 是 编码。参照“卡类型”字典说明。卡号 KH Varchar(64) 是 同一病人同一种卡，卡号唯一。证件类型代码 ZJLXDM Varchar(2) 是 编码。参照“证件类型”字典说明。证件号码 ZJHM Va

11、rchar(32) 是姓名 XM Varchar(30) 是性别代码 XBDM Varchar(1) 是 编码。参照“性别”字典说明。出生日期 CSRQ Datetime 否 格式：YYYY-MM-DD居住地址 JZDZ Varchar(200) 否 居住地详细地址居住地-行政区划代码JZDXZQHDMvarchar(6) 可选 参照 GB/T 2260-2007 中华人民共和国行政区划代码居住地-地址编码 JZDDZBM varchar(9) 可选 参照地址信息表 ，尽量详细，最细可到“街道(乡镇)级”居住地-省市编码 JZDSSBM varchar(2) 可选 参照地址信息表中“省市级”编

12、码居住地-省市名称 JZDSSMC varchar(70) 可选居住地-地市编码 JZDDSBM varchar(4) 可选 参照地址信息表中“地市级”编码，对于“直辖市” ，该字段为空居住地-地市名称 JZDDSMC varchar(70) 可选居住地-区县编码 JZDQXBM varchar(6) 可选 参照地址信息表中“区县级”编码居住地-区县名称 JZDQXMC varchar(70) 可选居住地-街道(乡镇)编码JZDJDBM varchar(9) 可选 参照地址信息表中“街道(乡镇)级”编码居住地-街道(乡镇)名称JZDJDMC varchar(70) 可选居住地-村(居委)编码J

13、ZDCBM varchar(20) 可选 参照地址信息表中“村(居委)级”编码居住地-村(居委)名称JZDCMC varchar(70) 可选居住地-道路(街、路、弄等)编码JZDDLBM varchar(20) 可选居住地-道路(街、路、弄等)名称JZDDLMC varchar(70) 可选居住地-门牌号码 JZDMPHM varchar(70) 可选居住地-邮政编码 JZDYZBM varchar(6) 可选户籍地-详细地址 HJDXXDZ varchar(200) 可选户籍地-行政区划代码HJDXZQHDMvarchar(6) 可选 参照 GB/T 2260-2007 中华人民共和国行政

14、区划代码户籍地-地址编码 HJDDZBM varchar(9) 可选 参照地址信息表 ，尽量详细，最细可到“街道(乡镇)级”户籍地-省市编码 HJDSSBM varchar(2) 可选 参照地址信息表中“省市级”编码户籍地-省市名称 HJDSSMC varchar(70) 可选户籍地-地市编码 HJDDSBM varchar(4) 可选 参照地址信息表中“地市级”编码，对于“直辖市” ，该字段为空户籍地-地市名称 HJDDSMC varchar(70) 可选户籍地-区县编码 HJDQXBM varchar(6) 可选 参照地址信息表中“区县级”编码户籍地-区县名称 HJDQXMC varcha

15、r(70) 可选户籍地-街道(乡镇)编码HJDJDBM varchar(9) 可选 参照地址信息表中“街道(乡镇)级”编码户籍地-街道(乡镇)名称HJDJDMC varchar(70) 可选户籍地-村(居委)编码HJDCBM varchar(20) 可选 参照地址信息表中“村(居委)级”编码户籍地-村(居委)名称HJDCMC varchar(70) 可选户籍地-道路(街、路、弄等)编码HJDDLBM varchar(20) 可选户籍地-道路(街、路、弄等)名称HJDDLMC varchar(70) 可选户籍地-门牌号码 HJDMPHM varchar(70) 可选户籍地-邮政编码 HJDYZB

16、M varchar(6) 可选联系电话 LXDH Varchar(20) 否手机号码 SJHM Varchar(20) 否 如果有手机则填写手机号码就诊类型代码 JZLXDM Varchar(1) 是 编码。1.门诊；2.住院就诊流水号 JZLSH varchar(50) 是 本次门诊或住院的唯一 ID门诊号 MZH varchar(50) 否住院号 ZYH varchar(50) 否 住院的时候填写病案号 BAH Varchar(32) 否家属代配药标志 JSDPYBZ char(1) 是 编码：0 否 1 是2、体征信息（一条或多条记录）数据项 字段名 数据类型 必填 注释体征-项目代码 TZXMDM Varchar(32) 是 编码。参照体征类型字典说明体征-项目名称 TZXMMC Varchar(128) 是