健康四川平臺醫院對接接口標準

V6.11

修正記錄

日期版本描述作者

2015-12-30V6.0創建

2016-2-17V6.10繳費記錄增加醫囑ID和醫囑名稱

2016-4-12V6.112.3.6接口定義修改

2016-9-7V6.112.1.2增加居民健康卡驗證

目錄

第一章概述5

1.1編寫目的5

1.2起草單位5

1.3解釋權5

1.4版權5

第二章接口5

定義5

2.1基本信息6

2.1.1身份證號查看患者信息6

2.1.2社保、銀行、就診卡號查看患者信息8

2.1.3患者檔案建立11

2.1.4查詢檢查，檢驗數據打印狀態14

2.1.5更新檢查，檢驗數據打印狀態17

2.1.6獲取檢查，檢驗數據19

2.1.7就診記錄查詢22

2.1.8查詢患者排隊信息25

2.1.9獲取住院記錄28

2.1.10獲取住院費用信息31

2.1.11床位信息33

2.1.12獲取病人門診號36

2.1.13獲取住院日費用清單38

2.2公共信息40

2.2.1根據科室Id查詢醫生信息40

2.2.2根據科室Id查詢科室信息43

2.2.3查詢所有科室列表信息46

2.2.4根據醫生Id查詢醫生信息48

2.3預約掛號51

2.3.1取消預約51

2.3.2預約掛號53

2.3.3查詢號源56

2.3.4根據醫生查詢號源59

2.3.5排取人數62

2.3.6取號查詢接口64

2.3.7取號67

2.3.8預約當天并取號69

2.3.9查詢未取號的預約掛號72

2.3.10查詢醫生號源時間段75

2.3.11查詢掛號支付狀態77

2.3.12醫生停診80

2.3.13醫生替診82

2.3.14查詢醫生的預約患者85

2.3.15預約鎖號88

2.3.16解鎖號源91

2.3.17預約成功通知93

2.3.18獲取掛號限制條件95

2.3.19獲取優惠人群信息97

2.4費用信息100

2.4.1待交費列表100

2.4.2已交費列表103

2.4.3狀態查詢107

2.4.4更新打票狀態110

2.4.5支付112

2.4.6繳預交款115

2.4.7獲取預交款余額117

2.4.8退款119

2.4.9獲取交易匯總數據（按日對賬）121

2.4.10獲取交易明細數據（按日對賬）123

2.5提醒信息（推送）126

2.5.1預交費報警值126

2.5.2檢查、檢驗報告完成128

2.5.3停診、替診通知130

2.5.4發藥完成132

2.5.5服藥提醒134

2.5.6待繳費136

附表139

1、日期格式說明139

2、接口出參示例說明錯誤！未定義書簽。

第一章概述

1.1編寫目的

編寫本接口協議目的是：標準化醫院HIS接口數據，讓其接入健康四川，為

健康四川平臺提供數據及服務支撐。

1.2起草單位

本文檔的起草單位為健康四川項目組。

1.3解釋權

本文檔的解釋權屬于健康四川項目組。

1.4版權

本文檔的版權屬健康四川項目組。

第二章接口

定義

系統接口使用HTTPPOST數據流方式，傳送數據編碼統一為UTF-8o第三方

平臺與服務器之間傳輸的協議數據格式如下（注意大小寫）：

{"head":{"username":"123","timestamp":1449294742709,"code":

"CodeValue","sig":

"2B520AFC3A4A3E883356325E2872E338"},"content":{"pageNum":

"1","pageSize":"10"}}

數據格式說明：content是主體數據，包含了客戶端發送給服務器的參數，

和服務器響應客戶端請求的返回數據。head頭部信息，如code,平臺獲取到

code節點值之后就可以判別是要調用哪個接口。測式地址：http://IP:端口

/api/service

測式：username：123key：123

2.1基本信息

2.1.1身份證號查看患者信息

接口說明通過身份證號查詢HIS中已有的病人信息

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

新

1.時間撮［當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

timestamp時間戳否2.每次請求timestamp需要

遞增

3.Java語言獲取方法

System.GiiirentTimeMillis()

sessionkey會話key否

username調用用戶名否系統分配客戶端調用用戶名

code區分調用哪個接口否客戶端調用的接口方法名，登錄

code為

queryPatientlnfoByldNO

sig否Sig=大寫32[MD5(username+

key+code+timestamp)]

key為系統分配的密碼

參數為空，則填寫空字符串

content結構體說明

Content

說明可否為空備注

輸入參數

cardNoString是身份證號碼(傳空則

獲取所有患者信息)

patientNameString是患者姓名

輸入參數舉例

返回參數

JSON數據見返回參數說明。如返回數據錯誤，則根據錯誤代碼構JSON數據。

返回數據格式

字段說明可否為空備注

errorcode錯誤碼否錯誤碼，客戶端根據錯誤碼

判斷獲取失敗或者成功

msg描述信息是返回版本信息

response返回結構是響應請求的具體數據

executeTimeMs執行時間是執行時間

response結構體說明

屬性類型可否為空備注

hillserModelString否JSON字符串

hillserModel：

patientNoString否患者編號

patientNameString否患者姓名

patientldcardNoString否身份證號

socialsecurityNOString是社保卡號

visitCardNoString是就診卡號

patientSexInteger否性別（0女，1男，3

表示未知）

patientBirthdayString否出生日期

balanceFloat是門診余額

patientTelephoneString是聯系電話

errorcode說明

錯誤碼說明

00成功

01失敗

09異常

{"head":{"sig":"099667DA9ABBE8F4F5378BFD892F952F","timestamp":1428589803748,"ph

onetype'':'m,''sessionkey'':'m,''username'':'''',''category'':'''',',imei'':'',',"code":"query

PatientlnfoByldNO,',"imsi":""}，"content":{"cardNo":"","patientName":""}}

2.1,2社保、銀行、就診卡號查看患者信息

接口說明社保、銀行、就診卡號、居民健康卡查看患者信息

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

數

4.時間撮[當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

timestamp時間戳否5.每次請求timestamp需要

遞增

6.Java語言獲取方法

SystamciirranfTimaMilliN)

sessionkey全話kpy否

調用用白名否系統分配客戶端調用用聲名

code區分調用哪個接口否客戶端調用的接口方法名，登錄

code為

queryPatientlnfoBySocia

sig否Sig=大寫32[MD5(usemame+

key+code+timestamp)]

key為系統分配的密碼

參數為空，則填寫空字符4

content結構體說明

Content

說明可否為空備注

—輸大參如-

socialsecurityNOString是社保卡號

bankCardNumberString是銀行卡號

visitCardNoString是就診卡號

healthCardNoString是居民健康卡號

輸入參數舉例

返回參數

JSON數據見返回參數說明。如返回數據錯誤，則根據錯誤代碼構JSO卜

數據。

返回數據格式

字段說明可否為空備注

errorcode錯誤碼否錯誤碼，客戶端根據錯誤碼

判斷獲取失敗或者成功

msg描述信息是返回版本信息

response返回結構是響應請求的具體數據

executeTimeMs執行時間是執行時間

response結構體說明

屬性類型可否為空備注

hiUserModel否實體類

hiUserModel：

patientNoString否患者編號

patientNameString否患者姓名

patientldcardNoString否身份證號

socialsecurityNOString是社保卡號

visitCardNoString否就診卡號

patientSexInteger否姓別（0女，1男，3

表示未知）

patientBirthdayString否出生日期

balanceFloat是門診余額

patientTelephoneString否聯系電話

resultCodeString否00：表水成功；01：

表示未注冊；其他表

示失敗

resultMsgString否返回信息

errorcode說明

錯誤碼說明

00成功

01失敗

09異常

{"head":{"sig":"099667DA9ABBE8F4F5378BFD892F952F","timestamp":142858

9803748「phonetype'':''",''sessionkey'':"'',''username“：””,"category“：”“3mei”：''","code'':"

n

queryPatientlnfoBySocialsecurityNO","imsi":""}J"content":{"socialsecurityNO":"

"bankCardNumber":",',"visitCardNo":,m}}

2.1.3患者檔案建立

接口說明對HIS中沒有的病人進行新病人登記

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

7.時間撮［當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

時間戳否

timestamp8.每次請求timestamp需要

遞增

9.Java語言獲取方法

SystemcurrRntTimeMillis()

ARssionkRv會話kpy否

UARmAIDA調用用戶夕；否東緯益西m客戶端調用用戶夕；

code區分調用哪個接口否客戶端調用的接口方法名，登錄

ccda^doCrAAtCardlnfo

sig否Sig=大寫32[MD5(usemame+

key+code+timestamp)]

key為系統分配的密碼

余粕/mmii+吉仁衣土舛由

Content

說明可否為空備注

愉入叁涉

1“口GDIIVIUUD1OUIIig從丁叩

InUSDIIVIUUDI:

米利

)昆禹，I葉土uj省

中土妒□.

pairenllNO<JUiny足心e牛J號

paticntr'iJainc?忠酉姓名

patientldcardNoString否身份證號

socialsecurityNOString是社保卡號

visitCardNoString否就診卡號

patientSexInteger否姓別（0女，1男，3

表示未知）

patientBirthdayString否出生日期

balanceFloat是門診余額

patientTelephoneString否聯系電話

返回參數

JSON數據見返回參數說明。如返回數據錯誤，則根據錯誤代碼構JSON數據。

返回數據格式

字段說明可否為空備注

errorcode錯誤碼否錯誤碼，客戶端根據錯誤碼

判斷獲取失敗或者成功

msg描述信息是返回版本信息

response返回結構是響應請求的具體數據

executeTimeMs執行時間是執行時間

response結構體說明

屬性類型可否為空備注

hiUserModel否實體類

hiUserModel：

patientNoString否患者編號

patientNameString否患者姓名

patientldcardNoString否身份證號

socialsecurityNOString是社保卡號

visitCardNoString否就診卡號

patientSexInteger否姓另IJ（0女，1男，3

表小未知）

patientBirthdayString否出生日期

balanceFloat是門診余額

patientTelephoneString否聯系電話

personcategoryString否人員類別（默認為

“3”，表示未知）

errorcode說明

錯誤碼說明

00成功

01失敗

09異常

{"head":{"sig":"099667DA9ABBE8F4F5378BFD892F952F","timestamp":142858

,,'',,m1

9803748,"phonetype":"','sessionkey":',"username":,"category":"","imei":"","code":'

n

queryPatientlnfoBySocialsecurityNO","imsi":""}J"content":{"socialsecurityNO":"

"bankCardNumber":",',"visitCardNo":,m}}

2.1.4查詢檢查，檢驗數據打印狀態

接口說明查詢檢查，檢驗數據打印狀態

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

10.時間撮[當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

時間戳否

timestamp11.每次請求timestamp需要

遞增

12.Java語言獲取方法

SystemcurrRntTimeMillis()

SAAsionkfiv會話kpy否

usArnAmA調用用戶名香系統分配客戶端調用用戶名

code區分調用哪個接口否客戶端調用的接口方法名，登錄

code為

queryExaminationRecordS

tatus

sig否Sig=大寫32[MD5(username+

key+code+timestamp)]

key為系統分配的密碼

—參數為空,則填寫空字符用

content結構體說明

Content

說明可否為空備注

輸入叁數

reportNosString否報告編號

(注多個可以逗號分

開如112,2222)—

返回參數

JSON數據見返回參數說明如返回數據錯誤，則根據錯誤同構JSON數據。

返回數據格式

字段說明否為蜜芷

errorcode錯誤碼否錯誤碼，客通腳1哥馬

判斷獲取失敗或者成功

msg描述信息是返回版本信息

response返回結構是響應請求的具體數據

executeTimeMs執時鼎執閶

response結構體說明

count當前返回數量不為空

item返回數據集數據集，以json數組

形式返回，

輸出格式：

"item"：[{"reportNoisPrint，…]

reportNoString否報告編

isPrintString否打印狀態表示未打

E|l,1表示已打印

errorcode說明

錯誤碼說明

00成功

01失敗

09異常

2.1.5更新檢查，檢驗數據打印狀態

接口說明更新檢查，檢驗數據打印狀態

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

13.時間撮［當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

timestamp時間戳否14.每次請求timestamp需要

遞增

15.Java語言獲取方法

不

不1

不系、2統u今JJ所LIU農1-1戶/端-ii'j調rT用/IJ用/IJ白7名"O

code區分調用哪個接口否客戶端調用的接口方法名，登錄

code為

updateExaminationRecord

sig否Sig=大寫32[MD5(username+

key+code+timestamp)]

key為系統分配的密碼

仝物不出mil古口入?改r中

'%,y-x'j-yi-j?'j

content結構體說明

Content

說明可否為空備注

輸入參數

reportNosString否報告編號

（注多個可以逗號分

開如112,2222）

輸入參數舉例

返回參數

JSON數據見返回參數說明。如返回數據錯誤，則根據錯誤代碼構JSON數據。

返回數據格式

字段說明可否為空備注

errorcode錯誤碼否錯誤碼，客戶端根據錯誤碼

判斷獲取失敗或者成功

msg描述信息是返回版本信息

response返回結構是響應請求的具體數據

executeTimeMs執行時間是執行時間

輸出格式：

{"errorcodemsg"："","response“："“，“executeTimeMs"：”")

errorcode說明

錯誤碼說明

00成功

01失敗

09異常

2.1.6獲取檢查，檢驗數據

接口說明獲取病人檢查、檢驗、體檢等報告內容或者圖片信息

輸入參數

字段說明可否為空備注

headhead是結構否請求頭部信息

contentcontent是結構否請求參數內容

head結構體參數說明

head結構體參

說明可否為空備注

16.時間撮［當前時間與協調世

界時(utc)1970年1月1日

午夜之間的時間差(以毫秒

為單位測量)

timestamp時間戳否17.每次請求timestamp需要

遞增

18.Java語言獲取方法

不

不1

不系、2統u今JJ所LIU農1-1戶/端-ii'j調rT用/IJ用/IJ白7名"O

code區分調用哪個接口否客戶端調用的接口方法名，登錄

code為