Skip to content
Partner Developer Portal

How should I interpret is_national_data_opted_in?

In production, most patients are expected to be opted in for national data sharing. Studies are therefore typically not limited to a small subset of the population.

The is_national_data_opted_in field follows an explicit opt-out model.

ValueMeaningStudy guidance
truePatient is opted in to national data sharingInclude
falsePatient has explicitly opted out via National Data Opt-OutExclude
  • Only explicit opt-outs are flagged as false.
  • Most patients are not opted out nationally.
  • In production, NULL is not expected. As a defensive fallback, treat NULL as not opted in.

Include only explicit opt-ins:

WHERE COALESCE(is_national_data_opted_in, FALSE) = TRUE

This includes TRUE and excludes both FALSE and any unexpected NULL.