OHDSI / OHDSI/CommonDataModel

'Required' terminology

Open
#757 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
HTML
Stars
1.1k
Forks
508
Avg merge
1h 30m
Merged PRs (30d)
3

Description

In the OMOP CDM documentation for each of the columns it is stated if the column is required or not. Required meaning if it can be left missing or it must be populated.

Image

At the beginning of the documentation it is stated: Similarly, fields that are not required should exist in the CDM table but do not need to be populated.

Although I acknowledge it is stated in the documentation, maybe the word is not the best wording as I've found at least 3 OMOP CDM instances of independent groups that seemed to have misunderstood "required" as if the column must exist. And then they didn't create the columns that have required = No.

Do you think we could find a better word or add a disclaimer in every table (e.g required* and then in the foot note: the column must always exists but if not required it can be left as NULL)? Just to prevent other users to do the same mistake.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the OMOP CDM documentation's introductory definition of “Required” and review the column descriptions and tables that use this terminology. Identify how the wording or a disclaimer can consistently state that every column should exist while non-required columns may be NULL; done means the distinction is clear throughout the affected documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.