Reporting page (#73)

Co-authored-by: Frankie Roberto <[email protected]>

app/_includes/guide-contents.njk

@@ -27,6 +27,11 @@
       text: "Recording a vaccination",
       current: (page.url == "/recording-a-vaccination/")
     },
+    {
+      href: "/reporting/",
+      text: "Reporting",
+      current: (page.url == "/reporting/")
+    },
     {
       href: "/managing-users/",
       text: "Managing users",

app/managing-users.md

@@ -6,8 +6,8 @@ parent:
   title: How to use the pilot service
   url: /guide
 previous:
-  title: Recording a vaccination
-  url: /recording-a-vaccination
+  title: Reporting
+  url: /reporting
 next:
   title: Managing vaccines
   url: /managing-vaccines

app/recording-a-vaccination.md

@@ -9,8 +9,8 @@ previous:
   title: Finding a patient
   url: /finding-a-patient
 next:
-  title: Managing users
-  url: /managing-users
+  title: Reporting
+  url: /reporting
 ---
 
 {% include 'guide-contents.njk' %}
@@ -19,11 +19,11 @@ There are several steps to record a vaccination.
 
 ## Choosing a vaccine
 
-Select the vaccine and vaccine product you wish to give the patient. You’ll only see vaccine products with active batches. 
+Select the vaccine and vaccine product you wish to give the patient. You’ll only see vaccine products with active batches.
 
-### Selecting a delivery team 
+### Selecting a delivery team
 
-If your organisation has several sub-sites or teams, select a ‘Delivery team’ before you select the ‘Vaccine’ you wish to administer. This information will remain the same until you make new selections during your session or log out. 
+If your organisation has several sub-sites or teams, select a ‘Delivery team’ before you select the ‘Vaccine’ you wish to administer. This information will remain the same until you make new selections during your session or log out.
 
 RAVS will warn you if the patient’s details or vaccination history contain important information to consider.
 
@@ -35,77 +35,77 @@ Check if the patient is suitable for the vaccination before continuing to captur
 
 ### Screening questions
 
-We’ve provided COVID-19 screening questions to consider when assessing a patient. Recording this information is no longer necessary. Refer to your organisation’s standard operating procedures, if you’re screening patients for other vaccines. 
+We’ve provided COVID-19 screening questions to consider when assessing a patient. Recording this information is no longer necessary. Refer to your organisation’s standard operating procedures, if you’re screening patients for other vaccines.
 
 ### Selecting an assessing clinician
 
-Select a registered clinician that appears under ‘Assessing clinician’. The clinician will remain the same until you make new selections during your session or log out. 
+Select a registered clinician that appears under ‘Assessing clinician’. The clinician will remain the same until you make new selections during your session or log out.
 
 ### Selecting an assessment date
 
-Select an ‘Assessment date’ the patient is assessed. The date will remain the same until you make new selections during your session or log out. Select ‘Choose another date’ if the vaccination was in the past. 
+Select an ‘Assessment date’ the patient is assessed. The date will remain the same until you make new selections during your session or log out. Select ‘Choose another date’ if the vaccination was in the past.
 
-### Selecting an estimated due date (for maternity services) 
+### Selecting an estimated due date (for maternity services)
 
-The Pertussis or RSV vaccine should be given at a specific stage of the pregnancy. When vaccinating pregnant women for these vaccines, you must enter their estimated due date. RAVS will warn you if the date means it’s not clinically appropriate to vaccinate, but not stop you from continuing.   
+The Pertussis or RSV vaccine should be given at a specific stage of the pregnancy. When vaccinating pregnant women for these vaccines, you must enter their estimated due date. RAVS will warn you if the date means it’s not clinically appropriate to vaccinate, but not stop you from continuing.
 
 ### Exiting an assessment
 
-If you do not vaccinate the patient, select a ‘Vaccine not given’ reason before you save and exit the patient’s record. 
+If you do not vaccinate the patient, select a ‘Vaccine not given’ reason before you save and exit the patient’s record.
 
 ![Screen showing a user a button to save and exit a patient’s record when they have chosen not to give them a vaccine](/images/assess-the-patient.png)
 
 ## Recording consent
 
-Before vaccinating a patient, capture their consent or the details of the person consenting on their behalf. 
+Before vaccinating a patient, capture their consent or the details of the person consenting on their behalf.
 
 ### Selecting a consenting clinician
 
-Select a registered clinician that appears under ‘Consenting clinician’. The clinician will remain the same until you make new selections during your session or log out. 
+Select a registered clinician that appears under ‘Consenting clinician’. The clinician will remain the same until you make new selections during your session or log out.
 
 ### Exiting if consent is declined
 
-If consent is declined, select a ‘No consent reason’, before you save and exit a patient’s record. 
+If consent is declined, select a ‘No consent reason’, before you save and exit a patient’s record.
 
 ![Screen showing a user a button to save and exit a patient's record when the patient declines consent](/images/consent-not-given.png)
 
 ## Vaccinating a patient
 
-Enter the vaccination event details once you’ve given the patient a vaccine. 
+Enter the vaccination event details once you’ve given the patient a vaccine.
 
 ### Changing batches
 
-If you run out of a batch, you can switch the vaccine product at this point and search for an alternative batch to give to the patient. 
+If you run out of a batch, you can switch the vaccine product at this point and search for an alternative batch to give to the patient.
 
-Batches are assigned to a vaccine product and preadded to RAVS with an expiry date and dose volume. This means that when you select a batch, this information will prepopulate, saving you time. 
+Batches are assigned to a vaccine product and preadded to RAVS with an expiry date and dose volume. This means that when you select a batch, this information will prepopulate, saving you time.
 
 ![Screen showing the user selecting an alternative vaccine and batch](/images/vaccinate.png)
 
-### Selecting a vaccination date 
+### Selecting a vaccination date
 
-Select a ‘Vaccination date’. The date will remain the same until you make new selections during your session or log out.  
+Select a ‘Vaccination date’. The date will remain the same until you make new selections during your session or log out.
 
-Vaccination and assessment dates are likely to be on the same day. Make sure they match. 
+Vaccination and assessment dates are likely to be on the same day. Make sure they match.
 
-If you’re recording a vaccination that happened in the past, you can select a batch available at that time (even if they’re currently depleted or expired). 
+If you’re recording a vaccination that happened in the past, you can select a batch available at that time (even if they’re currently depleted or expired).
 
-### Selecting a vaccinator 
+### Selecting a vaccinator
 
-Select and record registered clinicians or non-registered staff that appear under ‘Vaccinator’. A vaccinator will remain the same until you make new selections during your session or log out. 
+Select and record registered clinicians or non-registered staff that appear under ‘Vaccinator’. A vaccinator will remain the same until you make new selections during your session or log out.
 
-### Selecting where the vaccination is taking place 
+### Selecting where the vaccination is taking place
 
-To support payments and reporting, you must select where or how the vaccination is taking place. Once you select an option, it will remain the same until you make new selections during your session or log out. 
+To support payments and reporting, you must select where or how the vaccination is taking place. Once you select an option, it will remain the same until you make new selections during your session or log out.
 
 ## Checking and confirming
 
-Before saving a patient’s vaccination record, you can edit it from the final ‘Check and confirm’ screen by selecting a link. The link will return you to the relevant screen to make the necessary changes.  
+Before saving a patient’s vaccination record, you can edit it from the final ‘Check and confirm’ screen by selecting a link. The link will return you to the relevant screen to make the necessary changes.
 
 ### What you can and cannot edit
 
 You can edit most information you have recorded, but there are exceptions:
 
-* you cannot edit a patient’s demographic details.  
-* editing information recorded on the assessment or consent screen changes the vaccination outcome. As a result, RAVS will remove the data you have entered on the vaccinate screen and ask you to reenter it. 
+* you cannot edit a patient’s demographic details.
+* editing information recorded on the assessment or consent screen changes the vaccination outcome. As a result, RAVS will remove the data you have entered on the vaccinate screen and ask you to reenter it.
 
 ![Screen showing the user a list of the vaccination details they have recorded and can and cannot edit before submitting](/images/check-and-confirm.png)

app/reporting.md

@@ -0,0 +1,66 @@
+---
+layout: page
+title: Reporting
+analytics_key: reporting
+parent:
+  title: How to use the pilot service
+  url: /guide
+previous:
+  title: Recording a vaccination
+  url: /recording-a-vaccination
+next:
+  title: Managing users
+  url: /managing-users
+---
+
+{% include 'guide-contents.njk' %}
+
+Only lead administrators and administrators can create reports.
+
+Vaccination data is available for extract as soon as it’s recorded and saved. You can extract data in a ‘.csv format’ (comma separated values) to support reporting within your organisation by choosing from a combination of:
+
+* dates (up to a maximum of 2 weeks)
+* vaccines
+* sites
+
+You aren’t restricted to how often or when you can create reports.
+
+## Choosing dates
+
+Select preset dates or a custom date range.
+
+The date range for custom reports is limited to 2 weeks. Dates must be in the past.
+
+**Note:** The maximum 2 week restriction is temporary, and we’re looking to remove this soon.
+
+![Screen showing a user selecting a custom date range](/images/report-dates.png)
+
+## Choosing vaccines
+
+To support the Autumn Winter campaign, RAVS will record the following 4 vaccines:
+
+* COVID-19
+* Flu
+* Pertussis
+* RSV
+
+Select the vaccines you wish to report on.
+
+![Screen showing a user selecting a vaccine](/images/report-vaccines.png)
+
+## Choosing sites
+
+Select the sites you wish to report on. You’ll only see sites added into RAVS with an ODS code.
+
+![Screen showing a user selecting a site](/images/report-sites.png)
+
+## Running your reports
+
+Depending on the volume of data you’ve selected, a screen may appear indicating that your report is being created.
+
+
+### Downloading your report
+
+When you download your report, it will appear in your browser downloads. Your browser should notify you when the extract is available.
+
+**Important:** Downloaded extracts hold personal data. Handle them in line with your organisation’s data management policies.