自助綜合服務(wù)系統(tǒng)接口方案(按需繳費(fèi))

1、自助綜合服務(wù)系統(tǒng)接口方案長(zhǎng)沙. 2012.6文檔名稱自助綜合服務(wù)系統(tǒng)接口方案版 本 號(hào)V1.0版本日期2012年6月3日創(chuàng) 建 者長(zhǎng)城醫(yī)療創(chuàng)建日期2011年9月25日l(shuí) 版本修訂歷史版本號(hào)變更時(shí)間變更內(nèi)容擬稿人審批人目 錄1 服務(wù)測(cè)試42 辦卡52.1 建卡病人身份校驗(yàn)52.2建診療卡63卡信息查詢84卡預(yù)交金充值95 掛號(hào)115.1可掛科室查詢115.2醫(yī)生號(hào)查詢125.3掛號(hào)146 繳費(fèi)176.1查詢繳費(fèi)項(xiàng)176.2繳費(fèi)197 預(yù)約掛號(hào)207.1 有卡預(yù)約病人可取號(hào)列表207.2有卡預(yù)約病人取號(hào)228 打印門診費(fèi)用清單249 預(yù)交金對(duì)賬2710 驗(yàn)證密碼2811 預(yù)交金賬戶變更明細(xì)查詢29

2、1 服務(wù)測(cè)試接口說明：服務(wù)測(cè)試接口地址接口方法NetTest接口描述測(cè)試Web服務(wù)是否連接正常接口協(xié)議Web Service+XML主要使用者自動(dòng)發(fā)卡機(jī)系統(tǒng)輸入消息說明示例以Request為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明.應(yīng)答消息：應(yīng)答消息說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：錯(cuò)誤ResultCodeErrorMsg錯(cuò)誤信息描述ErrorMsg2 辦卡2.1 建卡病人身份校驗(yàn)接口說明：對(duì)身份證是否存在有效的卡進(jìn)行校驗(yàn)接口地址

3、接口方法IDCardCheck接口描述對(duì)身份證是否存在有效卡進(jìn)行校驗(yàn)接口協(xié)議Web Service+XML主要使用者自動(dòng)發(fā)卡機(jī)系統(tǒng)說明示例以Request為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 身份證號(hào)StringIDCardNo應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0:成功1:失敗IntResultCode狀態(tài)0：可以現(xiàn)金辦卡1:該身份證在銀行申請(qǐng)過綁定卡2：該身份證已建診療卡Status2.2建診療卡接口說明：向HIS發(fā)送病人建卡信息接口定義：接

4、口地址接口方法CreateCardPatInfo接口描述將建卡信息插入到HIS數(shù)據(jù)庫(kù)接口協(xié)議Web Service+XML主要使用者自動(dòng)發(fā)卡機(jī)系統(tǒng)請(qǐng)求消息：說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度卡號(hào)StringCardNo16病人姓名StringPatientName性別StringSex出生日期YYYY-MM-DDDateBirthday年齡StringAge身份證號(hào)StringIDCardNo卡校驗(yàn)碼StringSecrityNo10卡序列號(hào)StringCardSerNo32聯(lián)系地址StringAddress聯(lián)系電話String

5、Tel預(yù)交金NumberAmt操作員StringUserId操作日期YYYY-MM-DDDateActDate操作時(shí)間HH:mm:sstimeActTime繳費(fèi)密碼不設(shè)置密碼則為空StringPassWord應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：錯(cuò)誤-341：卡重復(fù)IntResultCodeErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、卡無(wú)效 b、卡已存在StringErrorMsg收據(jù)號(hào)StringSerID注：卡校驗(yàn)碼和卡

6、序列號(hào)不能同時(shí)為空3卡信息查詢接口說明：查詢病人卡信息接口地址接口方法GetPatInfo接口描述病人刷卡的時(shí)候返回卡信息接口協(xié)議Web Service+XML主要使用者自動(dòng)發(fā)卡機(jī)系統(tǒng)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 卡號(hào)StringCardNo16操作員StringUserId卡校驗(yàn)碼不能同時(shí)為空StringSecrityNo卡序列號(hào)StringCardSerNo應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 0名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）卡號(hào)StringCardNo16卡狀

7、態(tài)卡狀態(tài)為N是正常狀態(tài)，其他狀態(tài)都禁止使用StringCardStatus賬戶號(hào)/ID號(hào)賬戶號(hào)為空不能充值StringAccdNo賬戶狀態(tài)賬戶狀態(tài)為N為正常狀態(tài)，其他狀態(tài)都禁止充值StringAccdStatus賬戶余額StringAccBalance姓名String PatName密碼狀態(tài)0為無(wú)密碼，1為有密碼StringPwdStatus4 掛號(hào)4.1可掛科室查詢接口說明：查詢能掛的科室接口地址接口方法DOCKSList接口描述查詢能掛的時(shí)段接口協(xié)議Web Service+XML主要使用者自助掛號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 日期當(dāng)天為空Str

8、ingDay操作員UserId應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 9008 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功 1：失敗IntResultCodeErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg科室IDStringDeptId父科室StringParDeptId科室名稱DepName4.2醫(yī)生號(hào)查詢接口說明：查詢能掛的醫(yī)生號(hào)別接口地址接口方法DOCHBList接口描述查詢能掛的醫(yī)生號(hào)別接口協(xié)議Web Service+XML

9、主要使用者自助掛號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 日期如果非預(yù)約為空StringDay科室IDStringDepId操作員StringUserId應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：失敗IntResultCodeErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg256號(hào)IDStringRowId科室IDDeptId科室名稱StringDeptD

10、esc號(hào)別名稱（醫(yī)生姓名）StringMarkDesc出診級(jí)別（普通，專家、）StringSessionType掛號(hào)費(fèi)合計(jì)StringSumFee掛號(hào)時(shí)段StringHBTime4.3掛號(hào)接口說明：掛號(hào)接口地址接口方法OPRegist接口描述掛號(hào)接口協(xié)議Web Service+XML主要使用者自助掛號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 卡號(hào)StringCardNo16醫(yī)生號(hào)RowIdStringRowId日期可以為空StringDay時(shí)段預(yù)約掛號(hào)時(shí)傳空Time操作員StringUserId卡校驗(yàn)碼不能同時(shí)為空StringSecrityNo卡序列號(hào)Stri

11、ngCardSerNo32應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：失敗IntResultCode4ErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg256收據(jù)號(hào)SerID年StringRegYear4月StringRegMonth2日StringRegDay2卡號(hào)StringCardNo12病人姓名StringPatName20號(hào)別序號(hào)StringQueueNo4就診科室StringDepD

12、esc20職稱（普通，專家、）StringSessionType20就診位置StringLocInfo40操作員StringUserId20醫(yī)生號(hào)別（醫(yī)生姓名）StringDocDesc20掛號(hào)費(fèi)StringSumFee205 繳費(fèi)5.1查詢繳費(fèi)項(xiàng)接口說明：查詢繳費(fèi)項(xiàng)目接口地址接口方法GetBillInfo接口描述接口協(xié)議Web Service+XML主要使用者自助掛號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明.卡號(hào)StringCardNo操作員StringUserid校驗(yàn)碼StringSecrityNo卡序列號(hào)StringCardSerNo應(yīng)答消息：說明示例以R

13、esponse 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 項(xiàng)目編號(hào)項(xiàng)目名稱 分類編號(hào)分類名稱金額數(shù)量執(zhí)行位置 項(xiàng)目編號(hào)項(xiàng)目名稱 分類編號(hào)分類名稱金額數(shù)量執(zhí)行位置名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：失敗IntResultCode4ErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg256項(xiàng)目編號(hào)StringItemId20項(xiàng)目名稱StringItemName20分類編號(hào)StringCateId20分類名稱StringCateName20金額StringPrice20數(shù)量

14、StringNum20執(zhí)行位置StringCtLoc205.2繳費(fèi)接口地址接口方法AutoOPBillCharge接口描述執(zhí)行繳費(fèi)接口協(xié)議Web Service+XML主要使用者自助掛號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 卡號(hào)StringCardNo卡校驗(yàn)碼不能同時(shí)為空StringSecrityNo20卡序列號(hào)StringCardSerNo32金額StringAmt10分組票據(jù)號(hào)StringRcptgroupid10操作員StringUserId應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤

15、值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：失敗IntResultCode4ErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg256收據(jù)號(hào)StringSerID6 預(yù)約掛號(hào)6.1有卡預(yù)約病人可取號(hào)列表接口說明：有卡預(yù)約病人可取號(hào)列表接口地址接口方法AppNoList接口描述有卡預(yù)約病人刷診療卡以后列出當(dāng)前可以取的醫(yī)生號(hào)接口協(xié)議Web Service+XML主要使用者自助取號(hào)機(jī)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 卡號(hào)StringCardNo12應(yīng)答消息：說明示例以Re

16、sponse 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 號(hào)ID號(hào)名稱級(jí)別總金額科室Id科室 時(shí)段日期 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）號(hào)別名稱描述StringRESDesc100價(jià)格StringPrice5Result交易結(jié)果：0：成功1：錯(cuò)誤IntResultCode4ErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg2566.2有卡預(yù)約病人取號(hào)接口說明：有卡預(yù)約病人取號(hào)接口地址接口方法GetAppNo接口描述有卡病人做網(wǎng)上預(yù)約以后在醫(yī)院取號(hào)接口協(xié)議Web Service+XML主要使用者自動(dòng)

17、發(fā)卡機(jī)系統(tǒng)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 卡號(hào)StringCardNo卡校驗(yàn)碼不能同時(shí)為空StringSecrityNo卡序列號(hào)StringCardSerNo取號(hào)日期DateDay時(shí)段stringTime號(hào)IDRowId應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限 名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)）Result交易結(jié)果：0：成功1：失敗IntResultCode4ErrorMsg對(duì)錯(cuò)誤/異常的詳細(xì)描述信息a、數(shù)據(jù)庫(kù)連接異常StringErrorMsg256對(duì)賬

18、號(hào)SerID年StringRegYear4月StringRegMonth2日StringRegDay2卡號(hào)StringCardNo12病人姓名StringPatName20當(dāng)前號(hào)別隊(duì)列號(hào)StringQueueNo4就診科室StringDepDesc20職稱StringSessionType20就診位置StringLocInfo40收據(jù)號(hào)StringSerNo14操作員StringUserId20號(hào)別StringDocDesc20接診醫(yī)生StringDoctor20掛號(hào)金額StringRegFee207 打印門診費(fèi)用清單接口說明：查詢病人門診費(fèi)用明細(xì)接口地址接口方法GetBillDetailBy

19、Adm接口描述查詢病人門診費(fèi)用明細(xì)接口協(xié)議Web Service+XML主要使用者自動(dòng)發(fā)卡機(jī)系統(tǒng)說明示例以Response為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn)定義詳見下方的說明. 開始日期結(jié)束日期 卡號(hào)StringCardNo卡校驗(yàn)碼不能同時(shí)為空StringSecrityNo卡序列號(hào)StringCardSerNo開始時(shí)間YYYY-MM-DDStringStartDay結(jié)束時(shí)間YYYY-MM-DDStringEndDay操作員StringUserId應(yīng)答消息：說明示例以Response 為根節(jié)點(diǎn)的XML串.子節(jié)點(diǎn): Result, ErrorMsg如返回錯(cuò)誤值，需要重新請(qǐng)求，3次為上限桂磊男600000001自費(fèi)檢查肝功能檢驗(yàn)1200200 次 2011-09-26 13:25檢查驗(yàn)血166次2011-09-26 13:250名稱說明數(shù)據(jù)類型標(biāo)簽名長(zhǎng)度（字節(jié)