GB/T 38963-2020 个人健康信息码 应用接口 GB/T38963-2020 标准压缩包解压密码：www.bzxz.net

ICS35.240.99
中华人民共和国国家标准
GB/T38963—2020
个人健康信息码
应用接口
Personal health information codeApplication interface2020-04-29发布
国家市场监督管理总局
国家标准化管理委员会
2020-04-29实施
规范性引用文件
术语和定义
缩略语
接口规则
接口方式
服务类型
接口说明
用户健康信息申报
用户行程申报接口
用户健康信息查询
健康码调用申请接口
健康码制码请求接口
健康码验码请求接口
用户健康信息纠错接口
接口应用
应用模式
对接模式
附录A（资料性附录）
附录B（资料性附录）
附录C（资料性附录）
参考文献
健康码BizExtData字段使用说明接口返回代码说明
健康码制码和验码调用示例
GB/T38963—2020
本标准是《个人健康信息码》系列标准之一，该系列标准的结构和名称如下：个人健康信息码参考模型；
GB/T389612020
—GB/T38962—2020个人健康信息码数据格式；—GB/T38963—2020个人健康信息码应用接口。本标准按照GB/T1.1—2009给出的规则起草。GB/T38963-—2020
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由国务院办公厅电子政务办公室提出本标准由全国信息技术标准化技术委员会（SAC/TC28）归口本标准起草单位：国务院办公厅电子政务办公室、中国电子技术标准化研究院、公安部第一研究所、浙江省大数据发展管理局、广东省政务服务数据管理局、上海市大数据中心、河北省政务服务中心、河南省大数据管理局、贵州省人民政府办公厅、南京市政务服务管理办公室、衢州市营商环境建设办公室、浙江省标准化研究院、杭州市数据资源管理局、合肥市数据资源局、中国科学院软件研究所、福建正孚软件有限公司、北京中盾安信科技发展有限公司、大汉软件股份有限公司、深圳市腾讯计算机系统有限公司、支付宝（中国）网络技术有限公司、北京百度网讯科技有限公司、中国电子科技集团有限公司、阿里巴巴(中国)有限公司、腾讯云计算（北京）有限责任公司、电科云（北京)科技有限公司本标准主要起草人：卢向东、尹智刚、孙富安、李恒训、赵波、孙文龙、杨庄媛、周平、于锐、杨林、国伟王齐春、陈治佳、杨强、陈亚军、于浩、姜舟、徐云、李景曦、王赞萃、李松渊、马晓镌、张晓东、温喆、张红振林文昊、钱学文、姜淑娟、李宁、孙茂阳、齐同军、黄颖纯、聂楚江、赵立、江方鑫、主剑冰、黄炜耀、金震宇、房迎、罗朝亮、杨鹏、李昊龙、林冠辰、仲里、王舒墨、陈磊、陈昊、侯海实、陈丽平、王永霞、藤一帆、王鹏达、焦秀珍。
GB/T38963—2020
在预防、控制和消除突发公共卫生事件（例如新型冠状病毒感染的肺炎COVID-19)危害的过程中，需要采集、存储和处理个人健康信息，以实现多种管理用途，主要包括：快速获取个人健康的相关信息；统计某种流行病或疾病的相关信息；管理不同地域之间的人员流动；互认健康信息业务等级。
2020年2月以来，在COVID-19疫情防控和复工复产过程中，全国一体化在线政务服务平台（简称“一体化平台”）提供的防疫健康信息码、部分省（区、市）建设使用的“健康码”，作为个人健康信息码的种重要形式，成为快速采集、存储和处理个人健康信息的一种有效方式。个人健康信息码在实际应用过程中，存在码制组成和数据格式不一致、数据不共享和互认机制缺乏等问题，给人员跨地区流动带来了不便。因此，从当前的实践情况和长远的应用需求来看，需要实现个人健康信息码的标准一致。除突发公共卫生事件的应急处置外，个人健康信息码在个人医疗、健康养老或其他重大公众活动管理过程中同样适用。
本标准中规定的具体事项，法律法规（如《中华人民共和国网络安全法》《中华人民共和国传染病防治法》另有规定的，需遵照其规定执行IN
1范围
个人健康信息码
应用接口
本标准规定了个人健康服务接口的接口规则、接口说明和接口应用。本标准适用于个人健康信息相关应用系统的设计、开发和系统集成。规范性引用文件
GB/T38963—2020
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T2260中华人民共和国行政区划代码GB/T38961—2020个人健康信息码参考模型术语和定义
GB/T38961—2020界定的术语和定义适用于本文件。4
缩略语
下列缩略语适用于本文件。
HTTP：超文本传输协议（HyperTextTransferProtocol）JSON：轻量级的数据交换格式（JavaScriptObjectNotation）REST：表述性状态转移（RepresentationalStateTransfer）Web：全球广域网（WorldWideWeb）5
接口规则
接口方式
个人健康信息服务系统对外发布服务和接受请求应采用符合REST架构原则的Web服务。5.2
2服务类型
健康码相关的服务类型说明见表1。表1服务类型说明
服务类型
健康码调用申请接口
健康码制码接口
健康码验码接口
服务名称
GB/T38963—2020
健康码制码接口中的验证模式说明见表2。表2
制码接口中的验证模式说明
模式名称
居民身份网络标识制码
网证数据制码
健康码验码接口中的验证模式说明见表3。表3验码接口中的验证模式说明
接口说明
接口类型及说明见表4。
接口类型
业务验码
身份+业务验码
身份十人像十业务验码
表4接口类型及说明
用户健康信息申报接口
用户行程申报接口
用户健康信息查询接口
健康码调用电请接口
健康码制码请求接口
健康码验码请求接口
用户健康信息纠错接口
用户健康信息申报
调用方式
模式名称
接口说明
上传用户申报的健康数据信息
上传用户在规定的时间范围（例如14天）内行程的数据信息查询用户在一定时间段内的个人健康信息和行程信息，默认查询时段为相关部门规定的时长（例如14天）客户端向服务端发起业务申请（例如制码、验码等）前需通过该接口申请会话权限
向健康码应用系统后台发送制码请求向健康码应用系统后台发送验码请求向健康码应用系统后台发送纠正相关信息的请求用户健康信息申报接口应通过互联网或政务外网调用，2
参数要求
用户健康信息申报接口参数要求见表5。表5
Accountld
AccessToken
BizExtData
Xzqhdm
IsEpidemicAreaRisk
IsPatientContactRisk
Symptom
Temperature
head.message
head.status
是否必填
用户健康信息申报接口参数要求数据类型
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
返回数据格式统
一采用字符串格式
示例：
\head\
\message\：“接口调用成功\，\status\：\o\
用户行程申报接口
调用方式
授权账号
授权令牌
GB/T38963—2020
按GB/T38961—2020中4.2确定的形式拼接，并用密钥加密后的值，参见附录A
联系电话（可填写直系亲属电话号码）申报时间，时间格式为YYYY-MM-DDHH：MMSS当前所在的城市（州、盟等）
所在的具体地址，例如：社区的名称当前所在的县级行政区划代码，应符合GB/T2260规定在卫生健康主管部门规定的时间范围内是否曾经在高风险地区居住或在高风险地区停留，1.是/2.否在卫生健康主管部门规定的时间范围内是否接触过高风险人员（确诊或疑似病例），1.是/2.否/3.不确定当前症状（多选），多项症状用\-”分隔体温，应填写数字。单位为摄氏度（℃）返回情况说明
返回值代码，其取值及含义参见附录B用户行程申报接口应通过互联网或政务外网调用GB/T38963—2020
6.3.2参数要求
用户行程申报接口参数要求见表6。用户行程申报接口参数要求
Accountld
AccessToken
BizExtData
StopoverCity
StopoverCityName
StopoverCounty
StopoverCountyName
PathStatus
head.message
head.status
用户健康信息查询
调用方式
是香必填
数据类型
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
授权账号
授权令牌
按GB/T389612020中4.2确定的形式拼接.并用密钥加密后的值，参见附录A
联系电话（可填写直系亲属电话号码）在卫生健康主管部门规定的时间范围内停留过的地方（精确到地市级）的市级行政区划代码，在多地市停留时用英文逗号分隔，例如：330100，330200在卫生健康主管部门规定的时间范围内停留过的地方（精确到地市级）的行政区划名称，多个时用英文逗号分隔，例如：\×X市，XX市”
在卫生健康主管部门规定的时间范围内停留过的地址（细化后的县级）的代码，应使用GB/T2260规定的县级行政区划代码，用英文逗号分隔，例如：330102，330206在卫生健康主管部门规定的时间范围内停留过的地址（细化后的县级)的名称，应使用行政区划名称，多个时用英文逗号分隔，例如：“××市××区，××市××区”申报行程的时间，时间格式为YYYY-MM-DDHH：MM:SS
行程的校验状态，0：未校验.1：校验成功，2：校验失败返回消息
返回码，其取值及含义参见附录B用户健康信息查询接口应通过互联网或政务外网调用。6.4.2
参数要求
用户健康信息查询接口的参数要求见表7。4
AccountId
AccessToken
BizExtData
StartDate
EndDate
BizType
head.message
head.status
person
yqReports
yqWarn
healthyReport
返回值见示例1、示例2
示例1：
是否必填
“message\：\接口调用成功\\status\.\o\
\data\+此内容来自标准下载网
persont
用户健康信息查询接口参数要求数据类型
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
授权账号
授权令牌
按GB/T38961
GB/T38963—2020
2020中4.2确定的形式拼接，并用密钥加密后的值，参见附录A
查询起始时间，在卫生健康主管部门规定的时间范围内取值，格式为YYYY-MM-DDHH:MM.SS以14天为例，2020-02-1608：30：00查询，则StartDate可取2020-02-0208：30：00至2020-02-1608:30:00的任意时间查询截止时间，在卫生健康主管部门规定的时间范围内取值，不早于StartDate.格式为YYYY-MM-DDHH：MM.SS业务类型
返回消息
返回码，其取值及含义参见附录B用户身份的脱敏信息
用户申报的健康信息
健康风险信息
从各地区汇集的健康证明信息目录数据卫生健康主管部门规定的时间范围内行程数据\desensitizeCardId\：\131************314\，//个人身份证件号码脱敏信息\desensitizeName\\张*”
yqReports:Et
yqWarn:t
\warnType\：\确诊\，
\fbrq\\2020-02-10\
\qzrq\：\2020-02-10\,
\jcrq\\2020-02-10\
//姓名脱敏信息
1/风险类型
1/发病目期
7/确诊日期
//接触日期
\jclx\“聚餐”，
//接触类型
GB/T38963—2020
\mdtrtDate\\2020-02-10\,/入院时间
\dscgDate\\2020-02-20\
healthyReport:L
\name\：\o\,
//出院时间
\healthyStaus\：\00\，//10：红码（高风险）；01：黄码（中风险）；00：绿码（低风险）\date\：\2020-03-02\，//健康风险等级评估时间（取值见GB/T38962—2020）\reason\：\\，//健康风险等级评估原因（取值见GB/T38962—2020）\dataSource\；\XX省\
//来源省份
\name\.\i\,
\healthyStaus\\ol\.
\date\；\2020-03-02\.
\reason\：\体温超过37.3℃\，\dataSource\：\XX省\
xcgj:L
\stopoverCity\：\330100.330200\\stopoverCityName\：\XX市XX市\.\stopoverCounty\:\330102.330205\\stopoverCountyName\：\XX市XX区，XX市XX区\\date\\2020-03-12\.
\pathStatus\\1\,
1/风险等级：0和空：代表未查询到风险信息1低风险2：中风险3：高风险\fxdj\.\o.o\
\stopoverCity\：\330100.330200\,\stopoverCityName\：\xx市.xx市\\stopoverCounty\：\330102.330205\,\stopoverCountyName\\xx市xx区，xx市xx区\，\date\：\2020-03-11\,
\pathStatus\,\\\,
\fxdj\.\o.o\
示例2：
\message\：\接口调用成功\，\status\.\o\
yqDatas:[,.
yqReports:[,f].
yqWarn：f
\warnType\：\无”
healthyReport.[
健康码调用申请接口
6.5.1调用方式
GB/T38963-—2020
客户端向服务端发起业务申请，作为后续操作的凭证，应通过互联网或政务外网调用6.5.2
参数要求
健康码调用申请接口参数要求见表8表8
bizPackage.orgCode
bizPackage.appld
bizPackage.appUserld
bizPackage.bizType
bizPackage.bizData.authMode
bizPackage.bizData.applyDatasign
bizPackage.resultCode
bizPackage.resultDesc
bizPackage.bizData.bsn
bizPackage.bizData,randomNumbersign
健康码调用申请接口参数要求
是否必填
数据类型
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
机构标识
应用标识
应用用户标识
业务类型
制码/验码模式
服务类型为2000.同时制码模式为G010时必填，其值由网证认证控件接口的getApplyData方法生成
bizPackage签名值的Base64编码串结果返回码，取值及含义参见附录B的表B.2结果描述
业务流水号
随机数
bizPackage签名值的Base64编码串GB/T38963—2020
返回数据格式统
一采用JSON格式。
示例：
\bizPackage\：
\resultCode\\o\.
\resultDese\\\,
\bizData\：
\bsn\\\,
\randomNumber\\\\,
\sign\\
健康码调用申请、健康码制码请求、健康码验码请求的接口调用示例参见附录C。6.6
健康码制码请求接口
调用方式
健康码制码请求接口应通过互联网或政务外网调用6.6.2
参数要求
健康码制码请求接口参数要求见表9。表9
bizPackage.orgCode
bizPackage.appld
bizPackage.appUserld
bizPackage.bsn
bizPackage,bizType
bizPackage.bizData.authMode
bizPackage.bizData.bizExtDatabizPackage.bizData.identityDatasign
bizPackage.resultCode
bizPackage.resultDesc
bizPackage.bizData.imgStreambizPackage.bizData.width
健康码制码请求接口参数要求
是否必填
数据类型
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
字符串
机构标识
应用标识
应用用户标识
业务流水号
业务类型
制码模式，与调用申请匹配，见表2业务扩展数据，参见附录A
制码模式为G100时·值为居民身份网络标识：制码模式为G010时，值为网证数据bizPackage签名值的Base64编码串结果返回码，取值及含义参见附录B的表B.2结果描述
二维条码图像文件流
位图边长
bizPackage签名值的Base64编码串
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。