预约挂号平台HIS接口设计

1、文档编号：密 级：预约挂号系统接口设计说明书（HIS部分）编制： 审核： 批准： 2010年 10 文档修改记录编号版本号修订日期修订说明编写者审核者1V1.0.02010-11-1创建汪凌2V1.0.12010-12-10汪凌1 总体设计1.1 总体要求预约挂号系统平台与各医院HIS之间是一对多的接入关系，因医院HIS系统各不相同：建设厂家不同，版本不同，环境不同；与平台间的网络连接方式也存在差异。为保证平台的兼容性和可扩展性，要求该接口规范具备高通用性，可跨平台、跨语言实现，且适用于不同的网络环境和硬件设备。1.2 系统拓扑1.3 模块说明本文档涉及的接口应用布署于拓扑图中的“医院His前

2、置”上。预约挂号系统包括两大类应用：一 HIS向预约挂号平台上传预约挂号系统所需的基本信息（如：医院信息、科室信息、医生信息、排班信息、停诊信息等）和其他交易信息（如：患者预约后的实际就诊情况、患者投诉情况、患者注册信息等）。该类交易平台为服务端，HIS为客户端。平台方提供DLL函数接口，供HIS调用。二 平台向HIS发起的实时交易请求（如：预约挂号、预约取消、患者信息向医院传送等）。该类交易平台为客户端，HIS为服务端。HIS提供存储过程供平台调用。三 详细业务部分请参阅省预约挂号平台业务操作规范.doc2 平台与医院HIS接口平台与医院HIS前置之间采用TCP/IP通讯协议，建立两对SOC

3、KET端口（互为客户/服务端）：一对用于医院HIS系统发起的交易（HisToEbs），一对用于平台发起的交易(EbsToHis)。其中客户端作为发送数据端口，服务端作为接收数据端口。HIS作为客户端时，通过调用平台提供的DLL函数发起交易请求；HIS作为服务端时，向平台开放存储过程。交易方式采用短链接的方式。在一个TCP/IP连接上完成数据包的发送和接收，在成功发送了一个数据包，并收到成功应答后，即中断该连接。HisToEbs和EbsToHis均采用同步方式。文件传输采用FTP方式。2.1 HisToEbs该接口主要用于HIS系统向平台传输院方相关基础及变更信息，如：医院介绍、科室设置、医生、

4、排班等。该接口的实现采用HIS调用Dll函数的方式，Dll函数接口由平台提供。函数封装了底层通讯协议和交易逻辑。2.1.1 初始化服务器设置Int SetIpAndPort(char*szHospitalID,char *szIp,int nPort)函数说明：设置医院编号、His Server（HIS前置）的ip和端口号。在HIS系统启动（初始化）时加载调用，必须先调用该函数进行初始化，否则会提示调用失败。输入参数：szHospitalID 医院ID，由省平台统一分配（6位字符）szIp HIS前置服务器的ip，如02，具体到实施时确定 nPortHIS前置服务器的po

5、rt，如8098（最大65535），具体到实施时确定输出参数：无返回值：0 成功1 连接服务器失败2.1.2 HIS数据上传Int SendPack(char *szTradeCode,char *szOperNo,char *szSendContent,char *szRet);函数说明：向中心服务器发送数据通讯包输入参数：szTradeCode （字符串） 交易代码（4位字符） szOperNo （字符串） his系统中的操作员号 szSendContent （字符串）本次发送的数据报文 输出参数：szRet（字符串） 调用成功返回交易定义的返回结果，调用失败则为调用失败的具体原因，如报文

6、格式不正确等。返回值：0 调用成功1 调用失败附：szTradeCode 的取值说明1101 医院信息上传处理1102 科室信息上传处理1103 医生信息上传处理1104 排班信息上传处理1105 停诊信息上传处理1106 预约就诊情况上传处理1107 查询平台某排班剩余号源数量1108 患者姓名信息修改szSendContent 的取值格式：各字段间以“|”分隔，如内容为空则直接加“|”。处理结果存放在szRet中，szRet的取值格式：各字段间以“|”分隔，如内容为空则直接加“|”。 医院信息上传序号字段类型/长度备注必填1变更类型Char/10:新增；1：修改； 2：删除y

7、1医院名称Varchar2/50医院全称y2医院机构代码Varchar2/6y3医院介绍Varchar2/1000y4地址Varchar2/100y5医院等级Char/4三甲;三乙y6医院性质Char/4公立;民营;合资;外资;其他y7医院类别Char/4综合;专科n8公开电话Varchar2/50加区号n9网址Varchar2/50n 科室信息上传序号字段类型/长度备注必填1变更类型Char/10:新增；1：修改；2：删除y2科室编号Varchar2/20科室在医院内的IDy3科室名称Varchar2/20y4科室描述Varchar2/200科室描述y5对应标准码Varchar

8、2/20科室对应的标准科室代码(到群共享里找)y6年龄限制char/10:无限制 1:14周岁以上2:18周岁以下y7变更时间datetimeYyyymmdd24hhmmssy 医生信息上传 医生是跟排班相关联的，没有相应的排班是看不到医生信息的。序号字段类型/长度备注必填1变更类型Char/10:新增；1：修改； 2：删除y2医生编号Varchar2/20医生在HIS中的主键y3医生名称Varchar2/20Y4医生性别Char/2男 ;女Y5医生职称Varchar(30)n6医生学历Varchar2(10)n7医生简历Varchar2/200n8医生介绍Varc

9、har2/200N9照片Varchar2/20照片文件名称N10变更时间datetimeYyyymmddhhmmss(小时是24小时制，如20110401235800)Y 排班信息上传 第一次新增排班则立即生效,修改排班要下一周期生效。序号字段类型/长度备注必填1变更类型Char/10:新增；1：修改；2：删除修改排班须由His先做判断,若影响到已预约患者,则不允许修改y2排班IDLong排班在HIS中的主键Y3星期Char/11:星期一。7:星期天Y4科室代码Varchar2/20Y5医生工号Varchar2/20可以为空n6挂号类别Char(2)00：普通，11

10、：专家Y7挂号费Varchar2/10Y8诊疗费Varchar2/10Y9上午号源Varchar2/200例如： 1,8:30&3,9:00&5,9:30&或者：10-20，8:30-9:00 &50-60,10:00-10:30&62:1:00上下午号源至少有一个不为空10下午号源Varchar2/20011变更时间DatetimeYyyymmddhhmmss(小时是24小时制，如20110401235800)y12变更生效日期Date为了尽量避免影响已经预约出去的排班，请医院尽可能提前制定排班变更计划，而不是立即更新排班。(yyyymmdd)n13变

11、更失效时间DateYyyymmdd1314人均就诊时间int以分钟为单位n 停诊信息上传序号字段类型/长度备注必填1变更类型Char/10：增加1：修改 2： 删除y2停诊计划IDLong停诊计划在HIS系统的主键Y3排班IDLong排班在HIS系统中的主键Y4停诊/恢复标志Char/11:停诊(将正常排班置为停诊) 2:恢复(将停诊排班恢复正常)若部分恢复,则将原停诊全恢复,再按实际停诊时间分别做停诊处理y5开始日期Date排班停诊/(恢复)开始日期yyyymmddY6结束日期Date排班停诊/(恢复)结束日期yyyymmddY7上午停诊标志Int-1：停诊 1：不停诊Y8下午

12、停诊标志int-1：停诊 1：不停诊Y9停诊原因Varchar2(100)n10变更时间DatetimeYyyymmddhhmmss(小时是24小时制，如20110401235800)使用数据库系统时间Yyyymmdd24hhmmssy 预约就诊情况上传序号字段类型/长度备注必填1取号代码Char/8预约取号代码y2是否取号Char/10：违约未取号 1：取号 2：取号后退号 3:未取号但不违约Y3取号时间DatetimeYyyymmddhhmmss(小时是24小时制，如20110401235800)Yyyymmdd24hhmmssn4就诊时间DateTimeYyyymmddhh

13、mmss(小时是24小时制，如20110401235800)Yyyymmdd24hhmmssn5医嘱时间DateTimeYyyymmddhhmmss(小时是24小时制，如20110401235800)Yyyymmdd24hhmmssn6最后收费时间DatetimeYyyymmddhhmmss(小时是24小时制，如20110401235800)Yyyymmdd24hhmmssn7取药时间DatetimeYyyymmdd24hhmmssn8不违约原因Varchar2/50仅在“是否取号”状态为3时使用n9卡类型Char/1本次就诊使用何种卡:0省医保 1市医保 2市民卡 3农保 。n10卡号码Va

14、rchar2/25n11本次就诊卡号Varchar2/25n 患者姓名信息修改序号字段类型/长度备注必填1患者编号varchar/10y2患者姓名varchar/20y2.2 EbsToHis该接口用于平台向医院HIS提交实时交易请求，并获取HIS方交易结果。该接口由HIS提供数据库存储过程包。HIS前置机布署了HisServer程序，接受到平台交易任务后，调用该接口包中的存储过程来完成交易。HIS系统对平台提供一个数据库存储过程包，包名为：BookPackage，存储过程名为：BizExec。该存储过程有4个参数。序号输入/输出参数名称类型说明1输入参数交易类型int2输入参数

15、交易参数Varchar2/4000根据交易类型拼装的字符串3输出参数交易结果Int0：交易成功1：交易失败4输出参数交易输出Varchar2/4000如果交易成功的话，根据交易类型返回不同的交易结果，如果交易失败的话，返回交易失败的原因2.2.1 患者信息传送到医院并验证（HIS）本平台为实名使用，因此患者在平台注册时需提供个人必备的身份信息，平台在本地记录患者信息。当该患者通过平台向某家医院预约挂号时，需将相关信息传送到医院HIS系统，如果该患者填写了本人医保卡、市民卡或就诊卡等信息时，将这些信息同步传送到医院进行校验。同一个有效证件号码只允许注册一条记录，未成年人通过此平台预约挂号，看病时

16、需持有效证件。交易名称：患者信息注册（医院）功能说明：把患者在平台注册的信息传送到医院HIS系统中，同一个有效证件号码只允许注册一条记录(未成年人看病需持有效证件)，这个规则由平台实现。交易类型：2001输入参数：该参数由多个字段拼成一个字符串形成，各个字段之间用“|”符号区隔，每次交易只能传入一个患者信息。字段说明如下表：序号字段类型/长度说明必填1患者IDvarchar2/10患者在平台的IDY2患者姓名Varchar2/20患者姓名y3性别Char/2男 女y4证件类型Char/10:身份证 1:军官证 2:驾驶证 3: 其他（护照、台胞证、港澳证）y5证件号码Varchar2/30y6

17、医保卡类型Char/10：省医保 1：市医保 2：市民卡3：农保 n7医保卡号Varchar2/25n8电话号码Varchar2/12y9联系地址Varchar2/255n10联系邮编Varchar2/50n交易结果：0（成功）或者1（失败）输出参数： 如果交易成功：序号字段类型/长度说明必填1校验结果Char/10：在HIS中找到医保卡信息，且与姓名匹配1：找到卡号但姓名不匹配2：没有找到卡号如果交易失败：序号字段类型/长度说明必填1错误原因Varchar2/50His交易处理逻辑：当前置机调用本交易时，接口首先根据患者ID查找HIS内是否存在患者记录，如果存在，则修改；否则插入新的记录。2

18、.2.2 预约挂号患者在与平台对接的服务商处进行医院、科室、医生、排班（何时就诊）的选择，确定某一排班后提交预约挂号请求，由平台将该预约请求提交医院His系统。交易名称：预约挂号功能说明：患者在与平台对接的服务商处进行预约挂号，由平台将预约请求提交医院His系统。交易类型：2002输入参数：该参数由多个字段拼成一个字符串形成，各个字段之间用“|”符号区隔，每次交易只能传入一个预约信息。字段说明如下表：序号字段类型/长度说明必填1患者IDvarchar2/10患者在平台的IDY2就诊日期Char/8yyyymmddy3上午/下午Char/10:上午 1：下午y4排班IDChar/10在医院的排班

19、IDy5取号凭证代码char/88位（在1周时间内）不可重复。随机编码，可0开头，不可字母。y6预约序号Char/2预约在（上午/下午）的第几位就诊 y7服务商编码Char/4y8工号Varchar2/15若为电话服务商，则为操作员工号；若为网络服务商，则为用户IPy交易结果：0（成功）或者1（失败）输出参数： 如果交易成功：序号字段类型/长度说明必填1空如果交易失败：序号字段类型/长度说明必填1错误原因Varchar2/50His交易处理逻辑：当前置机调用本交易时，接口应判断患者预约的号源是否可用。2.2.3 取消预约该交易为“预约挂号”交易的反向交易，即对原交易进行取消。注意：业务约定，就

20、诊当天7点开始后不能取消预约交易名称：预约挂号取消功能说明：患者在与平台对接的服务商处进行预约挂号的取消，由平台将预约取消请求提交医院His系统。交易类型：2003输入参数：该参数由多个字段拼成一个字符串形成，各个字段之间用“|”符号区隔，每次交易只能传入一个预约取消信息。字段说明如下表：序号字段类型/长度说明必填1就诊日期Char/8yyyymmddy2取号凭证代码char/88位（在1周时间内）不可重复。随机编码，可0开头，不可字母。y3患者编号Char/10y交易结果：0（成功）或者1（失败）输出参数： 如果交易成功：序号字段类型/长度说明必填1空如果交易失败：序号字段类型/长度说明必填1错误原因Varchar2/502.2.4 查询预约结果该交易查询某笔预约交易在HIS的交易状态，在特殊情况下（如网络异常）当不确定双方交易状态是否一致的时候，用来确认His方的交易状态。