HLSCohort 定义

本文详细介绍了 HLSCohort 项的定义结构。

注释

HLSCohort 也称为医疗保健队列(预览版)。

定义部件

下表列出了 HLSCohort 定义部分。

定义部件路径 类型 必选 DESCRIPTION
healthcarecohort.metadata.json HLSCohortDetails (JSON) 描述队列的元数据。
.platform PlatformDetails (JSON) 描述项的常见详细信息。

HLSCohortDetails

描述队列的元数据。

名称 类型 DESCRIPTION
依赖关系 HLSCohortDependency[] 相关项的列表。
queryRequest CohortDetails 定义队列的一组条件。

HLSCohortDependency

与 HLSCohort 项相关的项。

名称 类型 DESCRIPTION
项目类型 字符串 相关项的类型。
itemObjectId 字符串 相关项的 itemId。
folderObjectId 字符串 相关项的 workspaceId。

CohortDetails

队列的详细信息和查询请求的格式。

名称 类型 DESCRIPTION
schemaName 字符串 架构的名称。
schemaVersion 字符串 架构的版本。
entryPoint 字符串 架构的入口点。
criteriaExpressionNodes CriteriaExpressionNode[] 条件表达式节点。

CriteriaExpressionNode

条件表达式树中的节点。

名称 类型 DESCRIPTION
nodeType NodeType 条件表达式节点的类型。
criteriaCondition CriteriaCondition 条件条件。
孩子们 CriteriaExpressionNode[] 条件表达式节点的子级。

NodeType (枚举)

条件表达式节点的类型,包括逻辑运算符和条件(叶)节点。

名称 DESCRIPTION
“逻辑与”运算符。
“逻辑或”运算符。
UnitAnd 同一行数据的条件之间的逻辑 AND。
逻辑 NOT 运算符。
叶节点。

CriteriaCondition

条件表达式中的条件。

名称 类型 DESCRIPTION
propertyPath 字符串 条件条件的属性路径。
rawValueSchemaDataType ValueType 原始值的架构数据类型。
rawValue 字符串 条件条件的原始值。
criteriaOperator CriteriaOperator 条件运算符。
isValueList 布尔型 该值是否为列表。

ValueType (枚举)

此条件条件的原始值的数据类型。

名称 DESCRIPTION
字符串 字符串数据类型。
加倍 双精度数据类型。
整数 整数数据类型。
漂浮 Float 数据类型。
长整型 长数据类型。
日期 日期数据类型。
DateTime DateTime 数据类型。
概念 概念数据类型。

CriteriaOperator (枚举)

要用于条件条件的运算符。

名称 DESCRIPTION
平等 相等运算符。
GreaterThan 大于运算符。
GreaterThanOrEqual 大于或等于运算符。
LessThan 小于运算符。
LessThanOrEqual 小于或等于运算符。
ContainedIn 包含在运算符中。

HLSCohortDetails 示例

{
  "dependencies": [
    {
      "itemType": "HealthDataManager",
      "itemObjectId": "00000000-0000-0000-0000-000000000000",
      "folderObjectId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "queryRequest": {
    "schemaName": "OMOP",
    "schemaVersion": "0.0.0",
    "entryPoint": "Person",
    "criteriaExpressionNodes": [
      {
        "nodeType": "And",
        "children": [
          {
            "nodeType": "Leaf",
            "criteriaCondition": {
              "propertyPath": "Person.YearOfBirth",
              "rawValueSchemaDataType": "Integer",
              "rawValue": "2000",
              "criteriaOperator": "Equal",
              "isValueList": false
            }
          }
        ]
      }
    ]
  }
}