opensafely / opensafely/documentation

Explain non-COVID restrictions in Data Sources docs

Open
#1,851 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

The Data Sources docs include warnings like this to explain that some datasets need additional approval to access:

Image

The non-COVID directions mean that more datasets will require additional permissions, so we should update the docs to match. They should be consistent with the restrictions added to ehrQL, and should include the ID of the permission that needs to be granted (e.g. waiting_list).

Contributor guide

Open the contributing guide

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 Data Sources docs at https://docs.opensafely.org/data-sources/ and compare their non-COVID access directions with the restrictions described in ehrQL issue #2560. Identify each affected dataset and the permission ID it requires, such as waiting_list; the work is done when the documentation consistently explains these restrictions and names the required permissions.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.