atlas-preview.ohdsi.org

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "logicType": {
      "type": "string",
      "enum": [
        "ALL",
        "ANY",
        "AT_LEAST",
        "AT_MOST"
      ]
    },
    "count": {
      "type": "number",
      "description": "Required for AT_LEAST and AT_MOST"
    },
    "temporalWindow": {
      "type": "object",
      "description": "Optional temporal window for the criteria, relative to the index (cohort entry) start date.",
      "properties": {
        "startDays": {
          "type": [
            "number",
            "null"
          ],
          "description": "Window start in days vs index start: negative = before index, 0 = at index, null = all time prior."
        },
        "endDays": {
          "type": [
            "number",
            "null"
          ],
          "description": "Window end in days vs index start: positive = after index, null = all time after. Default 0 (index date)."
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "conceptId": {
            "type": "number",
            "description": "OMOP concept ID"
          },
          "conceptName": {
            "type": "string",
            "description": "Human-readable concept name"
          },
          "domain": {
            "type": "string",
            "enum": [
              "Condition",
              "Drug",
              "Procedure",
              "Measurement",
              "Observation",
              "Visit",
              "Device",
              "Specimen"
            ],
            "description": "OMOP domain"
          },
          "group": {
            "type": "string",
            "enum": [
              "inclusion",
              "exclusion"
            ]
          },
          "includeDescendants": {
            "type": "boolean"
          },
          "operator": {
            "type": "string",
            "enum": [
              "gt",
              "gte",
              "lt",
              "lte",
              "eq",
              "between"
            ],
            "description": "Measurement value operator (only for Measurement domain)"
          },
          "value": {
            "type": "number",
            "description": "Threshold value (only for Measurement domain)"
          },
          "value2": {
            "type": "number",
            "description": "Upper bound for between operator"
          }
        },
        "required": [
          "conceptId",
          "conceptName",
          "domain",
          "group",
          "includeDescendants"
        ]
      }
    }
  },
  "required": [
    "name",
    "logicType",
    "events"
  ]
}