T-CESA《智能医疗 跨队列数据处理平台 队列数据共享接口模型》

ICS35.240

L70

团体标准

T/CESAXXXX—2024

智能医疗跨队列数据处理平台队列数据

共享接口模型

IntelligenceHealthcare-Cross-CohortDataProcessingPlatform-APImodelfor

cohortdatasharing

征求意见稿

在提交反馈意见时，请将您知道的相关专利连同支持性文件一并附上。

已授权的专利证明材料为专利证书复印件或扉页，已公开但尚未授权的专利申请

证明材料为专利公开通知书复印件或扉页，未公开的专利申请的证明材料为专利申请

号和申请日期。

2024-XX-XX发布2024-XX-XX实施

中国电子工业标准化技术协会发布

T/CESAXXXX-2024

目次

目次II

前言III

引言IV

智能医疗跨队列数据处理平台队列数据共享接口模型1

1范围1

2规范性引用文件1

3术语和定义1

4总体框架2

5队列数据共享接口设计原则2

5.1基本原则2

5.2命名原则3

6接口形式3

6.1通信协议4

6.2数据格式4

6.3接口请求4

6.4接口响应5

7典型的队列数据共享接口7

7.1总则7

7.2登录/登出7

7.3数据传输10

8数据安全14

8.1部署方式14

8.2请求方式14

8.3系统登录14

II

T/CESAXXXX-2024

引言

《智能医疗跨队列数据处理平台》系列标准旨在确立适用于医疗领域跨队列数据处理平台所需的

各项基础要求，拟由七个部分构成。

——元模型表示要求，目的在于规定跨队列数据处理平台中元模型表示相关基本要求。

——元模型构建要求，目的在于规定跨队列数据处理平台中元模型构建相关基本要求。

——数据表示要求，目的在于规定跨队列数据处理平台中数据表示相关基本要求。

——队列数据共享接口模型，目的在于规定跨队列数据处理平台中对接队列信息系统的共享接口及

其描述要求。

——逻辑模型，目的在于规定跨队列数据处理平台中的统一逻辑模型。

——隐私数据共享与访问要求，目的在于规定跨队列数据处理平台中隐私数据共享与访问相关基本

要求。

——数据脱敏流程要求，目的在于规定跨队列数据处理平台中数据脱敏流程及各环节基本要求。

IV

T/CESAXXXX-2024

智能医疗跨队列数据处理平台队列数据共享接口模型

1范围

本标准给出了队列数据共享开放背景下队列数据共享接口模型，模型给出了语义明确的队列数据共

享接口，以及接口的属性与属性内涵。

本标准适用于以数据共享服务接口形式实现队列信息系统互联、数据获取与汇聚的接口提供者和使

用者。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。

凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB/T32419.2-2016信息技术SOA技术实现规范第2部分：服务注册与发现

3术语和定义

3.1队列数据共享接口APIsforcohortdatasharing

队列数据共享接口是指用于满足队列数据开放共享目的，可与队列信息系统进行数据交互的应用程

序编程接口（API）。

3.2队列信息系统informationsystemascohortdatasource

队列信息系统是指用于实施队列数据共享接口开发的信息系统。

3.3RESTful接口RESTfulAPI

符合REST（RepresentationalStateTransfer）软件架构，基于HTTP/HTTPS，使用JSON（JavaScript

ObjectNotation，JS对象简谱）或XML（ExtensiveMarkupLanguage，可扩展标示语言）作为交换数

据格式的一种接口形式。RESTful接口是本文件队列数据共享接口采用的形式。

3.4接口标识APIidentifier

接口标识用于标识队列数据共享接口，对接口加以区分。

3.5数字对象架构DigitalObjectArchitecture（DOA）

罗伯特·卡恩提出的以数据为中心的软件体系结构，包括一个基本模型、两个基础协议和三个核心

系统。一个基本模型即数字对象（DO），用于抽象互联网中的数据，使得异构数据资源可以采用统一的

形式进行建模和描述。

3.6数字对象标识DigitalObjectIdentity（DOI）

1

T/CESAXXXX-2019

分配给每个数字对象的一个全局唯一的标识，标识作为数字对象的核心属性，不以数字对象的所有

者、存储位置、访问方式的改变而改变。每项需要共享的队列数据应分配一个数字对象标识。

4总体框架

队列数据共享接口模型的总体框架如图1所示。数据应用通过调用标准化接口，即可使用队列信

息系统共享的队列数据。各队列信息系统（队列数据拥有方）基于本标准进行接口设计和开发，提供队

列数据共享接口，即可被采用本标准的数据应用方无缝对接。

图1总体框架

本标准第5、6、7、8章节分别对接口设计原则、接口描述规范、接口安全规范进行了明确描述，并

给出了典型的队列数据共享接口清单以及相关参数定义，清单中未列出的其它接口根据本标准要求自行

定义。

5队列数据共享接口设计原则

5.1基本原则

5.1.1标识唯一性

跨队列数据共享接口具有标识唯一性原则，主要包括：

a）队列数据共享接口宜采用分组管理，分组应具有唯一标识。

b）同一分组下的接口应具有唯一标识，对同一队列信息系统开发的数据共享接口应归并于同一

分组，通过接口标识区分。

c）一个接口只应对应一项业务/数据，不同业务/数据不应使用相同的接口标识。

d）共享的队列数据应具有唯一的数字对象标识。

5.1.2数据约束性

跨队列数据共享接口的数据约束性原则主要包括：

a）队列数据共享接口单次响应数据条目数不应超过1000条。

b）队列信息系统数据条目数过大时，接口应设置分页参数，响应数据应采用分页形式返回数据。

2

T/CESAXXXX-2024

5.1.3接口调用同步性

队列数据共享接口的使用者和提供者采用同步调用方式进行数据交互，接口使用者发起请求后应同

步等待响应数据返回。

5.1.4接口调用可追溯性

接口使用者在调用接口过程中应设置用户标识参数，接口的调用行为应被记录，接口调用记录应被

持久化保存，接口调用行为可追溯。

5.2命名原则

5.2.1分组标识命名

接口分组标识的命名应采用队列信息系统名称或所属业务名称，采用相应英文名称，遵循“驼峰命

名法”。

5.2.2队列数据共享接口命名

队列数据共享接口的命名应结合队列信息系统业务/数据名称，采用相应英文名称，遵循“驼峰命

名法”，宜使用下列适当的命名方式：

a）验证码接口，名称宜使用“captcha”；

b）登录接口，名称宜使用“login”；

c）登出接口，名称宜使用“logout”；

d）数据提交/信息录入接口，名称宜使用“xxxxCommit”，其中“xxxx”为数据内容名称；

e）查询/搜索/列表接口，名称宜使用“xxxxList”，其中“xxxx”为数据内容名称；

f）详情/内容接口，名称宜使用“xxxxDetail”，其中“xxxx”为数据内容名称；

g）图片接口，名称宜使用“xxxxImage”，其中“xxxx”为图片内容名称；

h）文件下载接口，名称宜使用“xxxxFileDownload”，其中“xxxx”为文件名称；

i）文件上传接口，名称宜使用“xxxxFileUpload”，其中“xxxx”为文件名称；

j）响应结果/结论接口，名称宜使用“xxxxResult”，其中“xxxx”为结果/结论名称。

5.2.3请求参数命名

队列数据共享接口请求参数的命名应结合队列信息系统业务/数据名称，采用相应英文名称，遵循

“驼峰命名法”，宜使用下列适当的命名方式：

a）用户名，名称宜使用“username”；

b）密码，名称宜使用“password”；

c）页码，名称宜使用“page”，表示第几页；

d）页数，名称宜使用“pageSize”，表示总分页数；

e）查询/检索关键字，名称宜使用“keyword”；

5.2.4响应参数命名

队列数据共享接口响应参数的命名应结合队列信息系统业务/数据名称，采用相应英文名称，遵循

“驼峰命名法”。

6接口形式

3

T/CESAXXXX-2019

6.1通信协议

考虑便利性和适用性，本文件要求采用RESTful接口的形式描述队列数据共享接口。队列数据共享

接口要求使用HTTP/HTTPS通信协议。

6.2数据格式

数据格式应采用标准JSON或XML数据格式。JSON结构为“名称/值”对的集合和值的有序列表，“值”

类型应为字符串类型（String）、数字类型（Number）、布尔类型（Boolean）、对象类型（Object）、

数组类型（Array）之一。

6.3接口请求

6.3.1请求方式

队列数据共享接口应采用下列两种请求方式之一或同时采用下列两种请求方式：

a)GET请求：GET请求形式应为http(s)://[host]:[port]/[servicename]/?[请求参数]。其中，

[host]:[port]为队列数据共享接口运行环境的主机地址和端口，[servicename]为队列数据共

享接口的分组标识。GET请求无请求体。

b)POST请求：POST请求形式应为http(s)://[host]:[port]/[servicename]。其中，[host]:[port]

为队列数据共享接口运行环境的主机地址和端口，[servicename]为队列数据共享接口的分组

标识。请求参数列表置于请求体，请求体数据应为标准JSON数据，请求体数据编码应为UTF-8。

6.3.2请求参数

请求参数应包含系统级参数和业务级参数两类参数。系统级参数为必填参数，由cmd和apikey两

个参数组成。其中，cmd为队列数据共享接口在所属分组下的唯一标识，apikey是使用队列数据共享接

口的授权标识，如表1所示。业务级参数应根据队列数据共享需求定义。请求参数应由参数名称、参数

类型、是否必填、参数位置、参数说明五部分描述。

表1系统级参数

参数名参数类型是否必填参数位置参数说明

cmdString是请求头或请求体队列数据共享接口在所属分组的唯一标识

使用队列数据共享接口的授权标识，用于标记队列数据

共享接口使用者，apikey应采用UUID（Universally

apikeyString是请求头或请求体

UniqueIdentifier），仅授权的apikey可正常使用接

口

6.3.3请求数据

请求数据格式要求包括：

a)GET请求数据格式

4

T/CESAXXXX-2024

?apikey=[apikey]&cmd=[接口名]&[业务参数名1]=[业务参数值1]&…&[业务参数名N]=[业务参数值N]

b)POST请求数据格式

表2POST请求数据格式

JSONXML

<?xmlversion="1.0"encoding="UTF-8"?>

{

<request>

"apikey":[apikey],

<apikey>1q7yh4930iry3</apikey>

"cmd":[接口名],

<cmd>login</cmd>

"[业务参数名1]":"[业务参数值1]",

<[业务参数名1]>[业务参数值1]</[业务参数名1]>

…,

…,

"[业务参数名N]":"[业务参数值N]"

<[业务参数名N]>[业务参数值N]</[业务参数名N]>

}

</request>

6.4接口响应

6.4.1响应数据

接口响应数据应为脱敏后的文件或标准JSON或XML数据。若响应数据为JSON数据，数据编码应为

UTF-8，由响应参数构成。响应参数由参数名称、参数类型和参数说明三部分描述。

响应数据的首层响应参数有且仅能包含返回码（rtnCode）、返回消息（rtnMsg）和返回数据（data）

三部分组成：

a）返回码（rtnCode）：String类型，队列数据共享接口的响应状态。返回码应为一个6位数字

字符串。接口调用成功应返回“000000”，接口调用异常应返回相应错误码（参考表3）。

b）返回消息（rtnMsg）：String类型，队列数据共享接口返回的状态信息。接口调用成功应返

回“调用成功”，接口调用异常应返回异常信息（参考表3）。

c）返回数据（data）：Object类型，队列数据共享接口的返回数据。当接口调用异常时，返回

数据（data）应为空。

表3接口返回码、返回消息定义

序号返回码(rtnCode)返回消息(rtnMsg)

1000000调用成功

2900001验证码错误

3900002用户名或密码错误

4900003未登录或登录超时，请重新登录

5900004未输入参数或参数格式有误

5

T/CESAXXXX-2019

6900005没有当前查询数据

7900006返回数据存在异常

8999999请求发生异常

队列数据共享接口响应数据应符合下列格式：

表4响应数据格式

JSONXML

<?xmlversion="1.0"encoding="UTF-8"?>

<response>

<object>

{

"rtnCode":"[返回码]",<data>

"rtnMsg":"[返回消息]",

业务数据

"data":{

业务数据</data>

}

<rtnMsg>[返回码]</rtnMsg>

}

<rtnCode>[返回消息]</rtnCode>

</object>

</response>

按照上述格式，队列数据共享接口响应数据可参照下列具体示例：

表5响应数据示例

JSONXML

正常响应示例：正常响应示例：

{

<?xmlversion="1.0"encoding="UTF-8"?>

"rtnCode":"000000",

"rtnMsg":"调用成功",<response>

"data":{

<object>

业务数据

}<data>

}

业务数据

异常响应示例：

{</data>

"rtnCode":"999999",

<rtnMsg>调用成功</rtnMsg>

"rtnMsg":"请求发生异常",

6

T/CESAXXXX-2024

"data":{}<rtnCode>000000</rtnCode>

}

</object>

</response>

异常响应示例：

<?xmlversion="1.0"encoding="UTF-8"?>

<response>

<object>

<data></data>

<rtnMsg>请求发生异常</rtnMsg>

<rtnCode>999999</rtnCode>

</object>

</response>

7典型的队列数据共享接口

7.1总则

典型的队列数据共享接口名称及说明见表6。

表6典型的队列数据共享接口名称及说明

序号接口说明

1登录/登出对队列信息系统执行登录/登出操作

2数据传输对队列信息系统执行队列数据获取操作，包含数据目录、列表数据、详情数据

等接口

7.2登录/登出

7.2.1普通登录

普通登录接口标识及描述主要包括：

a)接口标识（cmd）：login。

b)说明：根据用户名、密码对队列信息系统执行登录操作，并返回队列信息系统的登录状态。

c)请求方式：POST。

d)请求参数：见表7。

7

T/CESAXXXX-2019

表7普通登录请求参数

序号参数名类型是否必填参数位置参数说明

1usernameString是请求体登录使用的用户名

2passwordString是请求体登录使用的密码

e)响应参数：见表8。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

表8普通登录响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回信息

3dataObject返回数据

3.1statusString登录状态

7.2.2验证码登录

验证码登录接口标识及描述主要包括：

a)接口标识（cmd）：captchaLogin。

b)说明：根据用户名、密码、验证码对队列信息系统执行登录操作，并返回队列信息系统登录状

态。

c)请求方式：POST。

d)请求参数：见表9。

表9验证码登录请求参数

序号参数名类型是否必填参数位置参数说明

1usernameString是请求体登录使用的用户名

2passwordString是请求体登录使用的密码

3captchaString是请求体登录时队列信息系统验证码内容

e)响应参数：见表10。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

表10验证码登录响应参数

序号参数名类型参数说明

8

T/CESAXXXX-2024

1rtnCodeString返回码

2rtnMsgString返回信息

3dataObject返回数据

3.1statusString登录状态

7.2.3验证码

验证码接口标识及描述主要包括：

a)接口标识（cmd）：captcha。

b)说明：获取队列信息系统登录验证码文件。

c)请求方式：GET/POST。

d)请求参数：无。

e)响应参数：见表11。请求成功时，返回经编码的验证码文件二进制流；请求异常时，返回码rtnCode

参照表3。

表11验证码响应参数（请求异常时）

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回消息

3dataObject空对象

7.2.4登出

登出接口标识及描述主要包括：

a)接口标识（cmd）：logout。

b)说明：对队列信息系统执行登出操作，并返回队列信息系统登出状态。

c)请求方式：GET/POST。

d)请求参数：无。

e)响应参数：见表12。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

表12登出响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回信息

3dataObject返回数据

3.1statusString登出状态

9

T/CESAXXXX-2019

7.3数据传输

7.3.1数据目录

数据目录接口标识及描述主要包括：

a)接口标识（cmd）：catalog。

b）说明：获取队列信息系统提供的数据共享接口清单。

c）请求方式：POST。

d）请求参数：无。

e）响应参数：见表13。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

表13数据目录响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回消息

3dataArray数据共享接口清单

3.1urlString请求地址

3.2methodString请求方式

3.3paramsArray请求参数

7.3.2列表数据

受试者列表

受试者列表接口标识及描述主要包括：

a)接口标识（cmd）：caseList。

b)说明：获取队列信息系统队列研究受试者列表。

c)请求方式：GET/POST。

d)请求参数：见表14。

表14受试者列表请求参数

序号参数名类型是否必填参数位置参数说明

1pageNumber否请求头或请求体受试者列表的页码，默认为1

e)响应参数：见表15。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

1

T/CESAXXXX-2024

表15受试者列表响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回消息

3dataObject返回数据

3.1totalNumberNumber受试者列表总条目数

3.2currentNumberNumber当前返回列表条目数

3.3totalPageSizeNumber分页总页数

3.4currentPageNumber当前页码

3.5dataListArray当前返回受试者列表

3.5.1caseDOIString受试者唯一数字对象标识

3.5.2nameString受试者姓名

3.5.3nameInitialsString姓名缩写

3.5.4caseNumberString病历号

3.5.5sexString性别

3.5.6nationString民族

3.5.7diseasesString疾病种类

3.5.8researcherString研究者

3.5.9organizationString机构

3.5.10addTimeString添加时间

3.5.11screeningGroupString纳排分组

3.5.12screeningStatusString纳排状态

3.5.13entryTimeString入组时间

3.5.14gatherGroupString入组分组

3.5.15gatherStatusString入组状态

3.5.16baseTimeString基准时间

业务阶段列表

11

T/CESAXXXX-2019

业务节点列表接口标识及描述主要包括：

a)接口标识（cmd）：stepList。

b)说明：获取队列信息系统队列研究的业务阶段。

c)请求方式：GET/POST。

d)请求参数：无。

e)响应参数：请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode参照表3。

7.3.3详情数据

客观指标（实验室检查）

实验室检查数据详情接口标识及描述主要包括：

a)接口标识（cmd）：labTestsDetail。

b)说明：获取队列信息系统队列研究实验室检查数据详情。根据受试者唯一数字对象标识和访视

点唯一数字对象标识，从队列信息系统获取与之匹配的实验室检查详情数据并返回。受试者唯一数字对

象标识从受试者列表接口的响应数据中取得，访视点唯一数字对象标识从业务阶段列表接口的响应数据

中取得。

c)请求方式：GET/POST。

d)请求参数：见表16。

表16实验室检查数据详情请求参数

序号参数名类型是否必填参数位置参数说明

请求头或请

1caseDOIString是受试者唯一数字对象标识

求体

请求头或请

2visitDOIString是访视点唯一数字对象标识

求体

e)响应参数：见表17。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode

参照表3。

表17实验室检查数据详情响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回消息

3dataObject返回数据

3.1labTestsDOIString实验室检查数字对象标识

3.2testsListArray检查列表

3.2.1testItemString检查项目

3.2.2resultString结果

1

T/CESAXXXX-2024

3.2.3unitString单位

3.2.4clinicalEvaluationNumber临床评价

3.2.5notesString备注

基础资料（人口学资料）

a)接口标识（cmd）：demographicData

b)说明：获取队列信息系统队列数据基础资料（人口学资料）的数据详情。根据受试者唯一数字

对象标识，从队列信息系统获取与之匹配的基础资料详情数据并返回。受试者唯一数字对象标识从受试

者列表接口的响应数据中取得

c)请求方式：GET/POST

d)请求参数：见表18。

表18人口学资料数据详情请求参数

序号参数名类型是否必填参数位置参数说明

请求头或请

1caseDOIString是受试者唯一数字对象标识

求体

响应参数：见表19。请求成功时，返回码rtnCode为“000000”；请求异常时，返回码rtnCode参照

表3。

表19人口学资料数据详情响应参数

序号参数名类型参数说明

1rtnCodeString返回码

2rtnMsgString返回消息

3dataObject返回数据

3.1demographicDataDOIString人口学资料数字对象标识

3.2sexString性别

3.3birthdayString出生日期

3.4marryString婚育状况

3.5nationString民族

3.6educationString教育程度

3.7addressString家庭住址

3.8careerString职业

13

T/CESAXXXX-2019

3.9birthPlaceString出生地方

3.10livingPlaceString生活地方

3.11smokeString吸烟

3.12drinkString饮酒

3.13selfTelephoneString患者联系电话

3.14otherTelephoneString患者家属联系电话

8数据安全

8.1部署方式

队列数据共享接口部署方式的要求主要包括：

a)宜使用HTTPS协议进行接口部署和使用，避免接口数据传输过程中发生泄漏。

b)在开放网络下，不应使用HTTP协议对队列数据共享接口进行部署和使用。

8.2请求方式

队列数据共享接口请求方式的要求主要包括：

a)宜使用POST请求方式，并将所有请求参数置于请求体中。

b)请求数据应按照队列信息系统安全等级要求进行处理（如数据加密等）。

c)在开放网络下，不应使用GET请求方式使用队列数据共享接口，避免数据发生泄露。

d)队列数据共享接口请求必须使用apikey访问授权，仅授权的apikey可正常使用队列数据共享接

口，完成数据交互。

8.3系统登录

系统登录接口的要求主要包括：

a)系统登录接口部署必须采用HTTPS协议。

b)系统登录接口应使用POST方式发送请求，用户名和密码均应置于请求体中。

c)接口开发应采用队列信息系统原本的加密方式，登录密码不应以明文形式传递。若队列信息系

统密码为明文传递，应按安全等级要求使用相应级别的加解密算法。

_________________________________

1

中国电子工业标准化技术协会

团体标准《智能医疗跨队列数据处理平台队列数据共享接

口模型》（征求意见稿）编制说明

一、工作简况

1、项目来源

数据开放共享是当前重要发展趋势之一，我国于2016年发布了《关于促进和

规范健康医疗大数据应用发展的指导意见》，提出要大力推动政府健康医疗信息

系统和公众健康医疗数据互联融合、开放共享，2023年发布了《数字中国建设整

体布局规划》，要求强化数字化能力建设，促进信息系统网络互联互通、数据按

需共享、业务高效协同。并且近年来，随着我国自然人群队列和各类专病队列建

设取得较大进展，为借助跨病种大数据分析技术阐释多种疾病的共性和特性，队

列间数据的共享融合交叉研究的需求凸显，然而不同队列数据之间的有效互通和

共享仍是有待解决的难题，因此，实现队列间数据的共享有着重要和必要的现实

意义。本标准旨在提供一套跨队列数据共享背景下，一套标准化的队列信息系统

数据共享接口描述，并定义语义明确的队列数据共享接口，能够方便队列数据接

口供需双方形成共同理解，高效完成队列数据共享服务接口的对接和使用，推动

数据要素在临床队列研究中的共享、流动与应用。

根据中国电子工业标准化技术协会《关于公布2024年第一批团体标准制修订

项目的通知》[中电标通〔2024〕001号]安排，《智能医疗跨队列数据处理平台

队列数据共享接口模型》（项目号：CESA-2024-011）团体标准获得立项，本标

准是新制定标准，项目周期13个月。本标准依托于科技部重点研发计划“大型队

列间联合研究柔性化大数据云平台支撑系统研发”，归口单位为中国电子工业标

准化技术协会，由北京大学发起和组织编制。

2、主要起草单位和主要起草人

本标准