实例体检系统接口方案-贵州医科附属医院

1、医学附属医院体检系统接口方案版本 V1.2修改说明版本号日期作者内容V1.12017-03-9初稿V1.22017-05-19新增：4 退费申请接口、5 科室获取接口V1.22017-06-9所有接口增加正式上线地址目录修改说明2目录31.总体说明51.1 信息交换方式51.2 消息格式说明52.HIS 与院内自助机的业务功能模块52.1 自助机当日挂号52.1.1 接口流程说明52.1.2 接口定义52.5 自助机发院内就诊卡122.5.1 接口流程说142.5.2 接口定义143.编码说明36证件类型36. 36代码37支付方式37医院代码37错误代码表37绑定签约标志错误!未定义书签。代

2、码错误!未定义书签。出诊时间段38卡类型38关系38市医保保险类别错误!未定义书签。患者类型39医保调用医保接口标识(AdmSource)错误!未定义书签。市医保卡卡类型错误!未定义书签。4.通信录395.关键流程接口调用步骤说明及示例错误!未定义书签。5.1 挂号、取号错误!未定义书签。5.2 退号错误!未定义书签。5.3 门诊缴费错误!未定义书签。5.1 门诊退费：错误!未定义书签。1. 总体说明1.1 信息交换方式1. 与医院体检系统通讯均采用 Web Service 方式。1.2 消息格式说明Web Service 消息格式采用 XML 格式：请求报文是以 Request 为根节点的X

3、ML 串，应答报文是以 Response 为根节点的 XML串。1.3 要求用户登录工号必须与 HIS 系增。其它要求见具体接口定义致；若体检系统有工号新增；需与 HIS 系起新2. HIS 与医院体检系统的业务功能模块2.1 当日挂号2.1.1 接口流程说明通过获取患者基本信息。获取科室列表信息获取医生列表信息查询排班挂号2.1.2 接口定义2.1.2.1 通过、证件号获取患者基本信息(3300)(已核对)OK接口地址ice.cls(测试)请求消息：示例330012341001ATM011001gyy00103e.cls(正式)接口方法GetPatInfo交易代码3300接口描述由或唯一号(

4、注:东华称登记号)查出患者基本信息，当不空时用，为空时用唯一号，也可以通过证号码查询患者基本信息。接口协议WebService+XML，Socket+XML主要使用者第机构名称设定值说明数据类型长度项TradeCode3300交易代码String4TranionId交易流水号String20YExtCode预约机构String20YCntType客户端类型String20YTerminalID终端编码String20YHospitalId医院唯一编号String4YExtUserID操作员代码String20YPatientCardString50与ID 、证号不能同时为空CardType卡类

5、型String10输入时PatientIDIDString50与 、号不能同时为空DVAnumber号18与、ID 不能同时为空Password账户6只传入身份证号时， checkType为 1 且身份证号、ID、只输入了证号才会校 验 密码，传明文checkType校验方式21 为；2 为；只输入身份证号时应答消息：示例PatName患者儿童补卡时DOB出生日期儿童补卡时Phone患者儿童补卡时名称说明数据类型长度备注ResultCode交易结果：0：成功String4非 0：错误ResultContent对错误/异常的详细描述信息，交易不成功时输出String256PatientIDIDS

6、tring50PatientNameString50SexCode代码String10SexString10DOB出生日期String10ID病案号String60Address家庭住址String255IDTypeCode证件类型（代码）String18IDTypeDesc证件类型（描述）String18IDNo证件号String50ephoneNoString11Mobile号String11ContactName联系人StringContactIDCard联系人号StringRelation联系人关系StringContactNo联系人StringContactName1联系人Strin

7、gContactIDCard1联系人号String2.1.2.5 挂便民号(1101)(已核对)OK请求消息：示例0000270820202接口地址e.cls (测试)e.cls(正式)接口方法OPDocFastRegistBroker交易代码接口描述供第系统完成自助便民挂号接口协议WebService+XML，Socket+XML主要使用者第机构Relation1联系人关系StringContactNo1联系人StringContactName2联系人StringContactIDCard2联系人号StringRelation2联系人关系StringContactNo2联系人StringAc

8、tiveCardNum有效卡String应答消息：名称说明数据类型长度ResultCode交易结果：String4示例名称设定值说明数据类型长度项PatientID患者 PatientID,登记号String4YCTLocCode科室代码(实为科室 ID) 100String20YUserCode操作员代码String20YGROU安全组 ID 229String20Ydoctor902.5 发院内就诊卡2.5.1 接口流程说由外部系统先发起就诊卡查询交易(3013)，如果患者没有就诊卡，允许外部系统再发起发就诊卡交易(3014)。2.5.2 接口定义2.5.2.1 就诊卡查询（3013）(已

9、核对)OK请求信息：交易编码3013接口地址(测试)(正式)接口方法FindPatientCard描述根据证件类型、证件号、查询患者的就诊卡。请求消见“请求信息”表应答消见“返回信息”表服务提供者HIS传输格式XML0：成功非 0：错误ResultContent对错误/异常的详细描述信息String256AdmId就诊 ID返回信息：以 Request 为根节点的 XML 串.子节点定义详见下方的说明.3013名称说明数据类型格式是否项TradeCode交易代码char(4)3013YIDType证件类型Char(3)以 HIS 代码表为准YIDNo证件号码char(18)YPatientNa

10、me患者char(40)YCardTypeCode卡类型代码Char(10)以 HIS 代码表为准YPatientCardChar(19)YUserID用户 IDChar(20)YTerminalID自助机终端号Char(20)2.5.2.2 发就诊卡（3014）(已核对)OK交易编码3014接口地址(测试)(正式)接口方法SavePatientCard描述传入就诊卡、证件类型、证件号码、出生日期等信息，返回处理结果、患者 ID 等信息。请求消见“请求信息”表应答消与接口的返回信息一致以 Response 为根节点的 XML 串.子节点定义详见下方的说明名称说明数据类型是否项TradeCode

11、交易代码char(4)YResultCode结果标志（0可以发卡、-1不能发卡、-50 此已存在，-51 已存在同类型的卡）Char(3)YErrorMsg错误信息Char(256)YCardDeitAmt就诊卡卡押金Char(19)请求信息：以 Request 为根节点的 XML 串.子节点定义详见下方的说明.3014服务提供者HIS传输格式XML1名称说明数据类型格式是否项TradeCode交易代码Char(4)3014YCardTypeCode卡类型代码Char(10)以 HIS 代码表为准YPatientCard就诊Char(19)YSecurityNo就诊卡Char(20)11111

12、1ChipSerialNo序列号Char(20)PatientType患者类型Char(6)以 HIS 代码表为准YPatientName患者Char(40)儿童补卡时YSexChar(1)以 HIS 代码表为准YDOB出生日期Char(10)YYYY-MM-DD（儿童补卡时）YIDType证件类型Char(3)以 HIS 代码表为准YIDNo证件号char(20)与 ContactIDCard其一YMobile号(个人,)char(11)儿童补卡时YMaritalSus状况Char(2)以 HIS 代码表为准Nation民族char(20)以 HIS 代码表为准YOccupation职业ch

13、ar(3)以 HIS 代码表为准Nationality国籍Char(6)以 HIS 代码表为准Address家庭住址char(60)AddressLocus家庭所在地char(60)Zipchar(6)Company工作char(60)CompanyAddr所在地char(60)CompanyZipchar(6)CompanyNochar(15)ephoneNo(家庭电话,)char(15)ContactName联系人(联系人)char(20)ContactAddress联系人地址(联系地址)char(60)Relation与患者关系(关系)char(10)以 HIS 代码表为准Contact

14、No联系人(联系)char(15)ContactIDCard联系人号char(60)儿童补卡时ContactName1联系人(联系人)char(20)ContactIDCard1联系人号char(60)Relation1与患者关系(关系)char(10)以 HIS 代码表为准ContactNo1联系人(联系)char(15)ContactName2联系人(联系人)char(20)ContactIDCard2联系人 2号char(60)Relation2与患者关系(关系)char(10)以 HIS 代码表为准ContactNo2联系人(联系)char(15)PayModeCode支付方式：1=现

15、金2=Char(20)CardDeitAmt卡金额PayBCode支付Char(20)PayCardNo支付Char(20)PayTradeStr支付交易信息串（应该包括 代码、支付 、银行交易日期、交易流水号）Char(1000)ChargeDeitA mt交易金额(含卡费)Char(19)YAccountPasswor d院内账户(无需加密，Char(50)Y返回信息：以 Response 为根节点的 XML 串.子节点定义详见下方的说明名称说明数据类型是否项TradeCode交易代码char(4)YPatientCard就诊Char(19)YMD5)TheArea所属地区Char(50)

16、TranionId交易流水号UserID用户代码TerminalID终端号3、医嘱处理3.1 接口流程说明3.1.1 医嘱由挂号(2.1.2.5)产生就诊ID(AdmNo 即 2.1.2.5 出参中的 AdmRowid 字段)；医嘱主要为了和结果回传，医嘱时需要将单价的数值放到 OrderQty 数量上进行插入；同时将体检系统中的医嘱项目名称放入 Note 字段进行。3.2.2 医嘱状态改变第系统登记向 HIS 端发起申请改变医嘱状态为执行。第系统取消登记向 HIS端发起申请改变医嘱状态为核实。3.2 接口定义3.2.1 AddOrderItem 添加医嘱信息接口定义：SecurityNo就诊

17、卡Char(20)PatientID患者 IDchar(12)成功时为项ResultCode结果标志（0成功、-1失败、-50 此已建卡、-51 已有同类型的卡）Char(3)YErrorMsg错误信息Char(256)YActiveFlag是否需要激活标志(0不需要激活就能正常使用；1存在多个患者 ID，需要激活后才能在医院内使用；2医保患者需确认、激活后才能在医院内使用；)Char(1)TranionId交易流水号Char(20)CardInvInfo卡费用押金信息Char(500)请求消息：示例接口方式(测试)提供服务供第系统调用(正式)接口方法AddOrderItem接口描述在第系统就

18、诊之后，医生新增医嘱时，第系统将医嘱信息传回到HIS系统。如果医嘱中有药品医嘱，将优先级为“自备”，并把药品名称添加到医嘱备注里。接口提供方东华集成代码名称数据类型约束说明AdmNo就诊号NOT NULLVARCHAR(20)IDExtRowID外部医嘱 RowIDNOT NULLVARCHAR(20)第 系统产生此医嘱的唯一标识:采用 P+条码形式OrderTypeCode医嘱类型NOT NULLVARCHAR(5)ArcimCode医嘱字典代码NOT NULLVARCHAR(20)医嘱项目 IDArcimDesc医嘱字典名称NOT NULLVARCHAR(50)OrderSus医嘱状态VA

19、RCHAR(5)未核实”U”OrderQty数量( 自定义价格医嘱时传入价格,his 单NOT NULLVARCHAR(5)医嘱数量价需要设置成 1)OrderDeptCode开医嘱科室代码NOT NULLVARCHAR(20)静配中心代码OrderRecDepCode接受科室代码NOT NULLVARCHAR(20)静配中心代码OrderDoctorCode开医嘱人代码NOT NULLVARCHAR(20)操作代码OrderDoctor开医嘱人VARCHAR(50)OrderUserCode录入人代码NOT NULLVARCHAR(20)操作代码OrderUserDesc录入人名称VARCH

20、AR(50)OrderSttDat要求执行医嘱日期VARCHAR(20)YYYY-MM-DDOrderSttTim要求执行医嘱时间VARCHAR(20)HH:MM:SSInsuTypeCode医保类型代码VARCHAR(5)LinkOrdID关联医嘱 RowidVARCHAR(20)关联医嘱 IDPHFreqCode频次代码VARCHAR(5)药品医嘱不能为空UomCode代码VARCHAR(5)药品医嘱不能为空DosageCode剂型代码VARCHAR(5)药品医嘱不能为空UsageCode药品用法代码VARCHAR(5)药品医嘱不能为空SpecCode标本代码VARCHAR(5)检验医嘱不

21、能为空SpecDesc标本名称VARCHAR(20)检验医嘱不能为空Note备注自定义价格医嘱需要传入第系统医嘱的名称描述VARCHAR(300)Queues成组Source来源NOT NULLVARCHAR(2)默认：1InsuFlag是否按医保处理VARCHAR(5)Y：按医保处理N：按自费处理应答消息：3.2.2 改变医嘱状态接口说明：输入消息:接口地址(测试)(正式)接口方法ModifyOrderSus接口描述改变医嘱状态，用于执行医嘱和取消执行医嘱接口协议Web Service+XML主要使用者系统代码名称数据类型约束说明ResultContent响应信息VARCHAR(300)NO

22、T NULLResultCode响应码VARCHAR(6)NOT NULL0 ：成功其他： 失败OrdRowID医嘱号VARCHAR(30)NOT NULL示例0成功应答消息：示例应答消息说明代码名称数据类型长度（字节）ResultCode交易结果：0：成功String示例E 5157705|1 doctor输入消息说明代码名称数据类型约束Sus状态(E 为执行,V 为核实,D为停止)String必填OrdItemRowId医嘱 IDString必填UserCode用户工号String必填3.2.3 查询医嘱缴费情况接口说明：输入消息:示例 5157705|15157705|25157705|

23、3doctor输入消息说明代码名称数据类型约束OrdItemRowId医嘱 ID 串，多个 ID 以String必填接口地址(测试)(正式)接口方法GetBillFlagByItemId接口描述改变医嘱状态，用于执行医嘱和取消执行医嘱接口协议Web Service+XML主要使用者系统非 0：错误ResultContent错误信息描述String应答消息：4、门诊退费示例应答消息说明代码名称数据类型备注ResultCode交易结果：0：成功 非 0：错误StringResultContent错误信息描述StringOrdItemRowIdBill成功与否标记医嘱 ID缴费状态标记缴费状 态描述

24、成功与否标记医嘱 ID缴费状态标记缴费状态描述。String成功与否标记：0-成功，非 0-失败缴费状态标记：E-错误描述，P-已缴费，R-已申请退费，I-已退费，B-未缴费分割UserCode用户工号String必填4.1 接口流程说明4.1.1 门诊退费申请门诊发生已缴费需要退费的医嘱时，调用申请成功后方可退费;药品类医嘱不允许调用接口4.2 接口定义4.2.1Verify 门诊退费申请接口说明：输入消息:示例 5157705|1doctordoctor接口地址(测试)(正式)接口方法Verify接口描述退费申请，用于已缴费非药品医嘱的退费申请接口协议Web Service+XML主要使用

25、者系统应答消息：5、科室资料获取5.1 接口流程说明5.1.1 科室资料获取获取 HIS 科室信息，用于医嘱和退费申请示例应答消息说明代码名称数据类型备注ResultCode交易结果：0：成功 非 0：错误StringResultContent错误信息描述String输入消息说明代码名称数据类型约束OrdItemRowId医嘱 IDString必填UserCode用户工号String必填CTLocCode申请科室代码String必填52 接口定义：5.2.1 Department 科室资料获取请求消息：应答消息（示例）：示例0获取科室成功 GetIPLoc 93名称说明数据类型长度项示例非空即可接口地址(测试)e.cls(正式)接口方法Department接口描述取科室信息接口协议WebService+XML主要使用者静脉配液系统名称说明数据类型长度（字节）72分娩室fmshszYW分娩室3