《金华城市用血实时联网平台接口规范.docx》由会员分享，可在线阅读，更多相关《金华城市用血实时联网平台接口规范.docx（41页珍藏版）》请在课桌文档上搜索。
1、金华城市用血实时联网平台接口规2020年5月目录目录1文档介绍51.1 文档目的51.2 文档范围51.3 术语与缩写解释62接入准则72.1 接入指南72.1.1 接入环境72.1.2 接入拓扑图72.1.3 交互频度72.2 请求结构82.2.1 请求地址82.2.2 字符编码82.2.3 数据类型说明82.3 通讯技术92.3.1 SOAP92.3.2 WSDL92.3.3 WebService92.4 访问控制92.4.1 获取Token92.4.2 使用Token92.5 HTTP状态码103接口规范113.1 认证接口113.2 获取基础数据接口113.2.1 获取医院机构字典11
2、3.2.2 获取血站机构字典123.2.3 获取血液品种字典133.3 医院血液预订接口143.3.1 提交血液预订单143.3.2 取消血液预订单153.3.3 根据过去一周查询血液预订单状态16334根据预订单号查询血液预订单详情173.4 血站发血交接单入库接口193.4.1 根据交接单号查询血站往医院出库单详情193.4.2 医院接收确认血站交接单213.5 提交医院库存信息213.5.1 提交当前库存血袋汇总信息213.5.2 提交当前库存血袋明细信息233.6 提交医院接收血站发血入库信息243.7 提交医院输血申请信息253.8 提交医院出库到临床信息293.9 提交医院血袋报废
3、信息323.10 提交医院输血不良反应信息334错误响应354.1 错误响应354.2 错误响应格式354.3 错误码355数据字典375.1 ABO血型375.2 Rh(D)IfILS375.3 出入库类型375.4 身份证件类型385.5 医院科室代码385.6 输血目的代码405.7 输血申请类型405.8 血液失效原因405.9 输血反应类型411文档介绍1.1 文档目的本规范适用于穿越医院联网管理平台与医院相关系统之间、以及与各外部数据系统之间的同步数据交换传输。规范规定了传输过程中系统结构、协议与通讯模式。本规范适用于通过接口实现从医院输血科系统把医院临床用血信息实时数据上报的医院
4、，不适用于没有使用输血科系统的医院。1.2 文档范围本文阐述内容仅限穿越医院联网管理平台对接标准接口规范,对业务流程不做详细阐述。本文档阐述内容囊括医院临床用血信息联网所需要的所有接口,医院需要严格按照标准规范进行匹配，以保证医院与城市用血实时联网平台的对接，实现全市用血信息业务数据同步。1.3 术语与缩写解释序号缩写、术语解释说明1HTTPBasicAuthenticationHTTPBasicAuthentication是一种允许客户端提供用户名和口令为凭证的形式访问受保护的资源2HIS系统医院信息管理系统简称3LIS系统实验室信息管理系统简称4BIS系统血站信息管理系统简称2接入准则2.
5、1 接入指南血站搭建部署在卫生专网开放的标准化接口，医院通过调用标准化接口，上报临床用血情况等信息。从而实现数据的交互。标准化接口采用HTTP/HTTPS协议，发布接口API,由各联网医院的“输血科系统”单向调用接口API,进行数据传输。2.1.1 接入环境接口程序能够访问：政务网http:/:/hoslinkws/services/Hoslink?wsdl2.1.2 接入拓扑图2.1.3 交互频度数据上报为保证信息的及时性，业务数据要求在业务发生时及时上报，当天的库存统计数据需要在当天晚上12点前上传。调用控制血液中心发血数据具有实时性，血液中心发出血液的业务完成后，医院需通过接口获取发血单
6、信息及血液制品信息。为保证接口服务的调度，接口请求进行了流量控制，每个IP每秒5次，每分钟15次。超出请求控制的请求会被拒绝。2.2 请求结构2.2.1 请求地址服务地址WebService:http:/:/hoslinkws/services/Hoslink?wsdl通讯协议使用HTTP协议，支持通过HTTPS协议2.2.2 字符编码请求及返回结果都使用UTF-8字符集进行编码。2.2.3 数据类型说明数据类型的描述规则见下表:数据类型表示符描述定长字符串型字符长度表示符（N）,其中N表示该字符串的长度变长字符串型字符串在字段描述中定义最大长度数字型数字长度表示符（N,M）,其中N表示该数字
7、的最长长度，包括整数位数、小数点（算一位）、小数位数；M表示该数字的最长小数位数布尔型布尔用字符“1”表示true,字符“0”表示false日期型日期用定长字符串表示，格式为YYYY-MM-dd日期时间型日期时间用定长字符串表示，格式为YYYY-MM-ddHH:mm:ss,24小时制二进制型二进制二进制数据类型，如图象、音频、视频等二进制流文件格式。2.3 通讯技术通过适配器，客户端连接到中心端开放的WebSerVice,在同步传输技术中使用到了下面的技术。2.3.1 SOAP简单对象访问协议(SimPleobjeCtACCeSSPrOtoeoI),SOAP是基于XML的简易协议，可使应用程序
8、在HTTP之上进行信息交换。或者更简单地说：SOAP是用于访问网络服务的协议。2.3.2 WSDLWSDL指网络服务描述语言(WebServicesDescriptionLanguage)999-l,datamull,msg:错误信息成功返回codeQ,dataLinstitutionJSON,msg:巧institution天!象说明属性名数据类型长度属性说明id数值16机构IDname字符串32机构名称available数值40-无效；1-有效返回结果InstitutionJSON格式:code:。，data:id:3,name:宁德市医院,，available:1)3.2.2 获取血站机
9、构字典描述获取平台上所有血站机构字典，包括分血站。方法StringlistStation(Stringtoken);参数说明Stringtoken:访问token返回值code:,data:，msg:失败返回code:-999-l,data:null,msg:错误信息成功返回code:OJdata:Station,m$g：Station对象说明属性名数据类型长度属性说明deptld数值16机构IDname字符串32血站名称返回结果Station格式：(msg:查询成功,code:,0,data:deptld:,name1:XX血站,deptld:,name:XX血站3.2.3 获取血液品种字典
10、描述获取平台上血液品种信息字典。血液预定和血站发血等信息，需要根据统一血液品种来分类数据。方法StringlistBloodType(Stringtoken);参数说明StringtOken:访问token返回值code7datar,7msg:)失败返回code*999-l,datamull,msg:错误信息成功返回code:Ozdata:bloodTypeJSON,msg:successbloodType对象说明属性名数据类型长度属性说明id数值8血液品种idname字符串32血液品种名称unit字符串4血量单位：ML-代表亳升；U-代表单位available数值40-无效：1-有效返回结果
11、HoodTypeJSON样例：code:,0,data:(id:1,name:单采血小板，available:13.3 医院血液预订接口3.3.1 提交血液预订单描述向血站平台提交血液预订单，定义所需要血液品种的血量，血型等信息方法StringnewBooking(Stringtoken,StringbookingJSON);参数说明Stringtoken:访问tokenStringbookingJSON:血液预订单JSON返回值code:,data:,msg:失败返回code:-999-1,PataLnuIIJmsg:错误信息成功返回COde：0;data平台预订单ID：msg:succes
12、sbookingJSON对象说明属性名数据类型长度是否必填属性说明id字符串21否预订单号，提交后自动生成OriginalId字符串21否医院原始预订单号type字符串4是预定类型：E-代表紧急：N-代表常规：P-代表备血PlanlIseDate字符串20是计划用血时间格式yyyy-MM-ddHH:mm:ssremark字符串4否备注bkBy字符串4是预定人姓名status字符串8是状态：NEW-新建：CONFIRM-已确认：CANCEL-取消StationId数值2是血站的编号参考机构字典BkingDetail字符串1240是预订血液明细，参见bookingDetail对象说明Booking
13、DetaiI对象说明属性名数据类型长度是否必填属性说明id字符串21否预订单号，提交后自动生成detailid字符串21否明细号，提交后自动生成OriginalDtlId字符串21否医院原始预订单明细IDbloodType数值4是血液品种类型ID,参见BIOOdTyPe对象说明bldProduct字符串8是血液产品码，参见BloodPrOdUCt对象说明aboGroup数值2是ABO血型rhGroup数值2是Rh(D)血型bkVolume数值62是预定血量replyVolume数值6,2否回复血量,血站审批填写replyStatus字符串8否回复状态：WAITAGREE待审核FULL-全部满足
14、：PARTML-部分满足：NoNE-不满足Booking样例(包含bookingDetail)：type:N,zPlanUseDate:2019-08-1509:22:27,remark:sdsdd,bookBy:星恒123,BookingDetaiI:(bloodType,:5,bloodProduct:faboGroup:2,rhGroup:ltbookVolume:2.0】，Stationld:2)3.3.2 取消血液预订单描述向血站平台，对已经提交的血液预订单，需要撤回，不再预定方法StringcancelBooking(Stringtoken,Stringbookingld);参数说
15、明StringtokenrtJtokenStringbookingld:血液预订单号；使用平台返回预订单号，非医院原始预定单号返回值code7data7msg:)失败返回code:-999-l,data:null,msg:错误信息成功返回code:OJdatamull,msg:SUCCeSs3.3.3 根据过去一周查询血液预订单状态描述查询本医院提交的血液预订单的状态，定否已经被确认，预订血液是否满足，以及被满足的血量，只查询过去一周内的预订单方法StringlistRecentBooking(Stringtoken);参数说明Stringtoken:访问token返回值code:,data:
16、,msg:失败返回code:-999-l,data:null,msg:错误信息成功返回code:0,data:booking对象数组(参见booking对象说明),msg:SUCCeSs,返回booking对象数组格式:code:0,data?(id:OD-OOOO3,type,N,planUseDate:2019-09-2809:22:27,remark：sdsdd,bookBy:星恒123,status:NEW,BookingDetail4(bl。OdTyPe:5,bloodProduct:123123,aboGroup:2,rhGroup:1,bookVolume:2,replyVolu
17、me:0,replyStatus:WAIT_AGREE)Lstationld:2,OD-OOOo1,type:,planseDater2019-09-2809:22:27,“remark:SdSdd,bookBy:星恒123”,status/CANCEL,uBookingDetaiI:(bloodTpe5,bloodProduct,z123123,aboGroup:2,rhGroup:l,bookVolume:2,replyVolumeM:0,replyStatus:WAIT_AGREELstationld:23.3.4 根据预订单号查询血液预订单详情描述根据与订单号，查询本医院提交的血液预订
18、单的详情信息方法StringgetBookingByld(Stringtoken,Stringbookingld);参数说明Stringtoken:访问tokenStringbookingld:预定单号返回值code:”Jdata失败返回code:-999-l,data:null,msg:错误信息成功返回code:0;data:booking对象(参见booking对象说明),msg:SUCCeSsBooking对象，各式code:O,data:id:OD-003ztype:N,PlanUseDate:2019-09-2809:22:27,remark:sdsdd,bookBy:星恒123,s
19、tatus:NEW,BookingDetaiI:(bloodType:5,bloodProduct:123123,aboGroup:2,rhGroup:1,bookvolume:2.0,replyVolume:0.0,replystatus:WAIT_AGREE,stationld:23.4 血站发血交接单入库接口3.4.1 根据交接单号查询血站往医院出库单详情描述根据交接单号查询血站往本医院的发血交接单详情方法StringgetStationOutByld(Stringtoken,StringStationOutId,StringStationHospitaIId);参数说明Stringto
20、ken:访问tokenStringStationOutId:交接单号StringStationHospitaIId:血站/分站id,参考3.2.2获取血站机构字典接口返回值code7data7msg:)失败返回code*999-l,datamull,msg:错误信息成功返回code:。,data)StationOut对象,msg:SUCCeSsStationOut对象说明属性名数据类型长度属性说明id字符串21交接单号OutStockTine字符串20出库时间格式yyyy-MM-ddHH:mm:SSstatus字符串8出库单状态：N-血站已出库医院未确认；C-医院已确认bloodBags字符串
21、4960血袋对象数组BloodBagBIoodBag对象说明属性名数据类型长度属性说明bldBagId字符串32血袋编号donationld字符串18献血序列号bloodProduct字符串8血液产品码，参见获取血液产品接口bloodType数值4血液品种ID,参见获取血液品种接口aboGroup数值2ABo血型代码，参见ABO血型字典rhGroup数值2Rh(D)血型代码，参见Rh(D)血型字典donationDate字符串20献血日期格式yyyy-MM-ddHH:mm:ssProductionDate字符串20制备日期格式yyyy-MM-ddHH:mm:ssexpirationDate字符
22、串20失效日期格式yyyy-MM-ddHH:mm:ssvolume数值6,2血量unit字符串4血量单位：ML-毫升；U-单位：bagld字符串20产品号血袋唯一标识StationOut对象格式：code:。，data:id:,PD-005fOUtStockTime:2018-10-2208:58:18,status:N,bloodBags:bloodBagld:355E,donationld:355,bloodProduct:E,bloodType:5,aboGroup:2,rhGroup:1,donationDate:2018-10-0813:36:00,1ProductionDate:2
23、01840-0913:31:2V,expirationDate:2018-11-1213:36:00,volume:2.0,unit:U,bagld:355,bloodBagld:,455E,zdonationld:455,zbloodProduct:E,bloodType:13,aboGroup:1,rhGroup:1,donationDate:2018-10-1314:48:00,productionDate:2018-10-1512:57:51,expirationDate:2019-10-1314:48:00,volume:100.0,unit:ml,bagld:3553.4.2 医院
24、接收确认血站交接单描述通知血站联网平台，本医院已经确认接收到出库交接单数据，入库时只操作未确认的交接单。方法StringconfirmStationOut(Stringtoken.StringStationOutId);参数说明Stringtoken:访问token：StringStationOutId:交接单号返回值失败返回code:-999-l,data:null,msg:错误信息成功返回code:0,data:nulmsg:SUCCeSs3.5 提交医院库存信息3.5.1 提交当前库存血袋汇总信息描述往血液联网平台上报本医院当前的库存汇总信息，每1小时上传一次。方法Stringpolnv
25、entorySum(Stringtoken,StringInventorySumJSON);参数说明StringInventorySumJSON:库存汇总对象JSON;返回值code,dataz,7msg|:)失败返回code*999-l,datamull,msg:错误信息成功返回code:0,data:null,msg:inventorySumJSON对象说明属性名数据类型长度必填属性说明SUIDnlary字符串10240是库存汇总数组，参见SUninIa叮对象说明SUmrnary对象说明属性名数据类型长度必填属性说明bldType字符串4是血液品种ID,参见获取血液品种接口aPosVol数
26、值6,2是当前该血液品种A阳性血袋总库存血量bPosVol数值6,2是当前该血液品种B阳性血袋总库存血量oPosVol数值6,2是当前该血液品种0阳性血袋总库存血量abPosVol数值6,2是当前该血液品种AB阳性血袋总库存血量aNegVol数值6,2是当前该血液品种A阴性血袋总库存血量bNegVol数值6,2是当前该血液品种B阴性血袋总库存血量oNegVol数值6,2是当前该血液品种0阴性血袋总库存血量abNegVol数值62是当前该血液品种AB阴性血袋总库存血量unit字符串4是血量单位:ML-毫升;U-单位InventorySum对象格式：(summary:bloodType,:1,aP
27、osVol:0,bPosVol:1,oPosVol:0,abPosVol:0,aNegVol:0,bNegVol:0,oNegVol:0,abNegVol:0,unit:ml)3.5.2 提交当前库存血袋明细信息描述往血液联网平台上报本医院当前的库存明细信息，每1小时上传一次。方法StringpolnventoryBld(Stringtoken,StringinventoryBldJSON);参数说明StringInventoryBIdJSON:库存明细对象JSON;返回值code:7data:；msg:失败返回code*999-l,datamull,msg:错误信息成功返回code:(Vda
28、tamuH,msg:巧InventoryBldJSON对象说明属性名数据类型长度必填属性说明CurrentDate字符串11是当前日期格式yyyy-MM-ddbloodBags字符串102400是库存血袋数组，参见bloodBag对象说明InventoryBId对象格式：CurrentDate:2017-01-01,bloodBags:bloodBagld:,201D,donationld:200,bloodProduct:D,bloodType:13,aboGroup:0,rhGroup:1,donationDate:2018-08-1015:45:00,productionDate:201
29、8-08-1010:04:32,expirationDate:2018-08-1015:45:00,volume:225.0,unit:ml,bagld:025H)3.6 提交医院接收血站发血入库信息描述往血液联网平台上报本医院接收血站发血入库的血液信息，实时上传数据。方法StringpolnStock(Stringtoken,StringInStockJSON);参数说明StringinStockJSON:血液入库对象JSON;返回值失败返回code:-999-l,data:null,msg:错误信息成功返回code:。,datamull,msg:SUCCeSs”InStockJSON对象说
30、明属性名数据类型长度必填属性说明id字符串21是入库单号StationId字符串16是血站机构编号（默认传2,如果是分血站请传相应分站机构id）OUtStockId字符串21是血站发血交接单号InStockDate字符串20是入库时间格式yyyy-MM-ddHH:mm:ssInStockBy字符串16是入库人姓名bloodBags字符串12400是入库血袋数组，参见bloodBag对象说明InStockJSON对象格式:id:2333,Stationld:2,OUtStockId:233,inStockDate:2018-01-0100:00:00,inStockBy:,王小二“，remark
31、:,bloodBags:bloodBagld:201D,donationld:200,bloodProduct,:D,bloodType:13,aboGroup:1,rhGroup:1,donationDate:2018-08-1015:45:00,ProductionDate:2018-08-1010:04:32,expiratioDate:2018-08-1015:45:00,volume:225.0,unit:mbagld:200)3.7 提交医院输血申请信息描述往血液联网平台上报输血中请信息，实时上传数据。方法StringpoApplication(Stringtoken,String
32、application);参数说明Stringtoken:访问token;Stringapplication:输血申请对象JSON;返回值失败返回code:-999-l,data:null,msg:错误信息成功返回code:0,data:nulmsg:SUCCeSsapplication对象说明属性名数据类型长度必填属性说明id字符串21是申请单号叫pIyDate字符串20是申请日期格式yyyy-MM-ddHH:mm:ssapplyBy字符串16是申请医师姓名approveDate字符串20是审批日期格式yyyy-MM-ddHH:mm:ssapproveBy字符串16是审批医师姓名applyT
33、ype数字4是输血申请类型代码，参见输血申请类型字典planDate字符串20否预约输血日期格式yyyy-MM-ddHH:mm:sstransPurpose字符串4是输血目的代码，参见输血目的字典iSConsentSigned字符串1是是否已签输血知情同意书0-否1-同意patient字符串480是病人病案信息，参见Patient对象说明bldTest字符串480否病人输血指征，参见bloodTest对象说明applyBloods字符串1240是申请血液数组,参见applyBlood对象说明bloodTest对象说明属性名数据类型长度必填属性说明hbsag字符串10否HbSag指标NEGATI
34、VE-阴性PoSTlVE-阳性antiHbs字符串10否anti_hbs指标NEGATlVE-阴性POSTlVE-阳性hbeag字符串10否Hbeag指标NEGATlVE-阴性POSTlVE-阳性antiHbe字符串10否anti_hbe指标NEGATIVE-阴性POSTlvE-阳性antIHbc字符串10否anti.hbc指标NEGATlVE-阴性PoSTIVE-阳性antiHcv字符串10否antijcv指标NEGATIVE-阴性POSTIVE-阳性antiHiv字符串10否anti_hiv指标NEGATIVE-阴性PoSTIVE-阳性syphilis字符串10否SyPhiIiS指标NEG
35、ATIVE-阴性PoSTIVE-阳性HB数值6,2否血红蛋白HCT数值6,2否红细胞压积PLT数值6,2否血小板计数PT数值6,2否凝血酶原时间AFTT数值6,2否活化部分凝血活酶时间INR数值6,2否inr数值ALT数值6,2否alt数值FIB数值6,2否血浆纤维蛋白原TEG数值6,2否teg数值applyBlood对象说明属性名数据类型长度必填属性说明bloodType数值4否血液品种ID,参见BldType对象说明aboGroup数值2否ABO血型代码，参见ABO血型字典rhGroup数值2否Rh(D)血型代码，参见Rh(D)血型字典applyVolume数值6,2否申请血量applyU
36、nit字符串2否血量单位：ml-毫升;U-单位application对象格式：id:2333”,applyDate:2018-01-0100:00:00,applyBy:五小二，approveDate:2018-01-0100:00:00,approveBy:王大二”,applyType:1,planDate:2018-01-0100:00:00,transPurpose:1,IsConsentSigned:1,patient:id:3,name:张三，sex:MALE,age:18Y3M2D,aboGroup:1,rhGroup:1,idCardType:1,department:100,“area:华南大区，bedNo:405,diagnosis:情况良好，everPregna
