HIS接口-完整版-.doc

《HIS接口-完整版-.doc》由会员分享，可在线阅读，更多相关《HIS接口-完整版-.doc（168页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、Four short words sum up what has lifted most successful individuals above the crowd: a little bit more.-author-dateHIS接口-完整版-文档版本：3文档版本：3.0版创建时间：2012年1月1日修订版本：3.0.2版修订时间：2014年04月30日版权所有：贵州精英企业科技发展有限公司联系电话：0851-6907222HIS接口详细调用规范(完整版)贵州精英企业科技发展有限公司目 录1.HIS接口概述41.1.概述部分编写目的41.2.HIS接口使用背景41.3.HIS接口实现描述

2、42.XML规范定义52.1.查询接口函数返回值XML规范52.2.非查询接口函数返回值XML规范62.3.码表数据上传XML规范62.4.业务数据上传XML规范73.接口数据流程描述83.1.接口框架图83.2.数据流程图83.2.1.流程说明83.2.2.各个流程含义和依赖关系描述94.码表接口定义104.1.科室码表上传接口104.2.用户码表上传接口104.3.储血点医院出库给其它医院码表115.业务数据接口定义115.1.病人基本信息接口115.1.1.添加病人基本信息115.1.2.修改病人基本信息115.1.3.删除病人基本信息115.1.4.数据结构表125.2.临床用血申请单

3、接口135.2.1.添加临床用血申请信息135.2.2.修改临床用血申请信息135.2.3.删除临床用血申请信息135.2.4.数据结构表135.3.交叉配血记录接口165.3.1.添加交叉配血记录信息165.3.2.修改交叉配血记录信息165.3.3.删除交叉配血记录信息165.3.4.数据结构表165.4.临床用血出库接口195.4.1.添加临床用血出库记录信息195.4.2.修改临床用血出库记录信息195.4.3.删除临床用血出库记录信息195.4.4.数据结构表195.5.输血不良反应接口205.5.1.添加输血不良反应记录信息205.5.2.修改输血不良反应记录信息205.5.3.删

4、除输血不良反应记录信息215.5.4.数据结构表215.6.发血给其它医院接口(具有储血点功能的医院使用)225.6.1.添加给其它医院出库记录信息225.6.2.修改给其它医院出库记录信息225.6.3.删除给其它医院出库记录信息225.6.4.数据结构表235.7.血液出库(报废、回退、科研用血、其它)接口245.7.1.添加血液出库记录信息245.7.2.修改血液出库记录信息245.7.3.删除血液出库记录信息245.7.4.数据结构表245.8.血液入库接口255.8.1.添加血液出库记录信息255.8.2.修改血液出库记录信息265.8.3.删除血液出库记录信息265.8.4.数据结

5、构表265.9.血袋回收报废接口275.9.1.添加血液回收报废记录信息275.9.2.修改血液回收报废记录信息275.9.3.删除血液回收报废记录信息285.9.4.数据结构表281. HIS接口概述1.1. 概述部分编写目的本文档为接口概要设计文档，目的在于和医院HIS系统开发单位进行接口协商，以了解我们接口提供方式、数据流程、数据流程关系这三部分是否符合双方的要求，以确保下一步接口详细设计工作的顺利开展。1.2. HIS接口使用背景各级卫生管理部门对血液公共卫生安全加强管理、需要对临床用血医院全过程业务信息进行联网管理，由于各医院HIS系统信息结构及软件设计各不相同，因此只能按卫生管理部

6、门统一的临床用血管理标准开放数据接口，由各医院自行调用接口写入数据，以完成全省血液信息联网管理，所有数据一经调用接口写入全省联网系统，则原则上不允许再修改和删除。1.3. HIS接口实现描述由HIS系统实时调用，接口的功能函数描述中，所有的数据类型都是逻辑描述。 DATE数据类型格式为“YYYY-MM-DD HH24:MI:SS”(19位长) NUMBER数据类型例：NUMBER(m,n)加小数点转成VARCHAR2为m+1位长字符串,n为小数精度,其中m 19,整数部分为 m n 位。 返回参数中的系统处理时间为接口服务器上设置的系统时间。 各功能函数描述中的业务输入参数中，对字段要求不能为

7、空的数据必须有相应类型的数据值，如果传空数据或数据类型不对应，则当成非法数据处理，返回相应非法调用代码。 对于码表数据可直接提交数据集进行上传，所有业务数据只能一条条数据提交，避免数据包过大而影响网络通信。通讯协议：本接口采Webservice技术，采用HTTP协议，接口部署于医院联网专用服务器上，需通过指定端口和用户名密码完成接口数据交互。接口部署方式：各联网机构需提供专用联网代理服务器，用于部署联网接口，代理服务器必须有双网卡，一张网卡通过外网与全省联网系统对接，一张网卡连内网通过接口完成与HIS系统对接。接口类型：分数据上行接口和数据下载接口。接口调用参数说明：调用任何接口均需要指定联网

8、机构的用户名和密码，以用户名和密码验证调用的合法性和联网单位的真实性，不属于联网单位当作非法调用。对于数据上行接口，前两个参数为用户名和密码，第三个参数为业务数据的XML结构(请参照XML规范要求，其各接口要求的XML字段名称及数据类型长度请参见接口数据结构表)；数据下载接口参数前两个为用户名及密码，之后的参数为查询条件，具体参数个数及参数意义查看各查询接口的定义，查询接口返回的数据集为XML，XML中的字段意见与接口数据结构表相同。2. XML规范定义XML规范定义原则为：每个XML根据业务模块定义，XML中包含的数据字段名称及意义请参见各接口的数据结构表。调用所有接口不管成功或者失败，都会

9、返回一个XML结构的反馈信息，主要分为查询接口返回的XML和非查询接口(如添加、删除、修改)返回的XML规范。查询接口和删除数据接口调用所传的参数不包含有XML结构，数据添加，修改等上行接口需要上传所提交的业务数据为XML结构。2.1. 查询接口函数返回值XML规范l 规范用途：用于查询时返回所查询的数据集。l 规范说明 查询时作为返回值将查询的结果集以XML字符串的形式输出，KeyField节点在查询返回时为空值，如果查询结果为多条记录，则RowSet下会存在多个Row节点。 l 规范格式：状态码错误信息查询返回记录条数主键值 l 参数说明参数名称参数类型参数约束参数说明状态码Number(

10、1)非空；取值范围约束0失败1成功用于表示输入或输出XML的状态错误信息Varchar(200)可为空用于表示的具体错误信息，无错误时为空记录条数Number(5)非空返回此次查询所得数据集的数据条数。主键值Varchar(200)查询返回时为空Row节点的字段名称请参见各接口的数据结构表2.2. 非查询接口函数返回值XML规范l 规范用途：用于所有的添加、修改、删除方法的返回值。l 规范格式：状态码错误信息记录条数主键值l 参数说明参数名称参数类型参数约束参数说明状态码Number(1)非空；取值范围约束0失败1成功用于返回执行是否成功错误信息Varchar(200)可为空用于返回执行的具体

11、错误信息，无错误时返回空记录条数Number(5)非查询时可忽略主键值Varchar(200)添加时成功时返回此条数据在联网系统中的主键值，HIS系统必须保存此字段值，用于调用更新或者删除接口。只有上传新增的数据时此字段有数据，否则为空。2.3. 码表数据上传XML规范l 规范用途：用于批量上传码表数据，所有码表数据必须批量一次性全部上传。l 规范说明：当码表为多条数据时，RowSet节点下存在多个Row节点。当码表数据有变化时也必须上传全部数据，不能只上传有变化的数据，接口后台对码表的处理方式为全部更新。 l 规范格式：记录条数l 参数说明参数名称参数类型参数约束参数说明记录条数Number

12、(5)非空此次上传的数据总条数Row节点的字段名称请参见各接口的数据结构表2.4. 业务数据上传XML规范l 规范用途：用于业务数据，如病人基本信息(病人病历)、临床用血申请单、交叉配血记录等。l 规范说明：不管是添加还是更新，一次只能上传一条数据，因此RowSet节点下只能存在一个Row节点。l 规范格式：记录条数l 参数说明参数名称参数类型参数约束参数说明记录条数Number(5)非空此次上传的数据条数，一次只能上传一条数据，因此字段为1Row节点的字段名称请参见各接口的数据结构表3. 接口数据流程描述3.1. 接口框架图3.2. 数据流程图3.2.1. 流程说明首先，以上流程图里每个方框

13、代表一个具体的，独立的数据流程。各个独立的数据流程之间关系是从上至下的，也就是说，增加数据时，必须先有上一个流程的数据，之后才能产生下一个流程的数据；反之，删除数据时，必须先把下一流程数据删除，才能删除上一流程数据。我方的接口方法（包括读出和写入）是以每个流程为基础来提供的，当用HIS系统调用接口往本系统写入数据时，我方也会遵循以上流程关系加以限制，保证进入本系统数据的完成性。在下面流程描述中会列出各个流程增加和删除数据之间的依赖关系。3.2.2. 各个流程含义和依赖关系描述l 基本信息填写含义：添加病人(受血者)的基本信息。添加数据依赖：无。删除数据依赖：申请单填写。l 申请单填写含义：根据

14、病人基本信息添加用血申请单。添加数据依赖：基本信息填写。删除数据依赖：用血登记。l 血液入库含义：所有入库数据，当供血单位送血时必须及时入库，以此参与计算库存。添加数据依赖：无。删除数据依赖：血液出库。l 血液出库含义：将库存中的血液出库供临床使用或其他用途。用途包括：临床用血出库(必须先做交叉配血)、报废出库、出库到其它医院、回退，其它科研用血出库等。添加数据依赖：血液入库。删除数据依赖：交叉配血。l 交叉配血含义：登记交叉配血结果信息，临床用血出库前，必须进行交叉配血，需先调用交叉配血接口后才能做临床用血出库。添加数据依赖：临床用血液出库、申请单填写。删除数据依赖：临床用血出库、不良反应、

15、血袋回收。l 不良反应含义：填写病人用血后所产生的不良反应。添加数据依赖：临床用血出库,交叉配血信息。删除数据依赖：血袋回收。l 血袋回收报废含义：对已回收的血袋进行报废处理。添加数据依赖：临床用血出库。删除数据依赖：无。4. 码表接口定义4.1. 科室码表上传接口接口方法名称：UpLoadDepartment(string uName, string uPws,string dataXml)接口类型：上行要求：当有数据变化上传全部数据调用说明：dataXml必须符合码表数据上传XML规范接口返回：非查询接口返回XML规范字段名称字段说明数据类型是否为空备注gd_id机构IDInt 否主键，必

16、须传入HIS系统业务表中与之对应的科室编码gd_name科室名称Varchar(100)否gd_remark备注Varchar(100)是4.2. 用户码表上传接口接口方法名称：UpLoadUserInfo(string uName, string uPws,string dataXml)接口类型：上行要求：当有数据变化上传全部数据调用说明：dataXml必须符合码表数据上传XML规范接口返回：非查询接口返回XML规范字段名称字段说明数据类型是否为空备注UserId用户IDInt 否主键，在HIS系统中与业务表关联的数字或编码NameCode用户名Varchar(50)否HIS系统中用户登录名

17、realname用户真名Varchar(50)否PwdVarchar(50)4.3. 储血点医院出库给其它医院码表接口方法名称：UpLoadOtherHos(string uName, string uPws,string dataXml)接口类型：上行要求：当有数据变化上传全部数据调用说明：dataXml必须符合码表数据上传XML规范接口返回：非查询接口返回XML规范字段名称字段说明数据类型是否为空备注hosId其它用血医院IDInt 否主键hos_name医院名称名称Varchar(100)否5. 业务数据接口定义5.1. 病人基本信息接口5.1.1. 添加病人基本信息接口方法名称：Add

18、PatientInfo (string uName, string uPws,string dataXml)接口类型：上行要求：追条上传调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XML规范5.1.2. 修改病人基本信息接口方法名称：UpdatePatientInfo (string uName, string uPws,string dataXml)接口类型：上行要求：血型及RH不能随意修改，当已经有交叉配记录、临床申请单记录、发血记录等时必须先删除这些记录才能修改血型及RH。调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XM

19、L规范5.1.3. 删除病人基本信息接口方法名称：DeletePatientInfo (string uName, string uPws,string Provider_NO)接口类型：上行要求：先删申请单、交叉配血记录、发血记录、不良反应记录等才能删除基本信息调用说明：Provider_NO为联网系统中的主键值，此字段值在添加成功时反馈给HIS系统，HIS系统必须事先保存此字段，删除时必须凭此字段进行删除。接口返回：非查询接口返回XML规范5.1.4. 数据结构表字段名称字段说明数据类型是否为空备注Provider_NO病人信息编号Varchar(50)否主键，与业务数据表关联，HIS系统

20、调用添加接口时，返回此字段值，HIS系统必须保存此字段，以用于修改和删除。,添加时XML里此字段为空，更新时XML里此字段不能为空。disease_no病案号Varchar(20)否如果是急诊用血没有病案号时，则输入“-”Provider_Name姓名Varchar(50)否Provider_IDCardNO身份证号Varchar(18)Provider_Sex性别Varchar(10)否男或女Provider_Age年龄Varchar(50)否Provider_Age_unit年龄单位Varchar(4)否只能是：岁、月、天、小时Provider_Bloodtype血型Varchar(10)

21、否Provider_BloodtypeRHRHVarchar(10)否Provider_Nation民族Varchar(50)传入中文donInHosDate患者入院时间Datetime否donCsrq出生日期DatetimedonHjszd户籍所在地Varchar(200)donMoveTel患者手机号码Varchar(11)donTel联系电话Varchar(50)oprWork_Id操作人员IDInt 否关联用户表中的用户IDBZ备注Varchar(100)5.2. 临床用血申请单接口5.2.1. 添加临床用血申请信息接口方法名称：AddApplyInfo (string uName,

22、string uPws,string dataXml)接口类型：上行要求：追条上传调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XML规范5.2.2. 修改临床用血申请信息接口方法名称：UpdateApplyInfo (string uName, string uPws,string dataXml)接口类型：上行要求：如果已经存在发血记录，则不能修改。调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XML规范5.2.3. 删除临床用血申请信息接口方法名称：DeleteApplyInfo (string uName, string

23、uPws,string ta_id)接口类型：上行要求：先删申请单、交叉配血记录、发血记录、不良反应记录等才能删除基本信息调用说明：ta_id为联网系统中的主键值，此字段值在添加成功时反馈给HIS系统，HIS系统必须事先保存此字段。删除时必须凭此字段进行删除接口返回：非查询接口返回XML规范5.2.4. 数据结构表字段名称字段说明数据类型是否为空备注ta_id申请单IDint 否主键，添加成功后返回的XML里有此主键值，必须保存于HIS系统中。添加时XML里此字段为空，更新时XML里此字段不能为空。ta_ISurgent紧急用血标志Varchar(50)否“是”或“否”ta_cure_agre

24、e_sign输血治疗同意书签定标志int否1：同意0：不同意ta_certificate_no无偿献血证号Varchar(50)ta_transfase_pretime预定输血日期Datetime否ta_recblooder_info_no受血者基本信息编号Varchar(50)否外键，来源病人基本信息表 Provider_NOta_disease_no病案号Varchar(20)否来源病人基本信息表 disease_nota_provider_name受血者姓名Varchar(50)否来源病人基本信息表 Provider_Nameta_provider_IDCardNO身份证号Varchar

25、(18)来源病人基本信息表 Provider_IDCardNOta_provider_sex性别Varchar(10)否来源病人基本信息表 Provider_Sexta_provider_age年龄Varchar(50)否来源病人基本信息表 Provider_Ageta_provider_bloodtype血型Varchar(10)否来源病人基本信息表 Provider_Bloodtypeta_provider_bloodtypeRHRHVarchar(10)否来源病人基本信息表 Provider_BloodtypeRHta_department申请用血科室IDInt 否外键，来源科室码表 g

26、d_idta_disease_area病区Varchar(20)否ta_bed_no床号Varchar(20)否ta_diagnose临床诊断Varchar(200)否ta_transfuse_aim输血目的Varchar(200)否ta_useblood_history输血史Varchar(200)有或无ta_childbear分娩史Varchar(50)有或无ta_narcosis麻醉史Varchar(50)有或无ta_surgername手术名称Varchar(50)ta_suitsymptom输血适应症Varchar(100)ta_gestation妊娠史Varchar(50)有或无t

27、a_apanage_id受血者属地IDInt 8：本地；9：外埠ta_transfuse_mete预定输血量Decimal(7,2)单位：mlta_self_mete自体输血量Decimal(7,2)单位：mlta_help_mete互助用血量Decimal(7,2)单位：mlta_card_mete凭证用血量Decimal(7,2)单位：mlta_xuehongdanbai血红蛋白Varchar(50)ta_hctHCTVarchar(50)ta_platelet血小板Varchar(50)ta_altALTVarchar(50)ta_hbsagHbsAgVarchar(50)ta_anti

28、_hcvAnti-HCVVarchar(50)ta_anti_hivAnti-HIV1/2Varchar(50)ta_lues梅毒Varchar(50)ta_element_name1申请产品名称1Varchar(50)否本接口前定义一次输血不超过5个品种,如果产品超过,请联系我公司扩展接口。如果不足5种，请HIS系统自行排序从申请产品1开始，不足产品数量的保持为空。ta_mete1申请产品血量1Decimal(9,2)否ta_unit1申请产品单位1Varchar(10)ta_element_name2申请产品名称2Varchar(50)ta_mete2申请产品血量2Decimal(9,2)

29、ta_unit2申请产品单位2Varchar(10)ta_element_name3申请产品名称3Varchar(50)ta_mete3申请产品血量3Decimal(9,2)ta_unit3申请产品单位3Varchar(10)ta_element_name4申请产品名称4Varchar(50)ta_mete4申请产品血量4Decimal(9,2)ta_unit4申请产品单位4Varchar(10)ta_element_name5申请产品名称5Varchar(50)ta_mete5申请产品血量5Decimal(9,2)ta_unit5申请产品单位5Varchar(10)ta_volunte_me

30、te可无偿用血量Decimal(9,2)单位：mlta_apply_doctor_id申请医师Varchar(50)否ta_cure_doctor_id主治医师(审核医生)Varchar(50)否ta_writer_id操作人员IDInt 外键，关联用户码表 UserIdta_apply_time申请时间Smalldatetime否ta_volunteer_sign是否无偿献血标志Bit 0：不是1：是ta_remark备注Varchar(100)ta_apply_JoinOutNo申请单联号号Varchar(50)医院申请单打印编号,默认与申请单内部编号一致ta_providerBlood_

31、No血样编号Varchar(50)默认为申请单联号,当血样采集时间在3天之类,可两张申请单同用一个血样。ta_providerBlood_CollDate血样采集时间Datetime否默认为申请申请日期5.3. 交叉配血记录接口此接口只要求上传交叉配血的最终结果信息，如一个患者血样与同一袋血进行我次配血，则只取最终使用的一条结果信息。5.3.1. 添加交叉配血记录信息接口方法名称：AddAcrotestInfo (string uName, string uPws,string dataXml)接口类型：上行要求：追条上传调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接

32、口返回XML规范5.3.2. 修改交叉配血记录信息接口方法名称：UpdateAcrotestInfo (string uName, string uPws,string dataXml)接口类型：上行要求：如果已经存在发血记录和不良反应记录，则不能修改。调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XML规范5.3.3. 删除交叉配血记录信息接口方法名称：DeleteAcrotestInfo (string uName, string uPws,string bi_id)接口类型：上行要求：先删除发血数据和不良反应数据,才能删除此表数据。调用说明：bi_id为联

33、网系统中的主键值，此字段值在添加成功时反馈给HIS系统，HIS系统必须事先保存此字段。删除时必须凭此字段进行删除接口返回：非查询接口返回XML规范5.3.4. 数据结构表字段名称字段说明数据类型是否为空备注bi_id交叉 配血IDInt 否主键，与业务表关联，在临床用血出库需要使用此字段添加时XML里此字段为空，更新时XML里此字段不能为空。bi_apply_id申请单表IDInt 否外键，来源临床用血申请单 ta_idbi_info_no受血者基本信息编号Varchar(50)否外键，来源病人基本信息 Provider_NObi_disease_no病案号Varchar(20)否来源病人基本

34、信息 disease_nobi_provider_name受血者姓名Varchar(50)否来源病人基本信息 Provider_Namebi_provider_sex性别Varchar(10)否来源病人基本信息Provider_Sexbi_provider_age年龄Varchar(50)否来源病人基本信息 Provider_Agebi_provider_bloodtype血型Varchar(10)否来源病人基本信息 Provider_Bloodtypebi_provider_bloodtypeRHRHVarchar(10)否来源病人基本信息 Provider_BloodtypeRHbi_tr

35、ansfuse_type_id输血性质IDInt 40：紧急；41：大量；42：常规bi_hdsr_id血液入库IDInt 否来源血液入库表 hdsr_idbi_blooder_no献血者编号Varchar(50)融余，来源血液入库表 hdsr_blooder_nobi_product_no血液产品编号Varchar(50)否外键,来源血液入库表 hdsr_product_nobi_spec规格Decimal(11,2)融余，来源血液入库表 hdsr_specbi_bloodunit血液单位Varchar(20)融余，来源血液入库表 hdsr_unitbi_blood_type供血者血型复检V

36、archar(10)否只能是：A、B、AB、Obi_blood_rh供血者rh复检Varchar(10)否只能是：+、-bi_checkup_result患者者复检血型结果Varchar(2)否只能是：A、B、AB、Obi_checkup_result_RH患者者复检血型(RH)结果Varchar(2)否只能是：+、-bi_dispensation_method1交叉配血方法1Varchar(200)否bi_dispensation_method2交叉配血方法2Varchar(200)bi_dispensation_result交叉配血试验最终结果结果Varchar(200)否(合格、不合格)

37、或(无溶血无凝聚、溶血、凝聚)bi_filter_result患者不规则抗体筛选结果Varchar(200)bi_filter_result_xxz献血者不规则抗体筛选结果Varchar(200)阴性/阳性bi_main_rx主侧溶血VarChar(10)否bi_main_nj 主侧凝集VarChar(10)否bi_side_rx 次侧溶血VarChar(10)否bi_side_nj次侧凝集VarChar(10)否bi_else_result其他检查结果Varchar(200)bi_crossprice交叉配血费Decimal(9,2)bi_groupprice聚凝安费Decimal(9,2)

38、bi_acidprice酸溶血实验费Decimal(9,2)bi_checkuper_id1复检者IDInt 否外键，来源privi_def_userinfo User_Idbi_dispensater_id1配血者IDInt 否外键，来源privi_def_userinfo User_Idbi_checkupDate复检日期samlltime否默认1900-01-01实际为配血日期bi_dispensateDate配血日期samlltime否默认1900-01-01bi_remark备注Varchar(100)5.4. 临床用血出库接口5.4.1. 添加临床用血出库记录信息接口方法名称：AddSendBloodInfo (string uName, string uPws,string dataXml)接口类型：上行要求：追条上传，发血时间不能小于配血和临床用血申请单时间，所发的血如果有效期小于当前系统时间则不能发血调用说明：dataXml必须符合业务数据上传XML规范接口返回：非查询接口返回XML规范5.4.2. 修改临床用血出库记录信息接口方法名称：UpdateSendBloodInfo (string uName, string uPws,string dataXml)接口类型：上行要求：发血时间不能小于配血和临床用血申请单时间，所发的血如果有效期小于当前系统