广东省民营诊所疫情哨点信息管理系统接口文档

广东省民营诊所（疫情哨点）信息管理

系统接口文档

2020年2月

目录

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

1.1文档编制目的............................................................5

2.系统接入设计................................................................5

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

2.2报文格式定义............................................................5

2.2.1报文格式说明.........................................................5

2.2.2入参格式：inputData................................................5

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

3.AK/SK认证&参数加解密........................................................8

3.1AK/SK认证.................................................................8

3.2接口入参加密加签.........................................................9

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

4.接口详细设计.................................................................11

4.1医疗机构资质监管-医疗机构信息...........................................11

4.2医疗机构资质监管-职工信息...............................................15

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

4.4附件上传.................................................................25

4.5患者就诊上报............................................................26

4.5.1症状列表明细信息....................................................32

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

5.1职工性别代码............................................................32

5.2身份证件类别代码........................................................33

5.3婚姻状况代码............................................................33

5.4民族代码.................................................................34

5.5国籍代码.................................................................37

5.6职业类别代码............................................................47

5.7ABO血型代码.............................................................51

5.8Rh血型类别代码..........................................................51

5.9专业技术职务代码........................................................52

5.10参保类别代码...........................................................53

5.11医疗机构大类...........................................................53

5.12医疗机构类别...........................................................54

5.13机构资质文件类型.......................................................55

5.14机构科室...............................................................56

5.15医师资质文件...........................................................57

5.16职称....................................................................57

5.17医师执业范围...........................................................58

5.18诊断库..................................................................59

5.19个人标识类型...........................................................59

5.20诊断类别................................................................60

5.21患者类型...............................................................60

5.22联系人关系.............................................................60

5.23职工类别...............................................................61

5.24亲戚关系...............................................................61

5.25人群类别...............................................................62

5.26流行病学史.............................................................62

5.27症状....................................................................63

5.28转诊机构...............................................................64

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

1.引言

1.1文档编制目的

接入开发手册主要表述了接口描述，约定了合作机构与省民营诊所（疫情

哨点）信息管理系统数据同步通信方式与标准规范。

2.系统接入设计

2.1接入模式

省民营诊所（疫情哨点）信息管理系统数据同步服务可以选择通过专线、

公网的不同方式来访问服务，具体访问方式以合作机构约定为准。

测试服务器地址：。

生产服务器地址：。

2.2报文格式定义

2.2.1报文格式说明

本接口输入输出均以JSON格式传输，需符合大小写规则，不同的接口上

传的数据类型不同，可能是JSONArray,也可能是JSONObject,具体如下

参见具体接口的说明。

2.2.2入参格式:inputData

示例（以实际代码和联调数据为准）：

channelld":"10001",

requestld":"-0001",

"encodeKey"testkey200",

"sign"10011001-0001",

"signMethod"sha256",

"timestamp

"versionn:"1.0",

"encodeData":"ZSdSkKnubLoUop5JFbRWeQ"

},

公共报文头数据:

编号字段名称类型（长度）必须说明

提供渠道ID,由省民营诊所（疫

1channelldString是

情哨点）信息管理系统分配

2requestldString否请求唯一ID,由客户端生成

3encodeKeyString是AES密钥（客户端加密使用）

4signString是客户端加密数据生成的摘要

客户端摘要算法（暂时支持

String

5signMethod否

sha256,默认）

6timestampLong否时区GMT+8,单位毫秒

7versionString否接口版本号，默认1.0.0

需耍加密参数组成的json字符串，

8encodeDataString是

然后AES加密所得

2.2.3出参格式：outputData

示例（以实际代码和联调数据为准）：

（

"code":"000000",

"msg":"处理成功"，

"data":{}

},

报文返回信息：

编号字段名称类型（长度）必须说明

接口返回错误码，表示接口调

1codestring是用的非业务属性状态，比如成

功、验证失败等等

2msgstring是错误码的描述信息

3dataJSONObject否业务返回数据

3.AK/SK认证&参数加解密

3.1AK/SK认证

合作方与省民营诊所(疫情哨点)信息管理系统数据同步服务通信时需要根据省民

营诊所(疫情哨点)信息管理系统数据同步平台颁发的AK(AccessKey)和SK(Secret

Key)生成授权信息，并随接口请求一起发送给省民营诊所(疫情哨点)信息管理系统数

据同步服务。合作方生成授权信息算法如下：

1根据请求url和时间戳构造签名字符串stringToSign.

stringToSign=uri_path++http_verb++sign++

timestamp;

uri_path:请求path。例如

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

http_verb:请求动作，如GET、POST等。

sign:请求参数签名信息，请参考3.2节接口入参加密加签。

timestamp:时间戳。

2根据颁发的SK计算签名字符串signature.

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

hmac_shal:签名算法，根据SK生成签名摘要。

str_to_upper:转换为大写字母。

3根据颁发的AK、SK和时间戳、once数据构造授权信息Authorization。

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

once=hash（timestamp的16进制+ip地址/mac地址），即

timestamp的16进制加上ip地址或者mac地址，然后进行hash。

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

4授权信息进行url安全的base64编码。

（）

authorization_base64=urlsafe_base64_encodeauthorizationo

urlsafe_base64_encode:URL安全的base64编码。

5授权信息authorization_base64添加到http请求的header中跟随请求发送给省民

营诊所（疫情哨点）信息管理系统数据同步服务，在header中对应的key为

Authorization,,

3.2接口人参加密加签

合作方与省民营诊所（疫情哨点）信息管理系统数据同步服务通信时需要对入参加密

加签，以保障安全和防止隐私泄露。合作方根据省民营诊所（疫情哨点）信息管理系统数

据同步服务下发的publicKey生成入参加密秘钥encodeKey,对入参加密加签过程如

下：

encodeKey=RSA(randomString,publicKey);

randomstring:随机生成的字符串，AES加密解密秘钥，长度必须为16位字符

（128bit）。

publicKey:RSA加密公钥，由省民营诊所（疫情哨点）信息管理系统数据同步服务下

发。

说明：

1encodeKey添加到请求参数中，对应key为encodeKey;RSA的填充模式

（padding）默认为PKCS1,且采用分段加密（最大加密明文块大小为117）.

2对需要加密的参数（encodeData中的参数）进行AES加密，加密秘钥为

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

IvParameterSpec（取值约定为：0300）增强算法强度;后需进行URL安全的

BASE64编码。

3请求参数按照key字母升序排序。

4用“&”拼接排序后的参数信息，生成字符串：keyl=valuel&key2=value2&...

&keyn=valuen0

5对上述字符串使用公共参数中的signMethod方法提取摘要，目前默认使用

sha256,得到加签字符串sign。

6sign加入请求参数，对应key为sign,随请求一起发往省民营诊所（疫情哨点）

信息管理系统数据同步服务。

3.3接口出参加密

省民营诊所（疫情哨点）信息管理系统数据同步服务返回给合作方的数据进行了AES

加密，加密秘钥为randomstring,需要加密的返回数据都放在encodeData中,合作方

收到数据之后需要解密。

4.接口详细设计

此部分主要对各具体业务作详细说明。

4.1医疗机构资质监管-医疗机构信息

服务名称同步医疗机构信息

Rest服务地址/institution

请求方式POST

JSONArray格式，其中每个JSONObject包含的字段如下

字段名字段类是否必字段说明

型须

medicalOrgCodeString是医疗机构代码

medicalOrgNameString是医疗机构名称

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

其中单个JSONObject的格式如下：

字段名字段名必字段说

须？明

certTypeString是证书类

型（详

见字典

说明）

certNoString是证书编

号

certNameString是证书名

称

certExpiryLong否有效期

nextCheckDateLong否下次年

检时间

issuanceDateLong否发证时

问

医疗机构执业许可证一正本

医疗机构执业许可证一副本首页

医疗机构执业许可证一副本年检时间页包含

下次年检时间（下次年检时间年月日）

其他证件（放射诊疗许可证，辐射安全许可证

等等）

lastAnnualCheckDateLong最新年检日期

diagnosisSubjectString是医疗机构诊疗科目

phoneString医疗机构联系电话

legalPersonNameString医疗机构负责人（法人）姓名

legalPersonPhoneString医疗机构负责人联系电话

provinceCodeString是地址-省（自治区、直辖市）编码

provinceNameString是地址-省（自治区、直辖市）名称

cityCodeString是地址-市（地区、州）编码

cityNameString是地址-市（地区、州）名称

countyCodeString是地址-县（区）编码

countyNameString是地址-县（区）名称

streetCodeString街道编码

streetNameString街道名称

addressString详细地址

postCodeString邮政编码

medicalOrgGeneralCategoryString是医疗机构大类（详见字典说明）

medicalOrgCategoryString是医疗机构类别（详见字典说明）

diagnosisDepartmentString诊疗科室

insuranceUnitFlagString是是否医保定点单位

internetFlagString是是否互联网医院

businessHoursString营业时间

intruductionString机构简介

longitudeString经度

latitudeString纬度

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

isDeletedString是记录是否已逻辑删除，0未删除1已删除

createTimeLong是创建时间，时间戳

updateTimeLong是变更时间，时间戳

出参字段：

code000000代表查询成功，其他的代表查询失败

msgcode为其他的时候，有失败原因

入参示例[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〃，

“latitude":"string”,

“legalPersonName":"string”,

“legalPersonPhone":"string”,

“longitude〃：“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医疗机构资质监管-职工信息

服务名称同步职工信息

Rest服务地址/employee

请求方式POST

JSONArray格式，其中每个JSONObject包含的字段如下

字段名字段类是否必字段说明

型须

medicalOrgCodeString是医疗机构代码

medicalOrgNameString是医疗机构名称

employeeCodeString是职工编码

employeeNameString是职工名称

employeeGenderString是职工性别（参见字典说明）

employeeCategoryString是职工类别（参见字典说明）

idTypeString是证件类型（参见字典说明）

idNoString是证件号码

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

其中单个JSONObject的格式如下：

字段名字段名必字段

须？说明

certTypeString是证书

类型

（详

见字

典说

明）

certNoString是证书

编号

certNameString是证书

名称

certExpiryLong否有效

期

issuanceDateLong否发证

时间

submissionDateLong否证书

提交

时间

（即

证书

在架

道的

入库

时

间）

practiceScopeString否执业

范

围，

多个

使用

英文

逗号

分隔

证书类型：医师资格证书，医师执业证书

（执业范围必填），抗菌药考试合格证

birthdayString出生日期

mobilePhoneString手机号码

participationDateString参加工作日期

departmentCodeString职工所在科室编码

departmentNameString职工所在科室

titleCodeString职称编码（参见字典说明）

titleString职称名称

educationalCodeString学历编码

isMultiPointString是否多点执业（0:否；1:是）

multiPointOrgString多点执业的结构信息，JSONArray格式的字符

串形式。其中单个JSONObject的格式如下：

字段名字段名必字段

须？说明

medicalOrgNameString是医疗

机构

名称

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

isDeletedString是记录是否已逻辑删除，0未删除1已删除

createTimeLong是创建时间

updateTimeLong是变更时间

出参字段：

code000000代表查询成功，其他的代表查询失败

msgcode为其他的时候，有失败原因

入参示例[{

“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患者信息-患者基本信息

服务名称同步患者基本信息

Rest服务地址/patient

请求方式POST

JSONArray格式，其中每个JSONObject包含的字段如下

字段名字段类是否字段说明

型必须

medicalOrgCodeString是医疗机构代码

medicalOrgNameString是医疗机构名称

personldTypeString个人标识类型（参见字典说明）患者识别

是

码，与患者各种就诊信息记录进行关联

personldNoString个人标识号，患者识别码，与患者各种就诊

是

信息记录进行关联

idTypeString是证件类型（参见字典说明）

idNoString是证件号码

healthRecordNoString健康档案编号

healthCardNoString居民健康卡卡号

patientSexString是性别（参见字典说明）

patientNameString是姓名

patientTypeString患者类型（参见字典说明）

maritalStatusString婚姻状况（参见字典说明）

birthdayString出生日期,yyyy-MM-dd

birthRegionString籍贯

nationString是民族（参见字典说明）

countryCodeString是国籍（参见字典说明）

telephoneString电话号码

mobilePhoneString手机号码

workPostCodeString工作单位邮编

workUnitNameString工作单位名称

workUnitAddressString工作单位地址

workUnitPhoneString工作单位电话号码

occupationString职业

provinceCodeString地址-省（自治区、直辖市）编码

provinceNameString地址-省（自治区、直辖市）名称

cityCodeString地址-市（地区、州）编码

cityNameString地址-市（地区、州）名称

countyCodeString地址-县（区）编码

countyNameString地址-县（区）名称

streetCodeString街道编码

streetNameString街道名称

addressString详细地址

postCodeString邮政编码

regAddressString户口地址

regAddressPostCodeString户口地址邮编

contactNameString联系人姓名

contactRelationString联系人关系（参见字典说明）

contactAddressString联系人地址

contactPostCodeString联系人邮编

contactPhoneString联系人电话

participationDateLong参加工作日期

emailString电子邮件地址

healthCardldString电子健康卡ID。字符串，不超过128

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

healthCardAttrString电子健康卡属性。字典：

DICT_EHC_CARD_ATTR字符串,不超过1

healthCardStatusString电子健康卡状态。字典：

DICT_EHC_CARD_STAT字符串，不超过1

healthCardQrcodeDataString电子健康卡二维码内容。只返回静态二维码

内容字符串，不超过256

guardiansStringJSONArray格式的字符串形式。

其中单个JSONObject的格式如下：

guardianName监护人姓名，以下监

护人信息必须同时有