Skip to main content
  1. How/
  2. Getting started with the Open Syndrome Definition 📄/

Open Syndrome Definition Schema

PropertyTypeTitle/Description
+ titlestringTitle of the case definition.
- descriptionstringDetailed description of a case definition.
+ scopeenum (of string)A broad definition aims to capture most or all true cases, while a specific definition provides a more accurate description but risks missing some true cases.
+ categoryenum (of string)Case definition categories according to Bassil, K. (2008). Case definition. In Encyclopedia of epidemiology (Vol. 2, pp. 133-134). SAGE Publications, Inc., https://doi.org/10.4135/9781412953948
+ versionstringCase definition version to be defined by the author but following the Semantic Versioning Specification (https://semver.org/).
+ open_syndrome_versionstringOpen Syndrome Definition schema version.
+ published_instringURL where the narrative format definition was originally published or can be found.
+ published_atstringDate and time of publication at Open Syndrome Initiative website (UTC).
- published_byarray of stringList of the case definition publishers in the Open Syndrome Initiative.
+ locationstringFree text for location input; recommended format is ‘City, State/Region, Country’ following geographical hierarchy with comma separation
+ languagestringWritten language
+ organizationstringThe organization responsible for this case definition maintenance.
- authorsarray of stringPeople or organizations that authored this case definition.
+ inclusion_criteriaarray-
- exclusion_criteriaarray-
- notesarray of stringAny notes that may be relevant to this case definition.
+ referencesarray of objectReferences which have supported this definition followed by a URL.
+ statusenum (of string)Current status of this definition in the Open Syndrome Initiative platform.
- keywordsarray of stringKeywords related to a definition.
- human_readable_definitionstringA human-readable definition of the case definition, which can be used for display purposes in user interfaces.
- target_public_health_threatsarray of stringList of public health threats that this case definition targets.

Title #

Typestring
RequiredYes

Description: Title of the case definition.

Description #

Typestring
RequiredNo

Description: Detailed description of a case definition.

Category #

Typeenum (of string)
RequiredYes

Description: A broad definition aims to capture most or all true cases, while a specific definition provides a more accurate description but risks missing some true cases.

Must be one of:

  • “specific”
  • “broad”

Scope #

Typeenum (of string)
RequiredYes
Default"suspected"

Description: Case definition categories according to Bassil, K. (2008). Case definition. In Encyclopedia of epidemiology (Vol. 2, pp. 133-134). SAGE Publications, Inc., https://doi.org/10.4135/9781412953948

Must be one of:

  • “confirmed”
  • “probable”
  • “suspected”

Version #

Typestring
RequiredYes

Description: Case definition version to be defined by the author but following the Semantic Versioning Specification (https://semver.org/).

Restrictions
Must match regular expression^\d+\.\d+\.\d+$ Test

Open Syndrome Definition version #

Typestring
RequiredYes

Description: Open Syndrome Definition schema version.

Example:

"1.0.0"
Restrictions
Must match regular expression^\d+\.\d+\.\d+$ Test

Published in #

Typestring
RequiredYes
Formaturi

Description: URL where the narrative format definition was originally published or can be found.

Published at #

Typestring
RequiredYes
Formatdate-time

Description: Date and time of publication at Open Syndrome Initiative website (UTC).

Example:

"2020-05-30T12:00:00Z"

Published by #

Typearray of string
RequiredNo

Description: List of the case definition publishers in the Open Syndrome Initiative.

Examples:

[
    "Ana Maria Braga"
]
[
    "Oswaldo Gonçalves Cruz",
    "Bento Gonçalves Cruz",
    "Amália Taborda de Bulhões Cruz"
]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
published_by items-

Location #

Typestring
RequiredYes

Description: Free text for location input; recommended format is ‘City, State/Region, Country’ following geographical hierarchy with comma separation

Examples:

"Salvador, Bahia, Brasil"
"Berlin, Germany"
"Nigeria"

Language #

Typestring
RequiredYes

Description: Written language

Examples:

"English"
"Brazilian Portuguese"

Organization #

Typestring
RequiredYes

Description: The organization responsible for this case definition maintenance.

Examples:

"Ministry of Health"
"The Epidemic Intelligence from Open Sources Initiative"

Authors #

Typearray of string
RequiredNo

Description: People or organizations that authored this case definition.

Examples:

[
    "Ana Maria Braga"
]
[
    "Oswaldo Gonçalves Cruz",
    "Bento Gonçalves Cruz",
    "Amália Taborda de Bulhões Cruz"
]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
authors items-

Inclusion Criteria #

Typearray
RequiredYes
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
criterion-

Criterion #

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/criterion
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ typeNoenum (of string)No-Type of criterion.

- criteria: Group of criteria or conditions.
- syndrome: Syndrome (defined by another definition, but used here as a criterion).
- symptom: just a symptom.
- diagnosis: The diagnosed disease, which may or may not be followed by a code, e.g. ICD.
- diagnostic_test: Tests or medical examinations to confirm a diagnosis, e.g. gluplasma glucose.
- professional_judgment: Professional assessment.
- epidemiological_history: Travel history or contact with someone with an epidemiological link.
- demographic_criteria: Factors such as age or sex.
- logical_operatorNoenum (of string)No-Keywords that represent a logical operation on criteria.

AND: All conditions in this group must be satisfied (true).
OR: At least one condition in this group must be satisfied.
AND_NOT: All conditions in this group must not be satisfied (must be false).
AT_LEAST: Used with the number specified in `logical_operator_arguments`. At least that many conditions must be true.
- logical_operator_argumentsNoarray of integerNo-Used with `logical_operator = AT_LEAST`. At least that many conditions must be true.
- nameNostringNo-Criterion label.
- attributeNostringNo-The referred attribute.
- valueNoobjectNo-The reference value for the referred attribute. It has no type because it could be anything.
- descriptionNostringNo-A detailed description of the criterion.
- operatorNoenum (of string)No-Comparison operators.

>: Value must be greater than the specified threshold.
>=: Value must be greater than or equal to the specified threshold.
<: Value must be less than the specified threshold.
<=: Value must be less than or equal to the specified threshold.
==: Value must exactly match the specified value.
!=: Value must not match the specified value.
regex: Value must match the specified regular expression pattern.
- regex_patternNostringNo-Regular expression for evaluation and pattern matching.
- regex_flagsNostringNo-Regular expression flags for extra configuration.
- codeNoobjectNo-System agnostic diagnosis code.
- valuesNoarrayNo--
Any of(Option)
item 0
item 1

#

Typeobject
RequiredNo
Additional propertiesAny type allowed
14.1.1.1. The following properties are required #
  • name

#

Typeobject
RequiredNo
Additional propertiesAny type allowed
14.1.2.1. The following properties are required #
  • values

#

Typeenum (of string)
RequiredYes

Description: Type of criterion.

  • criteria: Group of criteria or conditions.
  • syndrome: Syndrome (defined by another definition, but used here as a criterion).
  • symptom: just a symptom.
  • diagnosis: The diagnosed disease, which may or may not be followed by a code, e.g. ICD.
  • diagnostic_test: Tests or medical examinations to confirm a diagnosis, e.g. gluplasma glucose.
  • professional_judgment: Professional assessment.
  • epidemiological_history: Travel history or contact with someone with an epidemiological link.
  • demographic_criteria: Factors such as age or sex.

Must be one of:

  • “criterion”
  • “syndrome”
  • “symptom”
  • “diagnosis”
  • “diagnostic_test”
  • “professional_judgment”
  • “epidemiological_history”
  • “demographic_criteria”

Logical operator #

Typeenum (of string)
RequiredNo

Description: Keywords that represent a logical operation on criteria.

AND: All conditions in this group must be satisfied (true). OR: At least one condition in this group must be satisfied. AND_NOT: All conditions in this group must not be satisfied (must be false). AT_LEAST: Used with the number specified in logical_operator_arguments. At least that many conditions must be true.

Must be one of:

  • “AND”
  • “OR”
  • “AND_NOT”
  • “AT_LEAST”

Logical operator arguments #

Typearray of integer
RequiredNo

Description: Used with logical_operator = AT_LEAST. At least that many conditions must be true.

Array restrictions
Min items1
Max items1
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
logical_operator_arguments items-

Name #

Typestring
RequiredNo

Description: Criterion label.

Value #

Typestring
RequiredNo

Description: The referred attribute.

Examples:

"body_temperature"
"age"
"onset"

#

Typeobject
RequiredNo
Additional propertiesAny type allowed

Description: The reference value for the referred attribute. It has no type because it could be anything.

Examples:

true
37.5
"abnormal but non-specific bowel gas pattern"

#

Typestring
RequiredNo

Description: A detailed description of the criterion.

#

Typeenum (of string)
RequiredNo

Description: Comparison operators.

: Value must be greater than the specified threshold. =: Value must be greater than or equal to the specified threshold. <: Value must be less than the specified threshold. <=: Value must be less than or equal to the specified threshold. ==: Value must exactly match the specified value. !=: Value must not match the specified value. regex: Value must match the specified regular expression pattern.

Must be one of:

  • “>”
  • “>=”
  • “<”
  • “<=”
  • “==”
  • “!=”
  • “regex”

Regular expression #

Typestring
RequiredNo

Description: Regular expression for evaluation and pattern matching.

Example:

"deng[u]?e"

Regular expression flags #

Typestring
RequiredNo

Description: Regular expression flags for extra configuration.

Example:

"i"
Restrictions
Must match regular expression^[gimsuy]*$ Test

System agnostic diagnosis #

Typeobject
RequiredNo
Additional propertiesAny type allowed

Description: System agnostic diagnosis code.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ systemNostringNo-The diagnosis system used.
+ codeNostringNo--
- displayNostringNo-A label that represents this code.
#
Typestring
RequiredYes

Description: The diagnosis system used.

Examples:

"ICD-10"
"SNOMED-CT"
#
Typestring
RequiredYes

Examples:

"J11"
"A.99"
"233604007"
#
Typestring
RequiredNo

Description: A label that represents this code.

Examples:

"Pneumonia"
"Dengue"

#

Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
criterion-
14.1.14.1. Open Syndrome Case Definition Schema > inclusion_criteria > inclusion_criteria items > values > criterion #
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition asinclusion_criteria_items

#

Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
criterion-

Exclusion criteria #

Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition asinclusion_criteria_items

#

Typearray of string
RequiredNo

Description: Any notes that may be relevant to this case definition.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
notes items-

Notes #

Typestring
RequiredNo

Note item #

Typearray of object
RequiredYes

Description: References which have supported this definition followed by a URL.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
references items-

References #

Typeobject
RequiredNo
Additional propertiesAny type allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- citationNostringNo--
+ urlNostringNo--

Status #

Typeenum (of string)
RequiredYes
Default"draft"

Description: Current status of this definition in the Open Syndrome Initiative platform.

Must be one of:

  • “draft”
  • “published”
  • “deprecated”

Keywords #

Typearray of string
RequiredNo

Description: Keywords related to a definition.

Examples:

"outbreaks"
"covid19"
"WHO"
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
keywords items-

Human-readable definition #

Typestring
RequiredNo

Description: A human-readable definition of the case definition, which can be used for display purposes in user interfaces.

Public-health threats #

Typearray of string
RequiredNo

Description: List of public health threats that this case definition targets.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
target_public_health_threats items-

Examples:

"COVID-19"
"Influenza"
"Extreme Weather Events"