HLSCohort definition

Article
2025-04-30

This article provides a breakdown of the definition structure for HLSCohort items.

Note

HLSCohort is also known as Healthcare Cohort (preview).

Definition parts

This table lists the HLSCohort definition parts.

Definition part path	type	Required	Description
`healthcarecohort.metadata.json`	HLSCohortDetails (JSON)	true	Describes the metadata of the cohort.
`.platform`	PlatformDetails (JSON)	false	Describes common details of the item.

HLSCohortDetails

Describes the metadata of the cohort.

Name	Type	Description
dependencies	HLSCohortDependency[]	A list of the related items.
queryRequest	CohortDetails	A set of conditions which define the cohort.

HLSCohortDependency

A related item to the HLSCohort item.

Name	Type	Description
itemType	String	The type of the related item.
itemObjectId	String	The itemId of the related item.
folderObjectId	String	The workspaceId of the related item.

CohortDetails

The details of the cohort and the format of the query request.

Name	Type	Description
schemaName	String	The name of the schema.
schemaVersion	String	The version of the schema.
entryPoint	String	The entrypoint of the schema.
criteriaExpressionNodes	CriteriaExpressionNode[]	The criteria expression nodes.

CriteriaExpressionNode

A node in the criteria expression tree.

Name	Type	Description
nodeType	NodeType	The type of the criteria expression node.
criteriaCondition	CriteriaCondition	The criteria condition.
children	CriteriaExpressionNode[]	The children of the criteria expression node.

NodeType (Enum)

The type of the criteria expression node including logical operators and condition (leaf) nodes.

Name	Description
And	Logical AND operator.
Or	Logical OR operator.
UnitAnd	Logical AND between conditions on the same row of data.
Not	Logical NOT operator.
Leaf	Leaf node.

CriteriaCondition

A condition in the criteria expression.

Name	Type	Description
propertyPath	String	The property path of the criteria condition.
rawValueSchemaDataType	ValueType	The schema data type of the raw value.
rawValue	String	The raw value of the criteria condition.
criteriaOperator	CriteriaOperator	The criteria operator.
isValueList	Boolean	Whether the value is a list or not.

ValueType (Enum)

The data type of the raw value of this criteria condition.

Name	Description
String	String data type.
Double	Double data type.
Integer	Integer data type.
Float	Float data type.
Long	Long data type.
Date	Date data type.
DateTime	DateTime data type.
Concept	Concept data type.

CriteriaOperator (Enum)

The operator to be used in the criteria condition.

Name	Description
Equal	Equal operator.
GreaterThan	Greater than operator.
GreaterThanOrEqual	Greater than or equal to operator.
LessThan	Less than operator.
LessThanOrEqual	Less than or equal to operator.
ContainedIn	Contained in operator.

HLSCohortDetails example

{
  "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
            }
          }
        ]
      }
    ]
  }
}

Share via