Add Mavis national reporting user guide

app/_layouts/national-reporting.njk

@@ -0,0 +1,23 @@
+{% extends "layouts/base.njk" %}
+{% block header %}
+  {{ nhsukHeader(options.header | currentPage(page.url)) }}
+{% endblock %}
+{% block content %}
+  <div class="nhsuk-grid-row">
+    <div class="nhsuk-grid-column-one-quarter">
+      {{ appSubNavigation({
+        items: collections.navigation | eleventyNavigation(sectionKey or options.homeKey) | itemsFromNavigation(page.url, { pathPrefix: options.pathPrefix })
+      }) }}
+    </div>
+    <div class="nhsuk-grid-column-three-quarters">
+      {{ appDocumentHeader({
+        caption: caption,
+        title: title,
+        description: description
+      }) }}
+      {% call appProseScope() %}
+      {{ content }}
+      {% endcall %}
+    </div>
+  </div>
+{% endblock %}

app/index.njk

@@ -5,8 +5,8 @@ description: A guide on how to use Mavis.
 homepage: true
 ---
 
-<p class="nhsuk-body">Manage vaccinations in schools (Mavis) is a digital tool designed to help school age immunisation service (SAIS) teams manage their vaccination programmes end to end.</p>
-
+<p class="nhsuk-body">Manage vaccinations in schools (Mavis) is a digital tool designed to help school age immunisation
+  service (SAIS) teams manage their vaccination programmes end to end.</p>
 {% from "nhsuk/components/action-link/macro.njk" import actionLink %}
 <p class="nhsuk-body">
   {{ actionLink({
@@ -15,25 +15,23 @@ homepage: true
     href: "/guide/"
   }) }}
 </p>
-
 <p class="nhsuk-body">
   {{ actionLink({
     classes: "nhsuk-u-margin-0",
     text: "Email and text message templates",
     href: "/email-and-text-templates/"
   }) }}
 </p>
-
 <p class="nhsuk-body">
   {{ actionLink({
     classes: "nhsuk-u-margin-0",
     text: "File upload templates",
     href: "/file-upload-templates/"
   }) }}
 </p>
-
-<p class="nhsuk-body">To access the service, visit <a href="https://www.manage-vaccinations-in-schools.nhs.uk">www.manage-vaccinations-in-schools.nhs.uk</a>.</p>
-
+<p class="nhsuk-body">To access the service, visit
+  <a href="https://www.manage-vaccinations-in-schools.nhs.uk">www.manage-vaccinations-in-schools.nhs.uk</a>.</p>
 <hr class="nhsuk-section-break nhsuk-section-break--visible nhsuk-section-break--l">
-
-<p class="nhsuk-body">We want this guide to be as useful as possible. If you think anything could be improved, please send your suggestions to <a href="mailto:[email protected]">[email protected]</a>.</p>
+  <p class="nhsuk-body">We want this guide to be as useful as possible. If you think anything could be improved, please
+    send your suggestions to
+    <a href="mailto:[email protected]">[email protected]</a>.</p>

app/national-reporting-guide/accessing-mavis-national-reporting.md

@@ -0,0 +1,11 @@
+---
+title: Accessing Mavis national reporting
+theme: National reporting
+order: 3
+---
+
+Use your Care Identity (CIS2) credentials to log into [Mavis national reporting](https://www.manage-vaccinations-in-schools.nhs.uk/start).
+
+Once you’re signed in, you’ll be taken to the Mavis national reporting homepage.
+
+![Screenshot of Mavis national reporting homepage.](/assets/images/nr-dashboard.png)

app/national-reporting-guide/adding-removing-users.md

@@ -0,0 +1,43 @@
+---
+title: Adding and removing users
+theme: National reporting
+order: 2
+---
+
+> [!NOTE]
+> This section is for the Registration Authority only. If you are a Mavis national reporting user, you will be given the appropriate level of access.
+
+Before users can access Mavis for the first time, you need to give them an appropriate role and workgroup. You can do this using the [Care Identity Management](https://manage-care-identities.care-identity-service2.nhs.uk/) service.
+
+## Assigning a role
+
+Give all users the medical secretary access role (R8006).
+
+Users with this role can perform all actions in Mavis national reporting except superuser activities (see below).
+
+### Superuser activities (B0062 and B1611)
+
+- Local system administration (B0062) adds the ability to archive vaccination records.
+- Access sensitive (S) flagged records (B1611) adds the ability to view important notices about patients who have been flagged in the Personal Demographics Service (PDS).
+
+We recommend that there are at least 2 superusers with activity codes B0062 and B1611 per organisation.
+
+## Assigning users to a workgroup
+
+Each SAIS team using Mavis has a different workgroup name. Users need to be assigned to the appropriate workgroup.
+
+You may need to [add workgroups to your organisation](https://digital.nhs.uk/services/care-identity-service/applications-and-services/care-identity-management/user-guides/managing-workgroups/create-a-workgroup) before assigning individual users.
+
+If you create a new workgroup, you must inform Mavis by emailing <[email protected]>.
+
+## Removing users
+
+When staff leave your organisation or no longer need Mavis access, remove their access promptly through the Care Identity Management service:
+
+- end-date their Mavis role assignment (R8006)
+
+and/or
+
+- remove the SAIS team-specific workgroup from their CIS2 record
+
+This should be part of your standard leaver process for SAIS staff.

app/national-reporting-guide/archiving-vaccination-records.md

@@ -0,0 +1,24 @@
+---
+title: Archiving vaccination records
+theme: National reporting
+order: 7
+---
+
+> [!NOTE]
+> Only superusers can archive vaccination records. You can ask a superuser in your group to archive a record.
+
+You may need to remove a vaccination record by archiving it, for example, if a record appears twice due to a technical error or if historical vaccinations were matched incorrectly.
+
+If you archive a record, it will be deleted from the child’s GP’s records and from NHS England records.
+
+To archive a record:
+
+1. Find the vaccination record by searching for the child’s name or NHS number on the **Children** tab.
+2. Click on the child’s name.
+3. Select the vaccination you need to archive by clicking the date.
+4. Select **Archive vaccination record** at the bottom of the vaccination details card.
+5. Confirm by selecting **Yes, archive this vaccination record**.
+
+![Screenshot of archive vaccination record link.](/assets/images/nr-archive-record.png)
+
+![Screenshot of archive vaccination record confirmation.](/assets/images/nr-confirm-archive.png)

app/national-reporting-guide/checking-important-notices.md

@@ -0,0 +1,23 @@
+---
+title: Checking important notices
+theme: National reporting
+order: 6
+---
+
+> [!NOTE]
+> Only superusers can view important notices.
+
+You can see if there are any important notices that you need to be aware of on the Mavis national reporting dashboard.
+
+![Screenshot of Mavis national reporting dashboard showing important notice warning.](/assets/images/nr-important-notice-warning.png)
+
+Examples of important notices include:
+
+- records flagged as invalid if a child has 2 NHS numbers, for example, in cases of adoption
+- records flagged as sensitive
+
+Once you have seen and, if necessary, acted on an important notice, you can dismiss it.
+
+![Screenshot of important notices page showing dismiss link.](/assets/images/nr-important-notices.png)
+
+If you dismiss an important notice it will disappear from the **Import** page for all superusers in your team. It will still be visible on the child’s vaccination record.

app/national-reporting-guide/finding-and-editing-vaccination-records.md

@@ -0,0 +1,46 @@
+---
+title: Finding and editing vaccination records
+theme: National reporting
+order: 5
+---
+
+## Finding vaccination records
+
+To find a vaccination record that has already been imported:
+
+1. Select the **Children** tab or card.
+2. Search for a child’s record by entering their name or NHS number. You can also filter search results by year group or date of birth.
+3. Click on the child’s name to see their vaccination record.
+
+## Editing children’s details and vaccination records
+
+To edit a child’s details:
+
+1. Open the child’s record by clicking on their name.
+2. Select **Edit child record**.
+3. Make any changes by selecting **Change**.
+4. Select **Continue**.
+5. When you’ve made all necessary changes, select **Save changes**.
+
+![Screenshot of child record showing edit child record button.](/assets/images/nr-edit-child-record.png)
+
+To edit a vaccination record:
+
+1. Open the child’s record by clicking on their name.
+2. On the vaccinations card, click on the date of the vaccination record you need to edit. This displays the full vaccination record.
+3. Select **Edit vaccination record**.
+4. Make any changes by selecting **Change**.
+5. Select **Continue**.
+6. When you’ve made all necessary changes, select **Save changes**.
+
+![Screenshot of child record showing edit vaccination record button.](/assets/images/nr-edit-vaccs-record.png)
+
+You can only edit records uploaded by your SAIS team. You can view records uploaded by other teams – for example, if a child moved into your area – but you cannot edit these records.
+
+### Adding or changing NHS numbers
+
+Mavis will automatically replace any incorrect NHS numbers in your upload or add any missing ones found by searching the NHS Patient Demographics Service (PDS) (sometimes called ‘the Spine’) overnight.
+
+You can also manually add or change an NHS number by editing the child’s details - see ‘Editing children’s details and vaccination records’, above.
+
+If an NHS number is invalid, Mavis will not send that child’s vaccination record to NHS England. A superuser can identify invalid NHS numbers through important notices.

app/national-reporting-guide/index.md

@@ -0,0 +1,14 @@
+---
+title: "Mavis national reporting: user guide"
+order: 1
+eleventyNavigation:
+  parent: Home
+  key: National reporting user guide
+---
+
+Mavis national reporting was developed by an NHS England team working closely with SAIS staff to make it as effective as possible.
+
+Using the national reporting service you can:
+
+- upload and import vaccination records to be automatically shared with NHS England
+- find children, view and edit their uploaded vaccination records

app/national-reporting-guide/national-reporting-guide.json

@@ -0,0 +1,9 @@
+{
+  "layout": "national-reporting",
+  "collection": "national-reporting-guide",
+  "sectionKey": "National reporting user guide",
+  "showPagination": true,
+  "eleventyNavigation": {
+    "parent": "National reporting user guide"
+  }
+}

app/national-reporting-guide/uploading-vaccination-records.md

@@ -0,0 +1,47 @@
+---
+title: Uploading vaccination records
+theme: National reporting
+order: 4
+---
+
+From the homepage, select **Imports**.
+
+![Screenshot of Imports page showing Upload records button, incomplete uploads and completed imports.](/assets/images/nr-imports.png)
+
+## Preparing files to upload
+
+Files must be in CSV format. If you have an Excel file with multiple tabs, you’ll need to consolidate this into a single tab before saving it as a CSV file, or create a separate CSV file for each tab.
+
+Any file that’s compatible with NIVS specifications will also be compatible with national reporting specifications.
+
+For more detailed information about the columns that must be included in the CSV file, select **How to format your CSV file for vaccination records** on the Upload vaccination records page (see Uploading a file, below).
+
+> [!NOTE]
+> Large cohort files can fail to upload, due to their size. If your CSV file has over 10,000 rows, we recommend you split it into smaller files - for example 2 files with 5,000 rows.
+
+## Uploading a file
+
+1. On the **Imports** page, select **Upload records**.
+2. Select **Choose file**, then select the CSV file you want to import.
+3. Select **Continue**.
+4. You can see the file’s status on the **Incompleted imports** list.
+
+You may need to refresh the page to see the latest status.
+
+## Unsuccessful upload
+
+If there are any validation issues, Mavis will not import the file. It will stay on the **Incomplete imports** list with its status marked as invalid.
+
+1. Click on your file upload’s date and time stamp to view the validation issues.
+2. Return to your CSV file and correct the issues listed.
+3. Save the changes and upload the file again.
+
+![Screenshot of an import with errors.](/assets/images/nr-import-errors.png)
+
+## Successful upload
+
+If the file was imported successfully it will no longer be visible on the **Incomplete imports** list. It will now be on the **Completed imports** list.
+
+You can find it by selecting the **Completed imports** tab.
+
+Mavis will automatically send imported vaccination records to NHS England.

eleventy.config.js

@@ -53,6 +53,13 @@ export default function (eleventyConfig) {
         return a.data.order - b.data.order
       })
   })
+  eleventyConfig.addCollection('national-reporting-guide', (collection) => {
+    return collection
+      .getFilteredByGlob('app/national-reporting-guide/*.md')
+      .sort((a, b) => {
+        return a.data.order - b.data.order
+      })
+  })
 
   // Passthrough
   eleventyConfig.addPassthroughCopy('app/assets/images')