Run just generate-docs

Author: evansd

docs/includes/generated_docs/language__permissions.md

@@ -0,0 +1,20 @@
+
+<h4 class="attr-heading" id="claim_permissions" data-toc-label="claim_permissions" markdown>
+  <tt><strong>claim_permissions</strong>(<em>*permissions</em>)</tt>
+</h4>
+<div markdown="block" class="indent">
+This function allows you to access any restricted table or feature when working with
+dummy data. It will NOT allow you access with real data: for that you will need the
+appropriate permissions on the OpenSAFELY platform.
+
+Permission names are strings and should be written with double quotes e.g.
+
+    from ehrql import claim_permissions
+
+    claim_permissions("some_permission", "another_permission")
+
+This can go anywhere in your dataset or measure definition file.
+
+You can make multiple `claim_permissions()` calls and the permissions will be
+combined together.
+</div>

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

@@ -475,6 +475,12 @@ Date on which the current dataset was imported.
 <p class="dimension-indicator"><code>many rows per patient</code></p>
 ## isaric
 
+!!! warning "Access to this table requires the `isaric` permission"
+
+    Access to ISARIC data is usually agreed at the project application stage.  If
+    you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 ISARIC is a dataset of COVID-19-related hospital admissions,
 with coverage across the majority of hospitals across the UK,
 including much richer clinical information
@@ -1465,6 +1471,12 @@ Medical condition mentioned on the death certificate.
 
 National Waiting List Clock Stops
 
+!!! warning "Access to this table requires the `waiting_list` permission"
+
+    Access to Waiting List data is usually agreed at the project application stage.
+    If you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 The columns in this table have the same data types as the columns in [the associated
 database table][wl_clockstops_raw_1]. The three "pseudo" columns are small
 exceptions, as they are converted from binary columns to string columns.
@@ -1614,6 +1626,12 @@ exceptions, as they are converted from binary columns to string columns.
 
 National Waiting List Open Pathways
 
+!!! warning "Access to this table requires the `waiting_list` permission"
+
+    Access to Waiting List data is usually agreed at the project application stage.
+    If you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 The columns in this table have the same data types as the columns in [the associated
 database table][wl_openpathways_raw_1]. The three "pseudo" columns are small
 exceptions, as they are converted from binary columns to string columns.

docs/includes/generated_docs/schemas/tpp.md

@@ -701,7 +701,8 @@ The date of discharge from a hospital provider spell.
 
 Appointments in primary care.
 
-!!! warning
+!!! warning "Access to this table requires the `appointments` permission"
+
     In TPP this data comes from the "Appointment" table. This table has not yet been
     well characterised, so there are some issues around how to interpret findings
     from it. The data contains records created when an appointment is made with a GP
@@ -710,8 +711,8 @@ Appointments in primary care.
     There are also duplicate events in the table that we need to better understand.
 
     As a consequence, if you try to use the appointment table, you will see warnings
-    when running your code locally, and failures when the GitHub action tests your
-    code. If you need access to the appointments data, please speak to your
+    when running your code locally, and failures if you try to run against real
+    data. If you need access to the appointments data, please speak to your
     OpenSAFELY co-pilot. We will be considering projects on a case by case basis
     until it can enter the normal stable pool of data.
 
@@ -2692,6 +2693,12 @@ The date the referral request was received by the health care provider.
 
 This table contains responses to questions from the OpenPROMPT project.
 
+!!! warning "Access to this table requires the `open_prompt` permission"
+
+    Access to OpenPROMPT data is usually agreed at the project application stage. If
+    you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 You can find out more about this table in the associated short data report. To view
 it, you will need a login for [Level 4][open_prompt_1]. The
 [workspace][open_prompt_2] shows when the code that comprises the report was run;
@@ -3342,6 +3349,12 @@ used to do so.
 <p class="dimension-indicator"><code>many rows per patient</code></p>
 ## ukrr
 
+!!! warning "Access to this table requires the `ukrr` permission"
+
+    Access to UK Renal Registry data is usually agreed at the project application
+    stage. If you're unsure as to whether you do or should have access please speak
+    to your co-pilot or to OpenSAFELY support.
+
 The UK Renal Registry (UKRR) contains data on patients under secondary renal care
 (advanced chronic kidney disease stages 4 and 5, dialysis, and kidney transplantation)
 <div markdown="block" class="definition-list-wrapper">
@@ -3527,6 +3540,12 @@ Vaccine's product name.
 
 Waiting List Minimum Data Set Clock Stops
 
+!!! warning "Access to this table requires the `waiting_list` permission"
+
+    Access to Waiting List data is usually agreed at the project application stage.
+    If you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 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/),
 which are reported separately from the aggregate [Referral to Treatment (RTT) data](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/).
 
@@ -3712,6 +3731,12 @@ The Sunday of the week that the pathway relates to
 
 Waiting List Minimum Data Set Open Pathways
 
+!!! warning "Access to this table requires the `waiting_list` permission"
+
+    Access to Waiting List data is usually agreed at the project application stage.
+    If you're unsure as to whether you do or should have access please speak to your
+    co-pilot or to OpenSAFELY support.
+
 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/),
 which are reported separately from the aggregate [Referral to Treatment (RTT) data](https://www.england.nhs.uk/statistics/statistical-work-areas/rtt-waiting-times/).