Skip to content

Commit 5643572

Browse files
committed
Run just generate-docs
1 parent 5b243e7 commit 5643572

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
<h4 class="attr-heading" id="claim_permissions" data-toc-label="claim_permissions" markdown>
3+
<tt><strong>claim_permissions</strong>(<em>*permissions</em>)</tt>
4+
</h4>
5+
<div markdown="block" class="indent">
6+
Some tables and features in ehrQL can only be accessed with specific permission set
7+
by the OpenSAFELY team. These restrictions are only enforced when working with real
8+
data, however to avoid confusion we also check them when working with dummy data.
9+
10+
When using dummy data you can grant yourself any permission using the
11+
`claim_permissions()` function. For example:
12+
13+
from ehrql import claim_permissions
14+
15+
claim_permissions("some_permission", "another_permission")
16+
17+
This can go anywhere in your dataset or measure definition file.
18+
19+
This will allow you to develop your ehrQL code locally. But please **note that you
20+
will only be able to run against real data if you have had the necessary permissions
21+
granted by the OpenSAFELY team**.
22+
</div>

docs/includes/generated_docs/schemas/raw.tpp.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,10 @@ Date on which the current dataset was imported.
475475
<p class="dimension-indicator"><code>many rows per patient</code></p>
476476
## isaric
477477

478+
!!! warning "Access to this table requires the `isaric` permission"
479+
480+
Helpful text goes here.
481+
478482
ISARIC is a dataset of COVID-19-related hospital admissions,
479483
with coverage across the majority of hospitals across the UK,
480484
including much richer clinical information
@@ -1465,6 +1469,10 @@ Medical condition mentioned on the death certificate.
14651469

14661470
National Waiting List Clock Stops
14671471

1472+
!!! warning "Access to this table requires the `waiting_list` permission"
1473+
1474+
Helpful text goes here.
1475+
14681476
The columns in this table have the same data types as the columns in [the associated
14691477
database table][wl_clockstops_raw_1]. The three "pseudo" columns are small
14701478
exceptions, as they are converted from binary columns to string columns.
@@ -1614,6 +1622,10 @@ exceptions, as they are converted from binary columns to string columns.
16141622

16151623
National Waiting List Open Pathways
16161624

1625+
!!! warning "Access to this table requires the `waiting_list` permission"
1626+
1627+
Helpful text goes here.
1628+
16171629
The columns in this table have the same data types as the columns in [the associated
16181630
database table][wl_openpathways_raw_1]. The three "pseudo" columns are small
16191631
exceptions, as they are converted from binary columns to string columns.

docs/includes/generated_docs/schemas/tpp.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,10 @@ The date of discharge from a hospital provider spell.
701701

702702
Appointments in primary care.
703703

704+
!!! warning "Access to this table requires the `appointments` permission"
705+
706+
Helpful text goes here.
707+
704708
!!! warning
705709
In TPP this data comes from the "Appointment" table. This table has not yet been
706710
well characterised, so there are some issues around how to interpret findings
@@ -2691,6 +2695,10 @@ The date the referral request was received by the health care provider.
26912695

26922696
This table contains responses to questions from the OpenPROMPT project.
26932697

2698+
!!! warning "Access to this table requires the `open_prompt` permission"
2699+
2700+
Helpful text goes here.
2701+
26942702
You can find out more about this table in the associated short data report. To view
26952703
it, you will need a login for [Level 4][open_prompt_1]. The
26962704
[workspace][open_prompt_2] shows when the code that comprises the report was run;
@@ -3348,6 +3356,10 @@ used to do so.
33483356
<p class="dimension-indicator"><code>many rows per patient</code></p>
33493357
## ukrr
33503358

3359+
!!! warning "Access to this table requires the `ukrr` permission"
3360+
3361+
Helpful text goes here.
3362+
33513363
The UK Renal Registry (UKRR) contains data on patients under secondary renal care
33523364
(advanced chronic kidney disease stages 4 and 5, dialysis, and kidney transplantation)
33533365
<div markdown="block" class="definition-list-wrapper">
@@ -3525,6 +3537,10 @@ Vaccine's product name.
35253537

35263538
Waiting List Minimum Data Set Clock Stops
35273539

3540+
!!! warning "Access to this table requires the `waiting_list` permission"
3541+
3542+
Helpful text goes here.
3543+
35283544
These data are from the patient-level [Waiting List Minimum Data Set (WLMDS)](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/wlmds/),
35293545
which are reported separately from the aggregate [Referral to Treatment (RTT) data](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/).
35303546

@@ -3710,6 +3726,10 @@ The Sunday of the week that the pathway relates to
37103726

37113727
Waiting List Minimum Data Set Open Pathways
37123728

3729+
!!! warning "Access to this table requires the `waiting_list` permission"
3730+
3731+
Helpful text goes here.
3732+
37133733
These data are from the patient-level [Waiting List Minimum Data Set (WLMDS)](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/wlmds/),
37143734
which are reported separately from the aggregate [Referral to Treatment (RTT) data](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/).
37153735

0 commit comments

Comments
 (0)