Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nhsdigital/qof

Repository for code relating to the Quality and Outcomes Framework publication
https://github.com/nhsdigital/qof

nhs-digital-gpes nhs-digital-publication nhs-digital-qof

Last synced: 29 days ago
JSON representation

Repository for code relating to the Quality and Outcomes Framework publication

Awesome Lists containing this project

README

        

> Warning: This is the README for the publically accessible version of the QOF package. If you are an internal analyst please don't use the below instructions to run the publication process.

 

# QOF

## Contact Information

Repository owner: GP Data, Extracts, Specifications and Analysis (GPDESA)

Email: [email protected]

To contact us raise an issue on Github or via email and we will respond promptly.

 

## Publication Summary

The objective of the Quality and Outcomes Framework (QOF) is to improve the care patients are given by rewarding practices for the quality of care they provide to their patients, based on several indicators across a range of key areas of clinical care and public health. The publication provides data for the reporting year 1 April 2023 to 31 March 2024 and covers all General Practices in England that participated in QOF in 2023-24.

The publications can be found here:

https://digital.nhs.uk/data-and-information/publications/statistical/quality-and-outcomes-framework-achievement-prevalence-and-exceptions-data

 

## Repository Summary

> Whilst this repository is the publically accessible version, the main aim of this repository is to inform users how the publication outputs and indicators within the publication were produced and is unlikely to benefit users with regards to running and producing the publication outputs due to the specific nature of the input data required.

 

## Set up

1. Make a [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) of the repository on your local machine.
2. Update config.json accordingly.
3. Create the file structure within your machine as per the diagram below
4. Move files from public_metadata folder into their respective folders and populate accordingly
5. Run QOF_23_24.ipynb.
> If you are running for publication you will need to amend the code so that test_run = False is unhashed

 

## Creating a file structure

```
root
|
|---LIVE
| |
| |---PROCESS 1
| | |
| | |---INPUTS
| | | |
| | | |---CONTROL_FILES
| | | | |
| | | | |---CONTROL_FILE.csv
| | | | |---INDICATOR_GROUP_CHANGE_MESSAGE.csv
| | | | |---INDICATOR_REFERENCE_CONTROL.csv
| | | | |---PCA_REFERENCE.csv
| | | | |---VALIDATION_RULES.csv
| | | | |
| | | |---CQRS_DATA
| | | | |---FINAL_PRACTICE_LIST.csv
| | | | |---INDICATOR_ACHEIVED_POINTS.csv
| | | | |---INDICATOR_VALUES.csv
| | | | |
| | | |---GEOG_MAPPINGS
| | | | |---QOF_MANUAL_MAPPINGS.csv
| | | | |
| | | |---PREVIOUS_YEAR
| | | | |
| | | | |---PREVIOUS_ACHIEVEMENTS_PCAS.csv
| | | | |---PREVIOUS_INDICATOR_CONTROL.csv
| | | | |---PREVIOUS_INDICATOR_MAPPINGS.csv
| | | | |---PREVIOUS_ORGANISATION_REFERENCE.csv
| | | | |---PREVIOUS_PREVALENCE.csv
| | | | |---PREVIOUS_PREVALENCE_NON_REGISTER_ALT_INDICATORS.csv
| | | | |---PREVIOUS_PREVALENCE_NON_REGISTER_INDICATORS.csv
| | | | |
| | | |---Templates
| | | | |
| | | | |---TEMPLATE-(3-9)-QOF-YYYY...xlsx
| | | | |
| | | | |---Practices
| | | | |
| | | | | |---TEMPLATE-(10-19)-QOF-YYYY-prac...xlsx
| | |
| | |---OUTPUTS
| | | |
| | | |---DO NOT PUBLISH
|
|---CHECKING
```
> Please note that for test runs all outputs will be located within the test folder which is automatically created in your working directory

 

## Instructions for publication production (internal analysts)
Read the guidance https://nhsd-confluence.digital.nhs.uk/display/KH/Quality+and+Outcomes+Framework+%28QOF%29+data+download+and+publication+guidance.

## QOF Acronym dictonary
- ach = achievement
- adj = adjusted
- cols = columns
- dedup = deduplicate (i.e. duplicates removed)
- dup = duplicate
- denom = denominator
- dom = domain
- geog = geography or geographies
- gr = group
- ind = indicator
- list = list
- max = maximum
- min = minimum
- num = numerator
- org = organisation
- ov = over
- piv = pivot
- prac = practice
- ref = reference
- reg = register
- subdom = sub domain
- sup = suppressed
- un = under

## Licence
QOF codebase is released under the MIT License.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.