Is there a definitions schema or table that describes the Model

[kuhlaid]

I'm trying find definitions for fields such as conceptPrefix and measurePersonCompletenessThreshold from the table and field definitions outlined in https://github.com/OHDSI/CommonDataModel/blob/main/inst/csv/OMOP_CDMv5.4_Table_Level.csv and OMOP_CDMv5.4_Field_Level.csv. Is this documented somewhere because it would be nice to know the purpose of conceptPrefix, etc.?

[kuhlaid]

A JSON schema would be ideal. For example:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "OMOP CDM schema",
  "description": "This schema describes the OMOP Common Data Model definitions found in the `OMOP_CDMv5.4_Field_Level.csv` file for example.",
  "properties": {
    "cdmTableName": {
      "description": "The name of the CDM table.",
      "type": "string"
    },
    "schema": {
      "description": "Specifies the schema of the table (CDM, VOCAB, RESULTS).",
      "enum": ["CDM", "VOCAB", "RESULTS"], 
      "type": "string"
    },
    "isRequired": {
      "description": "Is the table required (Yes/No).",
      "enum": ["Yes", "No"], 
      "type": "string"
    }
...
}

[PouyanJay]

I would be interested in contributing this. My proposal is to add machine-readable JSON Schemas for the v5.4 table-level and field-level metadata files, including descriptions for fields such as conceptPrefix and measurePersonCompletenessThreshold, along with validation tests.

Would the maintainers prefer these schemas under inst/schema/, and is there a preferred JSON Schema draft/version?

[PouyanJay]

I've opened a PR implementing the schema proposal from this discussion. It adds draft-04 JSON Schemas for the v5.4 table-level and field-level metadata files, documents the CSV-to-JSON representation (literal NA stays "NA"), and includes optional validation tooling. Feedback especially welcome on the definitions of conceptPrefix, validation, and unique DQ identifiers, which I couldn't find a code consumer for, and on whether draft-04 is the right schema version.

Link to the PR: #794