GB∕T 38963-2020 个人健康信息码 应用接口.pdf

书 书 书犐 犆犛 犔 中 华 人 民 共 和 国 国 家 标 准犌犅犜 个人健康信息码应用接口犘 犲 狉 狊 狅 狀 犪 犾犺 犲 犪 犾 狋 犺犻 狀 犳 狅 狉犿犪 狋 犻 狅 狀犮 狅 犱 犲犃狆 狆 犾 犻 犮 犪 狋 犻 狅 狀犻 狀 狋 犲 狉 犳 犪 犮 犲 发布 实施国 家 市 场 监 督 管 理 总 局国 家 标 准 化 管 理 委 员 会发 布书 书 书目次前言引言范围规范性引用文件术语和定义缩略语接口规则 接口方式 服务类型接口说明 概述 用户健康信息申报 用户行程申报接口 用户健康信息查询 健康码调用申请接口 健康码制码请求接口 健康码验码请求接口 用户健康信息纠错接口 接口应用 应用模式 对接模式 附录（资料性附录）健康码 字段使用说明 附录（资料性附录）接口返回代码说明 附录（资料性附录）健康码制码和验码调用示例 参考文献 犌犅犜 前言本标准是个人健康信息码系列标准之一，该系列标准的结构和名称如下：个人健康信息码参考模型；个人健康信息码数据格式；个人健康信息码应用接口。本标准按照 给出的规则起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由国务院办公厅电子政务办公室提出。本标准由全国信息技术标准化技术委员会（）归口。本标准起草单位：国务院办公厅电子政务办公室、中国电子技术标准化研究院、公安部第一研究所、浙江省大数据发展管理局、广东省政务服务数据管理局、上海市大数据中心、河北省政务服务中心、河南省大数据管理局、贵州省人民政府办公厅、南京市政务服务管理办公室、衢州市营商环境建设办公室、浙江省标准化研究院、杭州市数据资源管理局、合肥市数据资源局、中国科学院软件研究所、福建正孚软件有限公司、北京中盾安信科技发展有限公司、大汉软件股份有限公司、深圳市腾讯计算机系统有限公司、支付宝（中国）网络技术有限公司、北京百度网讯科技有限公司、中国电子科技集团有限公司、阿里巴巴（中国）有限公司、腾讯云计算（北京）有限责任公司、电科云（北京）科技有限公司。本标准主要起草人：卢向东、尹智刚、孙富安、李恒训、赵波、孙文龙、杨庄媛、周平、于锐、杨林、国伟、王齐春、陈治佳、杨强、陈亚军、于浩、姜舟、徐云、李景曦、王?萃、李松渊、马晓镌、张晓东、温?、张红振、林文昊、钱学文、姜淑娟、李宁、孙茂阳、齐同军、黄颖纯、聂楚江、赵立、江万鑫、王剑冰、黄炜耀、金震宇、房迎、罗朝亮、杨鹏、李昊龙、林冠辰、仲里、王舒墨、陈磊、陈昊、侯海实、陈丽平、王永霞、滕一帆、王鹏达、焦秀珍。犌犅犜 引言在预防、控制和消除突发公共卫生事件（例如新型冠状病毒感染的肺炎 ）危害的过程中，需要采集、存储和处理个人健康信息，以实现多种管理用途，主要包括：快速获取个人健康的相关信息；统计某种流行病或疾病的相关信息；管理不同地域之间的人员流动；互认健康信息业务等级。年月以来，在 疫情防控和复工复产过程中，全国一体化在线政务服务平台（简称“一体化平台”）提供的防疫健康信息码、部分省（区、市）建设使用的“健康码”，作为个人健康信息码的一种重要形式，成为快速采集、存储和处理个人健康信息的一种有效方式。个人健康信息码在实际应用过程中，存在码制组成和数据格式不一致、数据不共享和互认机制缺乏等问题，给人员跨地区流动带来了不便。因此，从当前的实践情况和长远的应用需求来看，需要实现个人健康信息码的标准一致。除突发公共卫生事件的应急处置外，个人健康信息码在个人医疗、健康养老或其他重大公众活动管理过程中同样适用。本标准中规定的具体事项，法律法规（如中华人民共和国网络安全法 中华人民共和国传染病防治法）另有规定的，需遵照其规定执行。犌犅犜 个人健康信息码应用接口范围本标准规定了个人健康服务接口的接口规则、接口说明和接口应用。本标准适用于个人健康信息相关应用系统的设计、开发和系统集成。规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。中华人民共和国行政区划代码 个人健康信息码参考模型术语和定义 界定的术语和定义适用于本文件。缩略语下列缩略语适用于本文件。：超文本传输协议（）：轻量级的数据交换格式（）：表述性状态转移（）：全球广域网（）接口规则 接口方式个人健康信息服务系统对外发布服务和接受请求应采用符合架构原则的 服务。服务类型健康码相关的服务类型说明见表。表服务类型说明序号服务类型服务名称 健康码调用申请接口 健康码制码接口 健康码验码接口犌犅犜 健康码制码接口中的验证模式说明见表。表制码接口中的验证模式说明序号代码模式名称 居民身份网络标识制码 网证数据制码健康码验码接口中的验证模式说明见表。表验码接口中的验证模式说明序号代码模式名称 业务验码 身份业务验码 身份人像业务验码接口说明 概述接口类型及说明见表。表接口类型及说明序号接口类型接口说明用户健康信息申报接口上传用户申报的健康数据信息用户行程申报接口上传用户在规定的时间范围（例如 天）内行程的数据信息用户健康信息查询接口查询用户在一定时间段内的个人健康信息和行程信息，默认查询时段为相关部门规定的时长（例如 天）健康码调用申请接口客户端向服务端发起业务申请（例如制码、验码等）前需通过该接口申请会话权限健康码制码请求接口向健康码应用系统后台发送制码请求健康码验码请求接口向健康码应用系统后台发送验码请求用户健康信息纠错接口向健康码应用系统后台发送纠正相关信息的请求 用户健康信息申报 调用方式用户健康信息申报接口应通过互联网或政务外网调用。犌犅犜 参数要求用户健康信息申报接口参数要求见表。表用户健康信息申报接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串授权账号 是字符串授权令牌 是字符串按 中 确定的形式拼接，并用密钥加密后的值，参见附录 否字符串联系电话（可填写直系亲属电话号码）是字符串申报时间，时间格式为：是字符串当前所在的城市（州、盟等）是字符串所在的具体地址，例如：社区的名称 是字符串当前所在的县级行政区划代码，应符合 规定 是字符串在卫生健康主管部门规定的时间范围内是否曾经在高风险地区居住或在高风险地区停留，是否 是字符串在卫生健康主管部门规定的时间范围内是否接触过高风险人员（确诊或疑似病例），是否不确定 是字符串当前症状（多选），多项症状用“”分隔 是字符串体温，应填写数字。单位为摄氏度（）输出参数 是字符串返回情况说明 是字符串返回值代码，其取值及含义参见附录返回数据格式统一采用字符串格式。示例：接口调用成功，：用户行程申报接口 调用方式用户行程申报接口应通过互联网或政务外网调用。犌犅犜 参数要求用户行程申报接口参数要求见表。表用户行程申报接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串授权账号 是字符串授权令牌 是字符串按 中 确定的形式拼接，并用密钥加密后的值，参见附录 否字符串联系电话（可填写直系亲属电话号码）是字符串在卫生健康主管部门规定的时间范围内停留过的地方（精确到地市级）的市级行政区划代码，在多地市停留时用英文逗号分隔，例如：，是字符串在卫生健康主管部门规定的时间范围内停留过的地方（精确到地市级）的行政区划名称，多个时用英文逗号分隔，例如：“市，市”否字符串在卫生健康主管部门规定的时间范围内停留过的地址（细化后的县级）的代码，应使用 规定的县级行政区划代码，用英文逗号分隔，例如：，否字符串在卫生健康主管部门规定的时间范围内停留过的地址（细化后的县级）的名称，应使用行政区划名称，多个时用英文逗号分隔，例如：“市区，市区”是字符串申报行程的时间，时间格式为 ：否字符串行程的校验状态，：未校验，：校验成功，：校验失败输出参数 是字符串返回消息 是字符串返回码，其取值及含义参见附录 用户健康信息查询 调用方式用户健康信息查询接口应通过互联网或政务外网调用。参数要求用户健康信息查询接口的参数要求见表。犌犅犜 表用户健康信息查询接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串授权账号 是字符串授权令牌 是字符串按 中 确定的形式拼接，并用密钥加密后的值，参见附录 否字符串查询起始时间，在卫生健康主管部门规定的时间范围内取值，格式为：以 天为例，：查询，则 可取 ：至 ：的任意时间 否字符串查询截止时间，在卫生健康主管部门规定的时间范围内取值，不早于 ，格式为：否字符串业务类型输出参数 是字符串返回消息 是字符串返回码，其取值及含义参见附录 是 用户身份的脱敏信息 否 用户申报的健康信息 是 健康风险信息 否 从各地区汇集的健康证明信息目录数据 否 卫生健康主管部门规定的时间范围内行程数据返回值见示例、示例。示例：接口调用成功，：，：，个人身份证件号码脱敏信息 ：张 姓名脱敏信息，：，：确诊，风险类型 ：，发病日期 ：，确诊日期 ：，接触日期 ：聚餐，接触类型犌犅犜 ：，入院时间 ：出院时间，：，：，：红码（高风险）；：黄码（中风险）；：绿码（低风险）：，健康风险等级评估时间（取值见 ）：，健康风险等级评估原因（取值见 ）：省 来源省份，：，：，：，：体温超过 ，：省 ，：，：市，市，：，：市区，市区，：，：，：，风险等级，和空：代表未查询到风险信息：低风险：中风险：高风险，：，：市，市，：，：市区，市区，：，：，：，示例：接口调用成功，：，：，：，犌犅犜 ：无，：，：，健康码调用申请接口 调用方式客户端向服务端发起业务申请，作为后续操作的凭证，应通过互联网或政务外网调用。参数要求健康码调用申请接口参数要求见表。表健康码调用申请接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串机构标识 是字符串应用标识 否字符串应用用户标识 是字符串业务类型 是字符串制码验码模式 否字符串服务类型为 ，同时制码模式为 时必填，其值由网证认证控件接口的 方法生成 是字符串 签名值的 编码串输出参数 是字符串结果返回码，取值及含义参见附录的表 否字符串结果描述 是字符串业务流水号 是字符串随机数 是字符串 签名值的 编码串犌犅犜 返回数据格式统一采用 格式。示例：，：，：，：，：健康码调用申请、健康码制码请求、健康码验码请求的接口调用示例参见附录。健康码制码请求接口 调用方式健康码制码请求接口应通过互联网或政务外网调用。参数要求健康码制码请求接口参数要求见表。表健康码制码请求接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串机构标识 是字符串应用标识 否字符串应用用户标识 是字符串业务流水号 是字符串业务类型 是字符串制码模式，与调用申请匹配，见表 是字符串业务扩展数据，参见附录 是字符串制码模式为 时，值为居民身份网络标识；制码模式为 时，值为网证数据 是字符串 签名值的 编码串输出参数 是字符串结果返回码，取值及含义参见附录的表 否字符串结果描述 是字符串二维条码图像文件流 是字符串位图边长 是字符串 签名值的 编码串犌犅犜 返回数据格式统一采用 格式。示例：，：，：，：，：健康码验码请求接口 调用方式健康码验码请求接口应通过互联网或政务外网调用。参数要求健康码验码请求接口的参数要求见表。表 健康码验码请求接口参数要求类别参数是否必填 数据类型说明输入参数 是字符串机构标识 是字符串应用标识 是字符串用户标识 是字符串业务类型 是字符串验码模式，与调用申请匹配，见表 是字符串随机数，验证模式为 、时必填 是字符串健康码字符串 否字符串根据验证模式确定，验证模式为 时必填，取值为人像照片数据（加密）编码串 是字符串 签名值的 编码串输出参数 是字符串结果返回码，取值及含义参见附录的表 否字符串结果描述 是字符串业务扩展数据，参见附录 否字符串居民身份网络标识 否字符串应用用户标识 是字符串 签名值的 编码串犌犅犜 返回数据格式统一采用 格式。示例：，：，：，：，：，：用户健康信息纠错接口 调用方式针对健康信息查询页面中的错误信息，用户可发起纠错申请。用户健康信息纠错接口应通过互联网或政务外网调用。接口参数要求用户健