實例體檢系統(tǒng)接口方案-貴州醫(yī)科附屬醫(yī)院

1、醫(yī)學(xué)附屬醫(yī)院體檢系統(tǒng)接口方案版本 V1.2修改說明版本號日期作者內(nèi)容V1.12017-03-9初稿V1.22017-05-19新增：4 退費申請接口、5 科室獲取接口V1.22017-06-9所有接口增加正式上線地址目錄修改說明2目錄31.總體說明51.1 信息交換方式51.2 消息格式說明52.HIS 與院內(nèi)自助機的業(yè)務(wù)功能模塊52.1 自助機當(dāng)日掛號52.1.1 接口流程說明52.1.2 接口定義52.5 自助機發(fā)院內(nèi)就診卡122.5.1 接口流程說142.5.2 接口定義143.編碼說明36證件類型36. 36代碼37支付方式37醫(yī)院代碼37錯誤代碼表37綁定簽約標志錯誤!未定義書簽。代

2、碼錯誤!未定義書簽。出診時間段38卡類型38關(guān)系38市醫(yī)保保險類別錯誤!未定義書簽。患者類型39醫(yī)保調(diào)用醫(yī)保接口標識(AdmSource)錯誤!未定義書簽。市醫(yī)?？愋湾e誤!未定義書簽。4.通信錄395.關(guān)鍵流程接口調(diào)用步驟說明及示例錯誤!未定義書簽。5.1 掛號、取號錯誤!未定義書簽。5.2 退號錯誤!未定義書簽。5.3 門診繳費錯誤!未定義書簽。5.1 門診退費：錯誤!未定義書簽。1. 總體說明1.1 信息交換方式1. 與醫(yī)院體檢系統(tǒng)通訊均采用 Web Service 方式。1.2 消息格式說明Web Service 消息格式采用 XML 格式：請求報文是以 Request 為根節(jié)點的X

3、ML 串，應(yīng)答報文是以 Response 為根節(jié)點的 XML串。1.3 要求用戶登錄工號必須與 HIS 系增。其它要求見具體接口定義致；若體檢系統(tǒng)有工號新增；需與 HIS 系起新2. HIS 與醫(yī)院體檢系統(tǒng)的業(yè)務(wù)功能模塊2.1 當(dāng)日掛號2.1.1 接口流程說明通過獲取患者基本信息。獲取科室列表信息獲取醫(yī)生列表信息查詢排班掛號2.1.2 接口定義2.1.2.1 通過、證件號獲取患者基本信息(3300)(已核對)OK接口地址ice.cls(測試)請求消息：示例330012341001ATM011001gyy00103e.cls(正式)接口方法GetPatInfo交易代碼3300接口描述由或唯一號(

4、注:東華稱登記號)查出患者基本信息，當(dāng)不空時用，為空時用唯一號，也可以通過證號碼查詢患者基本信息。接口協(xié)議WebService+XML，Socket+XML主要使用者第機構(gòu)名稱設(shè)定值說明數(shù)據(jù)類型長度項TradeCode3300交易代碼String4TranionId交易流水號String20YExtCode預(yù)約機構(gòu)String20YCntType客戶端類型String20YTerminalID終端編碼String20YHospitalId醫(yī)院唯一編號String4YExtUserID操作員代碼String20YPatientCardString50與ID 、證號不能同時為空CardType卡類

5、型String10輸入時PatientIDIDString50與 、號不能同時為空DVAnumber號18與、ID 不能同時為空Password賬戶6只傳入身份證號時， checkType為 1 且身份證號、ID、只輸入了證號才會校 驗 密碼，傳明文checkType校驗方式21 為；2 為；只輸入身份證號時應(yīng)答消息：示例PatName患者兒童補卡時DOB出生日期兒童補卡時Phone患者兒童補卡時名稱說明數(shù)據(jù)類型長度備注ResultCode交易結(jié)果：0：成功String4非 0：錯誤ResultContent對錯誤/異常的詳細描述信息，交易不成功時輸出String256PatientIDIDS

6、tring50PatientNameString50SexCode代碼String10SexString10DOB出生日期String10ID病案號String60Address家庭住址String255IDTypeCode證件類型（代碼）String18IDTypeDesc證件類型（描述）String18IDNo證件號String50ephoneNoString11Mobile號String11ContactName聯(lián)系人StringContactIDCard聯(lián)系人號StringRelation聯(lián)系人關(guān)系StringContactNo聯(lián)系人StringContactName1聯(lián)系人Strin

7、gContactIDCard1聯(lián)系人號String2.1.2.5 掛便民號(1101)(已核對)OK請求消息：示例0000270820202接口地址e.cls (測試)e.cls(正式)接口方法OPDocFastRegistBroker交易代碼接口描述供第系統(tǒng)完成自助便民掛號接口協(xié)議WebService+XML，Socket+XML主要使用者第機構(gòu)Relation1聯(lián)系人關(guān)系StringContactNo1聯(lián)系人StringContactName2聯(lián)系人StringContactIDCard2聯(lián)系人號StringRelation2聯(lián)系人關(guān)系StringContactNo2聯(lián)系人StringAc

8、tiveCardNum有效卡String應(yīng)答消息：名稱說明數(shù)據(jù)類型長度ResultCode交易結(jié)果：String4示例名稱設(shè)定值說明數(shù)據(jù)類型長度項PatientID患者 PatientID,登記號String4YCTLocCode科室代碼(實為科室 ID) 100String20YUserCode操作員代碼String20YGROU安全組 ID 229String20Ydoctor902.5 發(fā)院內(nèi)就診卡2.5.1 接口流程說由外部系統(tǒng)先發(fā)起就診卡查詢交易(3013)，如果患者沒有就診卡，允許外部系統(tǒng)再發(fā)起發(fā)就診卡交易(3014)。2.5.2 接口定義2.5.2.1 就診卡查詢（3013）(已

9、核對)OK請求信息：交易編碼3013接口地址(測試)(正式)接口方法FindPatientCard描述根據(jù)證件類型、證件號、查詢患者的就診卡。請求消見“請求信息”表應(yīng)答消見“返回信息”表服務(wù)提供者HIS傳輸格式XML0：成功非 0：錯誤ResultContent對錯誤/異常的詳細描述信息String256AdmId就診 ID返回信息：以 Request 為根節(jié)點的 XML 串.子節(jié)點定義詳見下方的說明.3013名稱說明數(shù)據(jù)類型格式是否項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 發(fā)就診卡（3014）(已核對)OK交易編碼3014接口地址(測試)(正式)接口方法SavePatientCard描述傳入就診卡、證件類型、證件號碼、出生日期等信息，返回處理結(jié)果、患者 ID 等信息。請求消見“請求信息”表應(yīng)答消與接口的返回信息一致以 Response 為根節(jié)點的 XML 串.子節(jié)點定義詳見下方的說明名稱說明數(shù)據(jù)類型是否項TradeCode

11、交易代碼char(4)YResultCode結(jié)果標志（0可以發(fā)卡、-1不能發(fā)卡、-50 此已存在，-51 已存在同類型的卡）Char(3)YErrorMsg錯誤信息Char(256)YCardDeitAmt就診卡卡押金Char(19)請求信息：以 Request 為根節(jié)點的 XML 串.子節(jié)點定義詳見下方的說明.3014服務(wù)提供者HIS傳輸格式XML1名稱說明數(shù)據(jù)類型格式是否項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職業(yè)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聯(lián)系人(聯(lián)系人)char(20)ContactAddress聯(lián)系人地址(聯(lián)系地址)char(60)Relation與患者關(guān)系(關(guān)系)char(10)以 HIS 代碼表為準Contact

14、No聯(lián)系人(聯(lián)系)char(15)ContactIDCard聯(lián)系人號char(60)兒童補卡時ContactName1聯(lián)系人(聯(lián)系人)char(20)ContactIDCard1聯(lián)系人號char(60)Relation1與患者關(guān)系(關(guān)系)char(10)以 HIS 代碼表為準ContactNo1聯(lián)系人(聯(lián)系)char(15)ContactName2聯(lián)系人(聯(lián)系人)char(20)ContactIDCard2聯(lián)系人 2號char(60)Relation2與患者關(guān)系(關(guān)系)char(10)以 HIS 代碼表為準ContactNo2聯(lián)系人(聯(lián)系)char(15)PayModeCode支付方式：1=現(xiàn)

15、金2=Char(20)CardDeitAmt卡金額PayBCode支付Char(20)PayCardNo支付Char(20)PayTradeStr支付交易信息串（應(yīng)該包括 代碼、支付 、銀行交易日期、交易流水號）Char(1000)ChargeDeitA mt交易金額(含卡費)Char(19)YAccountPasswor d院內(nèi)賬戶(無需加密，Char(50)Y返回信息：以 Response 為根節(jié)點的 XML 串.子節(jié)點定義詳見下方的說明名稱說明數(shù)據(jù)類型是否項TradeCode交易代碼char(4)YPatientCard就診Char(19)YMD5)TheArea所屬地區(qū)Char(50)

16、TranionId交易流水號UserID用戶代碼TerminalID終端號3、醫(yī)囑處理3.1 接口流程說明3.1.1 醫(yī)囑由掛號(2.1.2.5)產(chǎn)生就診ID(AdmNo 即 2.1.2.5 出參中的 AdmRowid 字段)；醫(yī)囑主要為了和結(jié)果回傳，醫(yī)囑時需要將單價的數(shù)值放到 OrderQty 數(shù)量上進行插入；同時將體檢系統(tǒng)中的醫(yī)囑項目名稱放入 Note 字段進行。3.2.2 醫(yī)囑狀態(tài)改變第系統(tǒng)登記向 HIS 端發(fā)起申請改變醫(yī)囑狀態(tài)為執(zhí)行。第系統(tǒng)取消登記向 HIS端發(fā)起申請改變醫(yī)囑狀態(tài)為核實。3.2 接口定義3.2.1 AddOrderItem 添加醫(yī)囑信息接口定義：SecurityNo就診

17、卡Char(20)PatientID患者 IDchar(12)成功時為項ResultCode結(jié)果標志（0成功、-1失敗、-50 此已建卡、-51 已有同類型的卡）Char(3)YErrorMsg錯誤信息Char(256)YActiveFlag是否需要激活標志(0不需要激活就能正常使用；1存在多個患者 ID，需要激活后才能在醫(yī)院內(nèi)使用；2醫(yī)保患者需確認、激活后才能在醫(yī)院內(nèi)使用；)Char(1)TranionId交易流水號Char(20)CardInvInfo卡費用押金信息Char(500)請求消息：示例接口方式(測試)提供服務(wù)供第系統(tǒng)調(diào)用(正式)接口方法AddOrderItem接口描述在第系統(tǒng)就

18、診之后，醫(yī)生新增醫(yī)囑時，第系統(tǒng)將醫(yī)囑信息傳回到HIS系統(tǒng)。如果醫(yī)囑中有藥品醫(yī)囑，將優(yōu)先級為“自備”，并把藥品名稱添加到醫(yī)囑備注里。接口提供方東華集成代碼名稱數(shù)據(jù)類型約束說明AdmNo就診號NOT NULLVARCHAR(20)IDExtRowID外部醫(yī)囑 RowIDNOT NULLVARCHAR(20)第 系統(tǒng)產(chǎn)生此醫(yī)囑的唯一標識:采用 P+條碼形式OrderTypeCode醫(yī)囑類型NOT NULLVARCHAR(5)ArcimCode醫(yī)囑字典代碼NOT NULLVARCHAR(20)醫(yī)囑項目 IDArcimDesc醫(yī)囑字典名稱NOT NULLVARCHAR(50)OrderSus醫(yī)囑狀態(tài)VA

19、RCHAR(5)未核實”U”O(jiān)rderQty數(shù)量( 自定義價格醫(yī)囑時傳入價格,his 單NOT NULLVARCHAR(5)醫(yī)囑數(shù)量價需要設(shè)置成 1)OrderDeptCode開醫(yī)囑科室代碼NOT NULLVARCHAR(20)靜配中心代碼OrderRecDepCode接受科室代碼NOT NULLVARCHAR(20)靜配中心代碼OrderDoctorCode開醫(yī)囑人代碼NOT NULLVARCHAR(20)操作代碼OrderDoctor開醫(yī)囑人VARCHAR(50)OrderUserCode錄入人代碼NOT NULLVARCHAR(20)操作代碼OrderUserDesc錄入人名稱VARCH

20、AR(50)OrderSttDat要求執(zhí)行醫(yī)囑日期VARCHAR(20)YYYY-MM-DDOrderSttTim要求執(zhí)行醫(yī)囑時間VARCHAR(20)HH:MM:SSInsuTypeCode醫(yī)保類型代碼VARCHAR(5)LinkOrdID關(guān)聯(lián)醫(yī)囑 RowidVARCHAR(20)關(guān)聯(lián)醫(yī)囑 IDPHFreqCode頻次代碼VARCHAR(5)藥品醫(yī)囑不能為空UomCode代碼VARCHAR(5)藥品醫(yī)囑不能為空DosageCode劑型代碼VARCHAR(5)藥品醫(yī)囑不能為空UsageCode藥品用法代碼VARCHAR(5)藥品醫(yī)囑不能為空SpecCode標本代碼VARCHAR(5)檢驗醫(yī)囑不

21、能為空SpecDesc標本名稱VARCHAR(20)檢驗醫(yī)囑不能為空Note備注自定義價格醫(yī)囑需要傳入第系統(tǒng)醫(yī)囑的名稱描述VARCHAR(300)Queues成組Source來源NOT NULLVARCHAR(2)默認：1InsuFlag是否按醫(yī)保處理VARCHAR(5)Y：按醫(yī)保處理N：按自費處理應(yīng)答消息：3.2.2 改變醫(yī)囑狀態(tài)接口說明：輸入消息:接口地址(測試)(正式)接口方法ModifyOrderSus接口描述改變醫(yī)囑狀態(tài)，用于執(zhí)行醫(yī)囑和取消執(zhí)行醫(yī)囑接口協(xié)議Web Service+XML主要使用者系統(tǒng)代碼名稱數(shù)據(jù)類型約束說明ResultContent響應(yīng)信息VARCHAR(300)NO

22、T NULLResultCode響應(yīng)碼VARCHAR(6)NOT NULL0 ：成功其他： 失敗OrdRowID醫(yī)囑號VARCHAR(30)NOT NULL示例0成功應(yīng)答消息：示例應(yīng)答消息說明代碼名稱數(shù)據(jù)類型長度（字節(jié)）ResultCode交易結(jié)果：0：成功String示例E 5157705|1 doctor輸入消息說明代碼名稱數(shù)據(jù)類型約束Sus狀態(tài)(E 為執(zhí)行,V 為核實,D為停止)String必填OrdItemRowId醫(yī)囑 IDString必填UserCode用戶工號String必填3.2.3 查詢醫(yī)囑繳費情況接口說明：輸入消息:示例 5157705|15157705|25157705|

23、3doctor輸入消息說明代碼名稱數(shù)據(jù)類型約束OrdItemRowId醫(yī)囑 ID 串，多個 ID 以String必填接口地址(測試)(正式)接口方法GetBillFlagByItemId接口描述改變醫(yī)囑狀態(tài)，用于執(zhí)行醫(yī)囑和取消執(zhí)行醫(yī)囑接口協(xié)議Web Service+XML主要使用者系統(tǒng)非 0：錯誤ResultContent錯誤信息描述String應(yīng)答消息：4、門診退費示例應(yīng)答消息說明代碼名稱數(shù)據(jù)類型備注ResultCode交易結(jié)果：0：成功 非 0：錯誤StringResultContent錯誤信息描述StringOrdItemRowIdBill成功與否標記醫(yī)囑 ID繳費狀態(tài)標記繳費狀 態(tài)描述

24、成功與否標記醫(yī)囑 ID繳費狀態(tài)標記繳費狀態(tài)描述。String成功與否標記：0-成功，非 0-失敗繳費狀態(tài)標記：E-錯誤描述，P-已繳費，R-已申請退費，I-已退費，B-未繳費分割UserCode用戶工號String必填4.1 接口流程說明4.1.1 門診退費申請門診發(fā)生已繳費需要退費的醫(yī)囑時，調(diào)用申請成功后方可退費;藥品類醫(yī)囑不允許調(diào)用接口4.2 接口定義4.2.1Verify 門診退費申請接口說明：輸入消息:示例 5157705|1doctordoctor接口地址(測試)(正式)接口方法Verify接口描述退費申請，用于已繳費非藥品醫(yī)囑的退費申請接口協(xié)議Web Service+XML主要使用

25、者系統(tǒng)應(yīng)答消息：5、科室資料獲取5.1 接口流程說明5.1.1 科室資料獲取獲取 HIS 科室信息，用于醫(yī)囑和退費申請示例應(yīng)答消息說明代碼名稱數(shù)據(jù)類型備注ResultCode交易結(jié)果：0：成功 非 0：錯誤StringResultContent錯誤信息描述String輸入消息說明代碼名稱數(shù)據(jù)類型約束OrdItemRowId醫(yī)囑 IDString必填UserCode用戶工號String必填CTLocCode申請科室代碼String必填52 接口定義：5.2.1 Department 科室資料獲取請求消息：應(yīng)答消息（示例）：示例0獲取科室成功 GetIPLoc 93名稱說明數(shù)據(jù)類型長度項示例非空即可接口地址(測試)e.cls(正式)接口方法Department接口描述取科室信息接口協(xié)議WebService+XML主要使用者靜脈配液系統(tǒng)名稱說明數(shù)據(jù)類型長度（字節(jié)）72分娩室fmshszYW分娩室3