廣東省民營(yíng)診所疫情哨點(diǎn)信息管理系統(tǒng)接口文檔

廣東省民營(yíng)診所（疫情哨點(diǎn)）信息管理

系統(tǒng)接口文檔

2020年2月

目錄

1.弓I言........................................................................5

1.1文檔編制目的............................................................5

2.系統(tǒng)接入設(shè)計(jì)................................................................5

2.1接入模式................................................................5

2.2報(bào)文格式定義............................................................5

2.2.1報(bào)文格式說明.........................................................5

2.2.2入?yún)⒏袷剑篿nputData................................................5

2.2.3出參格式：outputData...............................................7

3.AK/SK認(rèn)證&參數(shù)加解密........................................................8

3.1AK/SK認(rèn)證.................................................................8

3.2接口入?yún)⒓用芗雍?........................................................9

3.3接口出參加密............................................................11

4.接口詳細(xì)設(shè)計(jì).................................................................11

4.1醫(yī)療機(jī)構(gòu)資質(zhì)監(jiān)管-醫(yī)療機(jī)構(gòu)信息...........................................11

4.2醫(yī)療機(jī)構(gòu)資質(zhì)監(jiān)管-職工信息...............................................15

4.3患者信息-患者基本信息...................................................19

4.4附件上傳.................................................................25

4.5患者就診上報(bào)............................................................26

4.5.1癥狀列表明細(xì)信息....................................................32

5.字典.........................................................................32

5.1職工性別代碼............................................................32

5.2身份證件類別代碼........................................................33

5.3婚姻狀況代碼............................................................33

5.4民族代碼.................................................................34

5.5國(guó)籍代碼.................................................................37

5.6職業(yè)類別代碼............................................................47

5.7ABO血型代碼.............................................................51

5.8Rh血型類別代碼..........................................................51

5.9專業(yè)技術(shù)職務(wù)代碼........................................................52

5.10參保類別代碼...........................................................53

5.11醫(yī)療機(jī)構(gòu)大類...........................................................53

5.12醫(yī)療機(jī)構(gòu)類別...........................................................54

5.13機(jī)構(gòu)資質(zhì)文件類型.......................................................55

5.14機(jī)構(gòu)科室...............................................................56

5.15醫(yī)師資質(zhì)文件...........................................................57

5.16職稱....................................................................57

5.17醫(yī)師執(zhí)業(yè)范圍...........................................................58

5.18診斷庫(kù)..................................................................59

5.19個(gè)人標(biāo)識(shí)類型...........................................................59

5.20診斷類別................................................................60

5.21患者類型...............................................................60

5.22聯(lián)系人關(guān)系.............................................................60

5.23職工類別...............................................................61

5.24親戚關(guān)系...............................................................61

5.25人群類別...............................................................62

5.26流行病學(xué)史.............................................................62

5.27癥狀....................................................................63

5.28轉(zhuǎn)診機(jī)構(gòu)...............................................................64

5.29患者去向................................................................84

1.引言

1.1文檔編制目的

接入開發(fā)手冊(cè)主要表述了接口描述，約定了合作機(jī)構(gòu)與省民營(yíng)診所（疫情

哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步通信方式與標(biāo)準(zhǔn)規(guī)范。

2.系統(tǒng)接入設(shè)計(jì)

2.1接入模式

省民營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)可以選擇通過專線、

公網(wǎng)的不同方式來訪問服務(wù)，具體訪問方式以合作機(jī)構(gòu)約定為準(zhǔn)。

測(cè)試服務(wù)器地址：。

生產(chǎn)服務(wù)器地址：。

2.2報(bào)文格式定義

2.2.1報(bào)文格式說明

本接口輸入輸出均以JSON格式傳輸，需符合大小寫規(guī)則，不同的接口上

傳的數(shù)據(jù)類型不同，可能是JSONArray,也可能是JSONObject,具體如下

參見具體接口的說明。

2.2.2入?yún)⒏袷?inputData

示例（以實(shí)際代碼和聯(lián)調(diào)數(shù)據(jù)為準(zhǔn)）：

channelld":"10001",

requestld":"-0001",

"encodeKey"testkey200",

"sign"10011001-0001",

"signMethod"sha256",

"timestamp

"versionn:"1.0",

"encodeData":"ZSdSkKnubLoUop5JFbRWeQ"

},

公共報(bào)文頭數(shù)據(jù):

編號(hào)字段名稱類型（長(zhǎng)度）必須說明

提供渠道ID,由省民營(yíng)診所（疫

1channelldString是

情哨點(diǎn)）信息管理系統(tǒng)分配

2requestldString否請(qǐng)求唯一ID,由客戶端生成

3encodeKeyString是AES密鑰（客戶端加密使用）

4signString是客戶端加密數(shù)據(jù)生成的摘要

客戶端摘要算法（暫時(shí)支持

String

5signMethod否

sha256,默認(rèn)）

6timestampLong否時(shí)區(qū)GMT+8,單位毫秒

7versionString否接口版本號(hào)，默認(rèn)1.0.0

需耍加密參數(shù)組成的json字符串，

8encodeDataString是

然后AES加密所得

2.2.3出參格式：outputData

示例（以實(shí)際代碼和聯(lián)調(diào)數(shù)據(jù)為準(zhǔn)）：

（

"code":"000000",

"msg":"處理成功"，

"data":{}

},

報(bào)文返回信息：

編號(hào)字段名稱類型（長(zhǎng)度）必須說明

接口返回錯(cuò)誤碼，表示接口調(diào)

1codestring是用的非業(yè)務(wù)屬性狀態(tài)，比如成

功、驗(yàn)證失敗等等

2msgstring是錯(cuò)誤碼的描述信息

3dataJSONObject否業(yè)務(wù)返回?cái)?shù)據(jù)

3.AK/SK認(rèn)證&參數(shù)加解密

3.1AK/SK認(rèn)證

合作方與省民營(yíng)診所(疫情哨點(diǎn))信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)通信時(shí)需要根據(jù)省民

營(yíng)診所(疫情哨點(diǎn))信息管理系統(tǒng)數(shù)據(jù)同步平臺(tái)頒發(fā)的AK(AccessKey)和SK(Secret

Key)生成授權(quán)信息，并隨接口請(qǐng)求一起發(fā)送給省民營(yíng)診所(疫情哨點(diǎn))信息管理系統(tǒng)數(shù)

據(jù)同步服務(wù)。合作方生成授權(quán)信息算法如下：

1根據(jù)請(qǐng)求url和時(shí)間戳構(gòu)造簽名字符串stringToSign.

stringToSign=uri_path++http_verb++sign++

timestamp;

uri_path:請(qǐng)求path。例如

,那么path部分為：uri_path=/api/nhip/dc/employeeo

http_verb:請(qǐng)求動(dòng)作，如GET、POST等。

sign:請(qǐng)求參數(shù)簽名信息，請(qǐng)參考3.2節(jié)接口入?yún)⒓用芗雍灐?/p>

timestamp:時(shí)間戳。

2根據(jù)頒發(fā)的SK計(jì)算簽名字符串signature.

signature=str_to_upper(hmac_shal(stringToSign,SK));

hmac_shal:簽名算法，根據(jù)SK生成簽名摘要。

str_to_upper:轉(zhuǎn)換為大寫字母。

3根據(jù)頒發(fā)的AK、SK和時(shí)間戳、once數(shù)據(jù)構(gòu)造授權(quán)信息Authorization。

authorization=once+":"+timestamp+":"+AK+":"+signature;

once=hash（timestamp的16進(jìn)制+ip地址/mac地址），即

timestamp的16進(jìn)制加上ip地址或者mac地址，然后進(jìn)行hash。

timestamp和第1步中的timestamp要求必須一致。

4授權(quán)信息進(jìn)行url安全的base64編碼。

（）

authorization_base64=urlsafe_base64_encodeauthorizationo

urlsafe_base64_encode:URL安全的base64編碼。

5授權(quán)信息authorization_base64添加到http請(qǐng)求的header中跟隨請(qǐng)求發(fā)送給省民

營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)，在header中對(duì)應(yīng)的key為

Authorization,,

3.2接口人參加密加簽

合作方與省民營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)通信時(shí)需要對(duì)入?yún)⒓用?/p>

加簽，以保障安全和防止隱私泄露。合作方根據(jù)省民營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)

據(jù)同步服務(wù)下發(fā)的publicKey生成入?yún)⒓用苊罔€encodeKey,對(duì)入?yún)⒓用芗雍炦^程如

下：

encodeKey=RSA(randomString,publicKey);

randomstring:隨機(jī)生成的字符串，AES加密解密秘鑰，長(zhǎng)度必須為16位字符

（128bit）。

publicKey:RSA加密公鑰，由省民營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)下

發(fā)。

說明：

1encodeKey添加到請(qǐng)求參數(shù)中，對(duì)應(yīng)key為encodeKey;RSA的填充模式

（padding）默認(rèn)為PKCS1,且采用分段加密（最大加密明文塊大小為117）.

2對(duì)需要加密的參數(shù)（encodeData中的參數(shù)）進(jìn)行AES加密，加密秘鑰為

randomstring,加密模式為AES/CBC/PKCS5Padding,添加向量

IvParameterSpec（取值約定為：0300）增強(qiáng)算法強(qiáng)度;后需進(jìn)行URL安全的

BASE64編碼。

3請(qǐng)求參數(shù)按照key字母升序排序。

4用“&”拼接排序后的參數(shù)信息，生成字符串：keyl=valuel&key2=value2&...

&keyn=valuen0

5對(duì)上述字符串使用公共參數(shù)中的signMethod方法提取摘要，目前默認(rèn)使用

sha256,得到加簽字符串sign。

6sign加入請(qǐng)求參數(shù)，對(duì)應(yīng)key為sign,隨請(qǐng)求一起發(fā)往省民營(yíng)診所（疫情哨點(diǎn)）

信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)。

3.3接口出參加密

省民營(yíng)診所（疫情哨點(diǎn)）信息管理系統(tǒng)數(shù)據(jù)同步服務(wù)返回給合作方的數(shù)據(jù)進(jìn)行了AES

加密，加密秘鑰為randomstring,需要加密的返回?cái)?shù)據(jù)都放在encodeData中,合作方

收到數(shù)據(jù)之后需要解密。

4.接口詳細(xì)設(shè)計(jì)

此部分主要對(duì)各具體業(yè)務(wù)作詳細(xì)說明。

4.1醫(yī)療機(jī)構(gòu)資質(zhì)監(jiān)管-醫(yī)療機(jī)構(gòu)信息

服務(wù)名稱同步醫(yī)療機(jī)構(gòu)信息

Rest服務(wù)地址/institution

請(qǐng)求方式POST

JSONArray格式，其中每個(gè)JSONObject包含的字段如下

字段名字段類是否必字段說明

型須

medicalOrgCodeString是醫(yī)療機(jī)構(gòu)代碼

medicalOrgNameString是醫(yī)療機(jī)構(gòu)名稱

certListString是JSONArray格式的字符串形式。

其中單個(gè)JSONObject的格式如下：

字段名字段名必字段說

須？明

certTypeString是證書類

型（詳

見字典

說明）

certNoString是證書編

號(hào)

certNameString是證書名

稱

certExpiryLong否有效期

nextCheckDateLong否下次年

檢時(shí)間

issuanceDateLong否發(fā)證時(shí)

問

醫(yī)療機(jī)構(gòu)執(zhí)業(yè)許可證一正本

醫(yī)療機(jī)構(gòu)執(zhí)業(yè)許可證一副本首頁(yè)

醫(yī)療機(jī)構(gòu)執(zhí)業(yè)許可證一副本年檢時(shí)間頁(yè)包含

下次年檢時(shí)間（下次年檢時(shí)間年月日）

其他證件（放射診療許可證，輻射安全許可證

等等）

lastAnnualCheckDateLong最新年檢日期

diagnosisSubjectString是醫(yī)療機(jī)構(gòu)診療科目

phoneString醫(yī)療機(jī)構(gòu)聯(lián)系電話

legalPersonNameString醫(yī)療機(jī)構(gòu)負(fù)責(zé)人（法人）姓名

legalPersonPhoneString醫(yī)療機(jī)構(gòu)負(fù)責(zé)人聯(lián)系電話

provinceCodeString是地址-?。ㄗ灾螀^(qū)、直轄市）編碼

provinceNameString是地址-?。ㄗ灾螀^(qū)、直轄市）名稱

cityCodeString是地址-市（地區(qū)、州）編碼

cityNameString是地址-市（地區(qū)、州）名稱

countyCodeString是地址-縣（區(qū)）編碼

countyNameString是地址-縣（區(qū)）名稱

streetCodeString街道編碼

streetNameString街道名稱

addressString詳細(xì)地址

postCodeString郵政編碼

medicalOrgGeneralCategoryString是醫(yī)療機(jī)構(gòu)大類（詳見字典說明）

medicalOrgCategoryString是醫(yī)療機(jī)構(gòu)類別（詳見字典說明）

diagnosisDepartmentString診療科室

insuranceUnitFlagString是是否醫(yī)保定點(diǎn)單位

internetFlagString是是否互聯(lián)網(wǎng)醫(yī)院

businessHoursString營(yíng)業(yè)時(shí)間

intruductionString機(jī)構(gòu)簡(jiǎn)介

longitudeString經(jīng)度

latitudeString緯度

disabledString是是否停用（0啟用，1停用）

isDeletedString是記錄是否已邏輯刪除，0未刪除1已刪除

createTimeLong是創(chuàng)建時(shí)間，時(shí)間戳

updateTimeLong是變更時(shí)間，時(shí)間戳

出參字段：

code000000代表查詢成功，其他的代表查詢失敗

msgcode為其他的時(shí)候，有失敗原因

入?yún)⑹纠齕f

address:string,

“businessHours":"string”,

“certList":"string”,

“channelId":"string”,

cityCode:string,

cityName:string,

“countyCode":"string”,

//countyName/，:“string”,

〃jrr.?“〃i八”

create!1me:16,

“diagnosisDepartment":"string”,

“diagnosisSubject":"string”,

“disabled":"string”,

^insuranceUnitFlag^:"string”,

internetFlag，z:“string”,

“intruduction":"string”,

“isDeleled":"string”,

z/lastAnnualCheckDate，/:“16〃，

“l(fā)atitude":"string”,

“l(fā)egalPersonName":"string”,

“l(fā)egalPersonPhone":"string”,

“l(fā)ongitude〃：“string”,

''medicalOrgCategory*:“string”,

“medicalOrgCode":"string”,

^medicalOrgGeneralCategory77:"string”,

“medicalOrgName〃：“string”,

phone:string,

“postCode":"string”,

provincecode:string,

，，provinceName，/:“string”,

zzstreetCodez/:“string”,

，zstreetName，z:“string”,

updateLime:lb

}]

返回值示例（

"code":"000000”,

"msg":"處理成功”，

"data":null

）

4.2醫(yī)療機(jī)構(gòu)資質(zhì)監(jiān)管-職工信息

服務(wù)名稱同步職工信息

Rest服務(wù)地址/employee

請(qǐng)求方式POST

JSONArray格式，其中每個(gè)JSONObject包含的字段如下

字段名字段類是否必字段說明

型須

medicalOrgCodeString是醫(yī)療機(jī)構(gòu)代碼

medicalOrgNameString是醫(yī)療機(jī)構(gòu)名稱

employeeCodeString是職工編碼

employeeNameString是職工名稱

employeeGenderString是職工性別（參見字典說明）

employeeCategoryString是職工類別（參見字典說明）

idTypeString是證件類型（參見字典說明）

idNoString是證件號(hào)碼

certListString是JSONArray格式的字符串形式。

其中單個(gè)JSONObject的格式如下：

字段名字段名必字段

須？說明

certTypeString是證書

類型

（詳

見字

典說

明）

certNoString是證書

編號(hào)

certNameString是證書

名稱

certExpiryLong否有效

期

issuanceDateLong否發(fā)證

時(shí)間

submissionDateLong否證書

提交

時(shí)間

（即

證書

在架

道的

入庫(kù)

時(shí)

間）

practiceScopeString否執(zhí)業(yè)

范

圍，

多個(gè)

使用

英文

逗號(hào)

分隔

證書類型：醫(yī)師資格證書，醫(yī)師執(zhí)業(yè)證書

（執(zhí)業(yè)范圍必填），抗菌藥考試合格證

birthdayString出生日期

mobilePhoneString手機(jī)號(hào)碼

participationDateString參加工作日期

departmentCodeString職工所在科室編碼

departmentNameString職工所在科室

titleCodeString職稱編碼（參見字典說明）

titleString職稱名稱

educationalCodeString學(xué)歷編碼

isMultiPointString是否多點(diǎn)執(zhí)業(yè)（0:否；1:是）

multiPointOrgString多點(diǎn)執(zhí)業(yè)的結(jié)構(gòu)信息，JSONArray格式的字符

串形式。其中單個(gè)JSONObject的格式如下：

字段名字段名必字段

須？說明

medicalOrgNameString是醫(yī)療

機(jī)構(gòu)

名稱

disabledString是是否停用（0啟用，1停用）

isDeletedString是記錄是否已邏輯刪除，0未刪除1已刪除

createTimeLong是創(chuàng)建時(shí)間

updateTimeLong是變更時(shí)間

出參字段：

code000000代表查詢成功，其他的代表查詢失敗

msgcode為其他的時(shí)候，有失敗原因

入?yún)⑹纠齕{

“birthday":"string”,

“certList":"string”,

^channelId^:“string",

create!ime:16,

〃departmentCode〃：“string”,

“departmentName":"string”,

“disabled":"string”,

“educationalCode":"string”,

“employeeCategory":"string”,

“employeeCode":"string”,

^employeeGender":"string”,

“employeeName":"string”,

idNo:string,

idType:string,

“isDeleted":"string”,

“isMultiPoint":"string”,

“medicalOrgCode":"string”,

“medicalOrgName":"string”,

“mobi1ePhone〃：“string”,

“multiPointOrg":"string”,

^participationDate，z:“string”,

“title":"string”,

“tilleCode":"string",

〃J.qp?〃”、C，，

update!ime:16

}]

返回值示例（

"code":"000000”,

"msg":"處理成功”，

"data":null

）

4.3患者信息-患者基本信息

服務(wù)名稱同步患者基本信息

Rest服務(wù)地址/patient

請(qǐng)求方式POST

JSONArray格式，其中每個(gè)JSONObject包含的字段如下

字段名字段類是否字段說明

型必須

medicalOrgCodeString是醫(yī)療機(jī)構(gòu)代碼

medicalOrgNameString是醫(yī)療機(jī)構(gòu)名稱

personldTypeString個(gè)人標(biāo)識(shí)類型（參見字典說明）患者識(shí)別

是

碼，與患者各種就診信息記錄進(jìn)行關(guān)聯(lián)

personldNoString個(gè)人標(biāo)識(shí)號(hào)，患者識(shí)別碼，與患者各種就診

是

信息記錄進(jìn)行關(guān)聯(lián)

idTypeString是證件類型（參見字典說明）

idNoString是證件號(hào)碼

healthRecordNoString健康檔案編號(hào)

healthCardNoString居民健康卡卡號(hào)

patientSexString是性別（參見字典說明）

patientNameString是姓名

patientTypeString患者類型（參見字典說明）

maritalStatusString婚姻狀況（參見字典說明）

birthdayString出生日期,yyyy-MM-dd

birthRegionString籍貫

nationString是民族（參見字典說明）

countryCodeString是國(guó)籍（參見字典說明）

telephoneString電話號(hào)碼

mobilePhoneString手機(jī)號(hào)碼

workPostCodeString工作單位郵編

workUnitNameString工作單位名稱

workUnitAddressString工作單位地址

workUnitPhoneString工作單位電話號(hào)碼

occupationString職業(yè)

provinceCodeString地址-?。ㄗ灾螀^(qū)、直轄市）編碼

provinceNameString地址-?。ㄗ灾螀^(qū)、直轄市）名稱

cityCodeString地址-市（地區(qū)、州）編碼

cityNameString地址-市（地區(qū)、州）名稱

countyCodeString地址-縣（區(qū)）編碼

countyNameString地址-縣（區(qū)）名稱

streetCodeString街道編碼

streetNameString街道名稱

addressString詳細(xì)地址

postCodeString郵政編碼

regAddressString戶口地址

regAddressPostCodeString戶口地址郵編

contactNameString聯(lián)系人姓名

contactRelationString聯(lián)系人關(guān)系（參見字典說明）

contactAddressString聯(lián)系人地址

contactPostCodeString聯(lián)系人郵編

contactPhoneString聯(lián)系人電話

participationDateLong參加工作日期

emailString電子郵件地址

healthCardldString電子健康卡ID。字符串，不超過128

mindexldString居民健康卡主索引ID。字符串，不超過128

healthCardAttrString電子健康卡屬性。字典：

DICT_EHC_CARD_ATTR字符串,不超過1

healthCardStatusString電子健康卡狀態(tài)。字典：

DICT_EHC_CARD_STAT字符串，不超過1

healthCardQrcodeDataString電子健康卡二維碼內(nèi)容。只返回靜態(tài)二維碼

內(nèi)容字符串，不超過256

guardiansStringJSONArray格式的字符串形式。

其中單個(gè)JSONObject的格式如下：

guardianName監(jiān)護(hù)人姓名，以下監(jiān)

護(hù)人信息必須同時(shí)有