The documentation below sets out the available API end-points for retrieving CVDPREVENT data, as presented in the Data & Improvement Tool. If you have any suggestions for improvement, please complete the feedback form.
The API and documentation are subject to change.
The NHS Digital pipeline used to build a new data asset to link and curate the CVDPREVENT audit data, to existing administrative data tables, can be found at this GitHub repository.
Copyright
Cardiovascular Disease Prevention Audit (CVDPREVENT). Produced by Office for Health Improvement and Disparities and the NHS Benchmarking Network.
© Copyright NHS England 2021 - 2023. All rights reserved.
Base URL:
Key terms:
See below terms used in CVDPrevent API to describe key concepts.
Term | Description | Example |
|---|---|---|
System Level | Grouping of Areas into comparable levels | England, Region, ICB, sub-ICB |
Area | Geographical locality for which data was recorded | Bedfordshire, Luton and Milton Keynes ICB |
Time Period | Time span in which data was recorded | To June 2024 |
Indicator | High-level performance measure | CVDP001AF is short reference for “Prevalence of GP recorded atrial fibrillation” indicator |
Metric | Category break-down of Indicator | CVDP001AF – Male, Aged 18-39 |
Contents:
Time Period
/timePeriod
Returns all available time periods.
Query parameters:
indicatorTypeID - Indicator type ID, e.g. standard or outcome indicator type. If passed will show time periods containing data of the given type (optional)
{
"timePeriodList": [
{
"EndDate": "Tue, 31 Mar 2020 00:00:00 GMT",
"StartDate": "Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020"
},
{
"EndDate": "Sat, 31 Dec 2022 00:00:00 GMT",
"StartDate": "Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID": 9,
"TimePeriodName": "To December 2022"
},
...
]
}
*Proposed* /timePeriod/systemLevels
Returns all available time periods, with an array of the system levels included in the given time period.
Note: Inverse of “/area/systemLevel/timePeriods“
{
"timePeriodList": [
{
"EndDate": "Tue, 31 Mar 2020 00:00:00 GMT",
"StartDate": "Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020",
"SystemLevels": [
{
"SystemLevelID": 1,
"SystemLevelName": "England",
"IsVisible": "Y",
"NationalLevel": "Y"
},
{
"SystemLevelID": 2,
"SystemLevelName": "STP",
"IsVisible": "Y",
"NationalLevel": "N"
},
...
}
]
},
...
]
}
Area
/area/systemLevel
Returns all available system levels for a specified time period.
Query parameters:
timePeriodID - ID of time period for which to return system levels for. Available system levels in given time period are controlled by SystemLevelTimePeriod table (compulsory)
{
"systemLevels": [
{
"IsVisible": "Y",
"NationalLevel": "Y",
"SystemLevelID": 1,
"SystemLevelName": "England",
"SystemLevelOrder": 1
},
{
"IsVisible": "Y",
"NationalLevel": "N",
"SystemLevelID": 2,
"SystemLevelName": "STP",
"SystemLevelOrder": 2
}
]
}
*Proposed*/area/systemLevel/timePeriods
Returns all available system levels, with an array of the time periods where the system levels occur.
Note: Inverse of “/timePeriod/systemLevels”
{
"systemLevels": [
{
"IsVisible": "Y",
"NationalLevel": "Y",
"SystemLevelID": 1,
"SystemLevelName": "England",
"SystemLevelOrder": 1
},
{
"IsVisible": "Y",
"NationalLevel": "N",
"SystemLevelID": 2,
"SystemLevelName": "STP",
"SystemLevelOrder": 2
}
]
}
/area
Returns all areas for a given time period and parent area or system level. Only areas which have data for specified time period will be returned.
Either parent area or system level must be specified. If parent area is specified, all children areas of that parent will be returned. If system level is specified, all areas within that system level will be returned. Parent area takes precedence over system level - if parent area is specified, system level is ignored.
Query parameters:
timePeriodID - specifies time period for which to return areas for (compulsory)
parentAreaID - specified the area of which children will be returned (optional)
systemLevelID - specifies which system levels to return areas for (optional)
{
"areaList": [
{
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Parents": [],
"ParticipationRate": 79.4,
"PopulationRate": 81.3,
"SystemLevelID": 1,
"SystemLevelName": "England"
}
]
}
/area/<area_id>/details
Returns details of a specific area at a given time period.
Query parameters:
timePeriodID - specified time period for which to return details for, i.e. population and participation rate (compulsory)
{
"areaDetails": {
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"ChildAreaList": [
{
"AreaCode": "E54000022",
"AreaID": 40,
"AreaName": "Norfolk and Waveney Health and Care Partnership",
"SystemLevelID": 2,
"SystemLevelName": "STP"
},
{
"AreaCode": "E54000053",
"AreaID": 20,
"AreaName": "Sussex and East Surrey Health and Care Partnership",
"SystemLevelID": 2,
"SystemLevelName": "STP"
}
],
"ParentAreaList": [],
"ParticipationRate": 79.4,
"PopulationRate": 81.3,
"SystemLevelID": 1,
"SystemLevelName": "England"
}
}
/area/unassigned
Returns a list of all areas which have data in selected time period, but do not have any parent areas assigned, and therefore are unreachable.
Query parameters:
timePeriodID - time period for which Area must have data for (compulsory)
systemLevelID - system level of areas in the unassigned list (optional)
{
"unassignedAreaList": [
{
"AreaCode": "L82021",
"AreaID": 4978,
"AreaName": "Alverton Practice",
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
{
"AreaCode": "Y00260",
"AreaID": 6546,
"AreaName": "Arlesey Medical Centre",
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
{
"AreaCode": "J82220",
"AreaID": 4575,
"AreaName": "Beggarwood Surgery - Nhuc",
"SystemLevelID": 5,
"SystemLevelName": "Practice"
}
]
}
/area/search
Returns a list of Areas that match a partial name for a given time period. Uses simple LIKE ‘%<partial_area_name>%’ comparison.
Query parameters:
partialAreaName - string to use to search for an Area (compulsory)
timePeriodID - limits the search to Areas which have data in specified time period (compulsory)
{
"foundAreaList": [
{
"AreaCode": "P86619",
"AreaID": 6388,
"AreaName": "Dr Mb Ghafoor & Partners",
"IsVisible": "N",
"NationalLevel": "N",
"SystemLevelID": 5,
"SystemLevelName": "Practice",
"SystemLevelOrder": 5
},
{
"AreaCode": "B86011",
"AreaID": 1991,
"AreaName": "Hillfoot Surgery",
"IsVisible": "N",
"NationalLevel": "N",
"SystemLevelID": 5,
"SystemLevelName": "Practice",
"SystemLevelOrder": 5
},
{
"AreaCode": "P81132",
"AreaID": 6155,
"AreaName": "Waterfoot Medical Practice",
"IsVisible": "N",
"NationalLevel": "N",
"SystemLevelID": 5,
"SystemLevelName": "Practice",
"SystemLevelOrder": 5
}
]
}
/area/<area_id>/nestedSubSystems
Returns given area and children areas in a nested structure.
No query parameters.
{
"AreaRelationships": {
"AreaCode": "E38000197",
"AreaID": 79,
"AreaName": "NHS West Essex CCG",
"Children": [
{
"AreaCode": "U34072",
"AreaID": 609,
"AreaName": "Harlow North PCN",
"Children": [
{
"AreaCode": "F81056",
"AreaID": 3338,
"AreaName": "Jenner House Old Harlow",
"Children": [],
"ParentAreaID": 609,
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
{
"AreaCode": "F81078",
"AreaID": 3349,
"AreaName": "Church Langley Medical Practice",
"Children": [],
"ParentAreaID": 609,
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
...
],
"ParentAreaID": 79,
"SystemLevelID": 4,
"SystemLevelName": "PCN"
},
{
"AreaCode": "U16446",
"AreaID": 639,
"AreaName": "North Uttlesford PCN",
"Children": [
{
"AreaCode": "F81009",
"AreaID": 3305,
"AreaName": "The Gold Street Surgery",
"Children": [],
"ParentAreaID": 639,
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
...
],
"ParentAreaID": 79,
"SystemLevelID": 4,
"SystemLevelName": "PCN"
},
...
],
"ParentAreaID": NaN,
"SystemLevelID": 3,
"SystemLevelName": "CCG"
}
}
/area/<area_id>/flatSubSystems
Similar to /area/<area_id>/nestedSubSystems, but the sub-areas are grouped based on their system level.
No query parameters.
{
"AreaRelationships": {
"AreaCode": "E38000197",
"AreaID": 79,
"AreaName": "NHS West Essex CCG",
"ParentAreaID": NaN,
"SubSystems": {
"PCN": [
{
"AreaCode": "U34072",
"AreaID": 609,
"AreaName": "Harlow North PCN",
"ParentAreaID": 79,
"SystemLevelID": 4,
"SystemLevelName": "PCN"
},
{
"AreaCode": "U16446",
"AreaID": 639,
"AreaName": "North Uttlesford PCN",
"ParentAreaID": 79,
"SystemLevelID": 4,
"SystemLevelName": "PCN"
},
...
],
"Practice": [
{
"AreaCode": "F81056",
"AreaID": 3338,
"AreaName": "Jenner House Old Harlow",
"ParentAreaID": 609,
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
{
"AreaCode": "F81078",
"AreaID": 3349,
"AreaName": "Church Langley Medical Practice",
"ParentAreaID": 609,
"SystemLevelID": 5,
"SystemLevelName": "Practice"
},
...
]
},
"SystemLevelID": 3,
"SystemLevelName": "CCG"
}
}
Indicators
An Indicator represents Cardiovascular Disease health indicators as defined by NHS England. An example of an Indicator is CVDP001AF, “Prevalence of GP recorded atrial fibrillation in patients aged 18 and over”. Indicators have unique Indicator IDs. Each Indicators is further broken down into Metrics.
A Metric represents a further breakdown of an Indicator by Inequality Marker. An example of an Inequality Marker is “Age Group - Male, 40-59”. Metrics have unique Metric IDs, with each Metric ID representing a combination of Indicator and Metric Category.
A Metric Category describes the inequality markers which the Metric applies to. Each Metric Category has a unique ID, for each combination of Name and Metric Category Type.
Each Metric Category belongs to a Metric Category Type, which groups the Metric Categories into one entity. Each Metric Category Type has a unique ID.
For example, “Male - 40-59” is a Metric Category in the “Age Group” Metric Category Type. Age Group will also contain Metric Categories “18-39”, “40-59”, “60-79”, “80+”. Assigning Metrics Categories to Metric Category Type allows comparison of all metrics in one inequality marker (in this case Age Group), or displaying Metric Categories in same Metric Category Type alongside each other.
/indicator/list
Example: /indicator/list?timePeriodID=1&systemLevelID=2
Returns basic details of all indicators for a given system level and time period. Only returns indicators for which data exists in selected time period, and on selected system level. Used to populate available indicator list in Data Explorer.
Query parameters:
timePeriodID - time period to return data for (compulsory)
systemLevelID - system level to return data for (compulsory)
{
"indicatorList": [
{
"AxisCharacter": "%",
"DataUpdateInterval": null,
"FormatDisplayName": "Proportion %",
"IndicatorCode": "CVDP002AF",
"IndicatorFormatID": 1,
"IndicatorID": 7,
"IndicatorName": "The percentage of patients aged 18 and over with GP recorded atrial fibrillation and a record of a CHA2DS2-VASc score of 2 or more who are currently treated with anticoagulation drug therapy",
"IndicatorOrder": 9,
"IndicatorShortName": "CVD Prevalence",
"IndicatorStatus": null
},
...
]
}
*Proposed*/indicator/metricList
Example: /indicator/metricList?timePeriodID=1&systemLevelID=2
Returns same data as “/indicator/list“, but adds a “MetricList“ array for each indicator, containing details of the relevant metrics.. Only returns indicators for which data exists in selected time period, and on selected system level.
Query parameters:
timePeriodID - time period to return data for (compulsory)
systemLevelID - system level to return data for (compulsory)
{
"indicatorList": [
{
"AxisCharacter": "%",
"DataUpdateInterval": null,
"FormatDisplayName": "Proportion %",
"IndicatorCode": "CVDP002AF",
"IndicatorFormatID": 1,
"IndicatorID": 7,
"IndicatorName": "The percentage of patients aged 18 and over with GP recorded atrial fibrillation and a record of a CHA2DS2-VASc score of 2 or more who are currently treated with anticoagulation drug therapy",
"IndicatorOrder": 9,
"IndicatorShortName": "CVD Prevalence",
"IndicatorStatus": null,
"MetricList": [
{
"CategoryAttribute": "Male",
"MetricCategoryName": "Male",
"MetricCategoryTypeName": "Sex",
"MetricID": 124
},
...
]
},
...
]
}
/indicator
Example: /indicator?timePeriodID=1&areaID=3&tagID=12&tagID=34
Returns all indicators and data for given time period and area. Also returns time series data for all time periods available. If tags are specified, only indicators which have one of the specified tags will be returned.
Query parameters:
timePeriodID - time period to return data for (compulsory)
areaID - area to return data for (compulsory)
tagID - allows filtering indicators by one or more tags (optional, array)
{
"indicatorList":[
{
"AxisCharacter":"%",
"Categories":[
{
"CategoryAttribute":"Persons",
"Data":{
"AreaID":97,
"Count":105.0,
"DataID":28489,
"Denominator":204430.0,
"Factor":1.0,
"LowerConfidenceLimit":2.6,
"Max":4.2,
"Median":2.6,
"Min":1.1,
"Numerator":5415.0,
"Q20":1.1,
"Q40":2.2,
"Q60":2.7,
"Q80":3.0,
"TimePeriodID":1,
"UpperConfidenceLimit":2.7,
"Value":2.6,
"ValueNote":""
},
"MetricCategoryID":30,
"MetricCategoryName":"Persons",
"MetricCategoryOrder":1,
"MetricCategoryTypeName":"Sex",
"MetricID":190,
"TimeSeries":[
{
"EndDate":"Tue, 31 Mar 2020 00:00:00 GMT",
"Median":2.6,
"StartDate":"Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID":1,
"TimePeriodName":"To March 2020",
"Value":2.6
}
]
},
{
"CategoryAttribute":"Male",
"Data":{
"AreaID":97,
"Count":105.0,
"DataID":26956,
"Denominator":101470.0,
"Factor":1.0,
"LowerConfidenceLimit":3.0,
"Max":4.8,
"Median":3.1,
"Min":1.2,
"Numerator":3130.0,
"Q20":1.2,
"Q40":2.6,
"Q60":3.1,
"Q80":3.5,
"TimePeriodID":1,
"UpperConfidenceLimit":3.2,
"Value":3.1,
"ValueNote":""
},
"ExternalCategoryID":29,
"MetricCategoryID":29,
"MetricCategoryName":"Male",
"MetricCategoryOrder":2,
"MetricCategoryTypeName":"Sex",
"MetricID":172,
"TimeSeries":[
{
"EndDate":"Tue, 31 Mar 2020 00:00:00 GMT",
"Median":3.1,
"StartDate":"Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID":1,
"TimePeriodName":"To March 2020",
"Value":3.1
}
]
},
{
"CategoryAttribute":"Female",
"Data":{
"AreaID":97,
"Count":105.0,
"DataID":26949,
"Denominator":102960.0,
"Factor":1.0,
"LowerConfidenceLimit":2.1,
"Max":3.7,
"Median":2.2,
"Min":1.0,
"Numerator":2285.0,
"Q20":1.0,
"Q40":1.9,
"Q60":2.2,
"Q80":2.5,
"TimePeriodID":1,
"UpperConfidenceLimit":2.3,
"Value":2.2,
"ValueNote":""
},
"ExternalCategoryID":28,
"MetricCategoryID":28,
"MetricCategoryName":"Female",
"MetricCategoryOrder":3,
"MetricCategoryTypeName":"Sex",
"MetricID":171,
"TimeSeries":[
{
"EndDate":"Tue, 31 Mar 2020 00:00:00 GMT",
"Median":2.2,
"StartDate":"Mon, 01 Jan 1900 00:00:00 GMT",
"TimePeriodID":1,
"TimePeriodName":"To March 2020",
"Value":2.2
}
]
}
],
"DataUpdateInterval": null,
"FormatDisplayName":"Proportion %",
"IndicatorCode":"CVDP001AF",
"IndicatorFormatID":1,
"IndicatorID":1,
"IndicatorName":"Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over",
"IndicatorOrder":1,
"IndicatorShortName": "AF: prevalence",
"IndicatorStatus": null
}
]
}
/indicator/tags
Returns a list of all available tags, which can be used to filter indicators.
Query parameter:
None
{
"indicatorTagList": [
{
"IndicatorTagID": 1,
"IndicatorTagName": "Anticogulation drug therapy"
},
{
"IndicatorTagID": 2,
"IndicatorTagName": "Atrial Fibrillation"
},
{
"IndicatorTagID": 3,
"IndicatorTagName": "Blood pressure measures"
}
]
}
/indicator/<indicator_ID>/details
Returns details of a single indicator
Query parameters:
None
For age standardised indicators, there are two sets of Metadata for each Section - one for standard data, and one for age standardised data respectively. “AgeStandardised” attribute distinguishes between the two sets of MetaData.
{
"indicatorDetails": {
"DataUpdateInterval": null,
"IndicatorCode": "CVDP001AF",
"IndicatorID": 1,
"IndicatorName": "Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over",
"IndicatorOrder": 1,
"IndicatorShortName": "AF: prevalence",
"IndicatorStatus": null,
"MetaData": {
"Section 1: Indicator Overview & Rationale": [
{
"AgeStandardised": "Y",
"CategoryName": "Section 1: Indicator Overview & Rationale",
"MetaData": "Prevalence of GP recorded atrial fibrillation",
"MetaDataCategoryID": 1,
"MetaDataTitle": "Indicator title"
},
{
"CategoryName": "Section 1: Indicator Overview & Rationale",
"MetaData": "Prevalence of GP recorded atrial fibrillation in patients aged 18 and over",
"MetaDataCategoryID": 1,
"MetaDataTitle": "Definition"
}
]
}
}
}
/indicator/siblingData
Returns all sibling areas and their data for specified time period, area and metric. This endpoint is intended to only return data for selected metric, and not all metrics for a chosen indicator, hence the metricID query parameter.
Query parameters:
timePeriodID - time period for which to return data (compulsory)
areaID - area for which all sibling data will be returned (compulsory)
metricID - metric for which to return data (compulsory)
{
"siblingData": {
"CategoryAttribute": "Female",
"Data": [
{
"AreaCode": "E54000029",
"AreaID": 30,
"AreaName": "East London Health and Care Partnership",
"Count": 42.0,
"DataID": 4812,
"Denominator": 77090.0,
"Factor": 1.0,
"LowerConfidenceLimit": 73.3,
"Max": 73.6,
"Median": 68.8,
"Min": 64.0,
"Numerator": 56745.0,
"Q20": 64.0,
"Q40": 67.2,
"Q60": 68.9,
"Q80": 69.9,
"SystemLevelID": 2,
"SystemLevelName": "STP",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020",
"UpperConfidenceLimit": 73.9,
"Value": 73.6,
"ValueNote": ""
},
{
"AreaCode": "E54000050",
"AreaID": 38,
"AreaName": "Cumbria and North East",
"Count": 42.0,
"DataID": 4821,
"Denominator": 150670.0,
"Factor": 1.0,
"LowerConfidenceLimit": 71.2,
"Max": 73.6,
"Median": 68.8,
"Min": 64.0,
"Numerator": 107555.0,
"Q20": 64.0,
"Q40": 67.2,
"Q60": 68.9,
"Q80": 69.9,
"SystemLevelID": 2,
"SystemLevelName": "STP",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020",
"UpperConfidenceLimit": 71.6,
"Value": 71.4,
"ValueNote": ""
}
],
"IndicatorCode": "CVDP002HYP",
"IndicatorID": 2,
"IndicatorName": "The percentage of patients aged 18 to 79 years with GP recorded hypertension, in whom the last blood pressure reading within the preceding 12 months is equal to 140/90 mmHg or less",
"IndicatorOrder": 5,
"IndicatorShortName": "AF: prevalence",
"MetricCategoryID": 28,
"MetricCategoryName": "Female",
"MetricCategoryOrder": 3,
"MetricCategoryTypeName": "Sex"
}
}
/indicator/childData
Returns all children areas and their data for specified time period, area and metric. This endpoint is intended to only return data for selected metric, and not all metrics for indicators, hence the metricID query parameter.
Query parameters:
timePeriodID - time period for which to return data (compulsory)
areaID - area for which all children data will be returned (compulsory)
metricID - metric for which to return data (compulsory)
{
"childData": {
"CategoryAttribute": "Female",
"Data": [
{
"AreaCode": "E38000257",
"AreaID": 74,
"AreaName": "NHS Shropshire, Telford and Wrekin CCG",
"Count": 105.0,
"DataID": 5896,
"Denominator": 20615.0,
"Factor": 1.0,
"LowerConfidenceLimit": 65.4,
"Max": 75.5,
"Median": 69.0,
"Min": 61.6,
"Numerator": 13625.0,
"Q20": 61.6,
"Q40": 67.1,
"Q60": 69.1,
"Q80": 71.0,
"SystemLevelID": 3,
"SystemLevelName": "CCG",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020",
"UpperConfidenceLimit": 66.7,
"Value": 66.1,
"ValueNote": ""
}
],
"IndicatorCode": "CVDP002HYP",
"IndicatorID": 2,
"IndicatorName": "The percentage of patients aged 18 to 79 years with GP recorded hypertension, in whom the last blood pressure reading within the preceding 12 months is equal to 140/90 mmHg or less",
"IndicatorOrder": 5,
"IndicatorShortName": "AF: prevalence",
"MetricCategoryID": 28,
"MetricCategoryName": "Female",
"MetricCategoryOrder": 3,
"MetricCategoryTypeName": "Sex"
}
}
/indicator/<indicator_id>/data
Returns all metric data for a specified indicator. Data will include values for both selected area, and organisation at National Level (usually England).
Query parameters:
timePeriodID - time period for which to return data for (compulsory)
areaID - area for which to return data for (compulsory)
{
"indicatorData": {
"AxisCharacter": "%",
"Categories": [
{
"AreaData": {
"AreaCode": "E54000011",
"AreaID": 2,
"AreaName": "Shropshire and Telford and Wrekin",
"Count": 42.0,
"DataID": 5164,
"Denominator": 43950.0,
"Factor": 1.0,
"LowerConfidenceLimit": 63.6,
"Max": 71.5,
"Median": 67.3,
"Min": 62.1,
"Numerator": 28155.0,
"Q20": 62.1,
"Q40": 66.3,
"Q60": 67.4,
"Q80": 68.1,
"TimePeriodID": 1,
"UpperConfidenceLimit": 64.5,
"Value": 64.1,
"ValueNote": ""
},
"CategoryAttribute": "Persons",
"ExternalCategoryID": 30,
"MetricCategoryID": 30,
"MetricCategoryName": "Persons",
"MetricCategoryOrder": 1,
"MetricCategoryTypeName": "Sex",
"NationalData": {
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Count": null,
"DataID": 4748,
"Denominator": 5068900.0,
"Factor": 1.0,
"LowerConfidenceLimit": 67.5,
"Max": null,
"Median": null,
"Min": null,
"Numerator": 3422314.0,
"Q20": null,
"Q40": null,
"Q60": null,
"Q80": null,
"TimePeriodID": 1,
"UpperConfidenceLimit": 67.6,
"Value": 67.5,
"ValueNote": ""
}
},
{
"AreaData": {
"AreaCode": "E54000011",
"AreaID": 2,
"AreaName": "Shropshire and Telford and Wrekin",
"Count": 42.0,
"DataID": 4749,
"Denominator": 23330.0,
"Factor": 1.0,
"LowerConfidenceLimit": 61.7,
"Max": 69.7,
"Median": 65.85,
"Min": 60.4,
"Numerator": 14535.0,
"Q20": 60.4,
"Q40": 65.2,
"Q60": 65.9,
"Q80": 66.9,
"TimePeriodID": 1,
"UpperConfidenceLimit": 62.9,
"Value": 62.3,
"ValueNote": ""
},
"CategoryAttribute": "Male",
"ExternalCategoryID": 29,
"MetricCategoryID": 29,
"MetricCategoryName": "Male",
"MetricCategoryOrder": 2,
"MetricCategoryTypeName": "Sex",
"NationalData": {
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Count": null,
"DataID": 4725,
"Denominator": 2662000.0,
"Factor": 1.0,
"LowerConfidenceLimit": 66.2,
"Max": null,
"Median": null,
"Min": null,
"Numerator": 1762593.0,
"Q20": null,
"Q40": null,
"Q60": null,
"Q80": null,
"TimePeriodID": 1,
"UpperConfidenceLimit": 66.3,
"Value": 66.2,
"ValueNote": ""
}
}
],
"FormatDisplayName": "Proportion %",
"IndicatorCode": "CVDP002HYP",
"IndicatorFormatID": 1,
"IndicatorID": 2,
"IndicatorName": "The percentage of patients aged 18 to 79 years with GP recorded hypertension, in whom the last blood pressure reading within the preceding 12 months is equal to 140/90 mmHg or less",
"IndicatorOrder": 5,
"IndicatorShortName": "AF: prevalence",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020"
}
}
*Proposed*/indicator/metric/<metric_id>/data
Returns all metric data for a specified metric. Data will include values for both selected area, and organisation at National Level (usually England).
Query parameters:
timePeriodID - time period for which to return data for (compulsory)
areaID - area for which to return data for (compulsory)
{
"indicatorData": {
"AxisCharacter": "%",
"Categories": [
{
"AreaData": {
"AreaCode": "E54000011",
"AreaID": 2,
"AreaName": "Shropshire and Telford and Wrekin",
"Count": 42.0,
"DataID": 5164,
"Denominator": 43950.0,
"Factor": 1.0,
"LowerConfidenceLimit": 63.6,
"Max": 71.5,
"Median": 67.3,
"Min": 62.1,
"Numerator": 28155.0,
"Q20": 62.1,
"Q40": 66.3,
"Q60": 67.4,
"Q80": 68.1,
"TimePeriodID": 1,
"UpperConfidenceLimit": 64.5,
"Value": 64.1,
"ValueNote": ""
},
"CategoryAttribute": "Persons",
"ExternalCategoryID": 30,
"MetricCategoryID": 30,
"MetricCategoryName": "Persons",
"MetricCategoryOrder": 1,
"MetricCategoryTypeName": "Sex",
"NationalData": {
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Count": null,
"DataID": 4748,
"Denominator": 5068900.0,
"Factor": 1.0,
"LowerConfidenceLimit": 67.5,
"Max": null,
"Median": null,
"Min": null,
"Numerator": 3422314.0,
"Q20": null,
"Q40": null,
"Q60": null,
"Q80": null,
"TimePeriodID": 1,
"UpperConfidenceLimit": 67.6,
"Value": 67.5,
"ValueNote": ""
}
},
{
"AreaData": {
"AreaCode": "E54000011",
"AreaID": 2,
"AreaName": "Shropshire and Telford and Wrekin",
"Count": 42.0,
"DataID": 4749,
"Denominator": 23330.0,
"Factor": 1.0,
"LowerConfidenceLimit": 61.7,
"Max": 69.7,
"Median": 65.85,
"Min": 60.4,
"Numerator": 14535.0,
"Q20": 60.4,
"Q40": 65.2,
"Q60": 65.9,
"Q80": 66.9,
"TimePeriodID": 1,
"UpperConfidenceLimit": 62.9,
"Value": 62.3,
"ValueNote": ""
},
"CategoryAttribute": "Male",
"ExternalCategoryID": 29,
"MetricCategoryID": 29,
"MetricCategoryName": "Male",
"MetricCategoryOrder": 2,
"MetricCategoryTypeName": "Sex",
"NationalData": {
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Count": null,
"DataID": 4725,
"Denominator": 2662000.0,
"Factor": 1.0,
"LowerConfidenceLimit": 66.2,
"Max": null,
"Median": null,
"Min": null,
"Numerator": 1762593.0,
"Q20": null,
"Q40": null,
"Q60": null,
"Q80": null,
"TimePeriodID": 1,
"UpperConfidenceLimit": 66.3,
"Value": 66.2,
"ValueNote": ""
}
}
],
"FormatDisplayName": "Proportion %",
"IndicatorCode": "CVDP002HYP",
"IndicatorFormatID": 1,
"IndicatorID": 2,
"IndicatorName": "The percentage of patients aged 18 to 79 years with GP recorded hypertension, in whom the last blood pressure reading within the preceding 12 months is equal to 140/90 mmHg or less",
"IndicatorOrder": 5,
"IndicatorShortName": "AF: prevalence",
"TimePeriodID": 1,
"TimePeriodName": "To March 2020"
}
}
/indicator/<indicator_ID>/rawDataJSON
Returns all metric data for a specified indicator, system level and time period. Data will be in JSON format, and will include all “raw” values, as provided by PHE/OHID team.
Query parameters:
timePeriodID - time period for which to return data for (compulsory)
systemLevelID - system level for which to return data for (compulsory)
{
"indicatorRawData": [
{
"AreaCode": "E92000001",
"AreaName": "England",
"CategoryAttribute": "Persons",
"Denominator": 39173935.0,
"Factor": 1.0,
"IndicatorCode": "CVDP001AF",
"IndicatorName": "Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over",
"LowerConfidenceLimit": 2.4,
"MetricCategoryName": "Persons",
"MetricCategoryTypeName": "Sex",
"Numerator": 933862.0,
"TimePeriodName": "To March 2020",
"UpperConfidenceLimit": 2.4,
"Value": 2.4,
"ValueNote": ""
},
{
"AreaCode": "E92000001",
"AreaName": "England",
"CategoryAttribute": "Male",
"Denominator": 19458878.0,
"Factor": 1.0,
"IndicatorCode": "CVDP001AF",
"IndicatorName": "Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over",
"LowerConfidenceLimit": 2.8,
"MetricCategoryName": "Male",
"MetricCategoryTypeName": "Sex",
"Numerator": 541673.0,
"TimePeriodName": "To March 2020",
"UpperConfidenceLimit": 2.8,
"Value": 2.8,
"ValueNote": ""
}
]
}
/indicator/<id>/rawDataCSV
Returns all metric data for specified indicator, system level and time period. Data will be in CSV (comma separated-values), and will include all “raw” values, as provided by PHE/OHID team. Same as above endpoint (/rawDataJSON), except a CSV file will be returned instead.
Query parameters:
timePeriodID - time period for which to return data for (compulsory)
systemLevelID - area for which to return data for (compulsory)
/indicator/<id>/rawDataXLSX
Returns all metric data for a specified indicator, system level and time period. Data will be in an XLSX format, and will include all “raw” values, as provided by PHE/OHID team. Same as above endpoint (/rawDataCSV), except an XLSX file will be returned instead.
Query parameters:
timePeriodID - time period for which to return data for (compulsory)
systemLevelID - area for which to return data for (compulsory)
/indicator/<id>/metaDataXLSX
Returns all Meta data for a specified indicator as an XLSX file. Resulting file will include columns IndicatorCode, IndicatorName, CategoryName, MetaDataTitle and MetaData.
/indicator/nationalVsAreaMetricData/<metric_ID>
Returns national and area data for provided metric ID, areaID and timePeriodID, which are passed asarameters. Target data contains the target value is a percentage stored as a whole number up to 100; target patients is the number of patients more needed to reach the target percentage. If there is not data for both national and chosen area for the given parameters, an error will be returned.
Query Parameters:
timePeriodID - time period for which to return data for (compulsory)
areaID - area for which to return data for (compulsory)
{
"indicatorData": {
"AreaData": [
{
"AreaCode": "U82731",
"AreaID": 739,
"AreaName": "Wyre Integrated Network Ltd Pcn",
"NationalLevel": 'N',
"Value": 64.72
},
{
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"NationalLevel": 'Y',
"Value": 61.41
}
],
"TargetData": {
"TargetPatients": 698.6000000000004,
"TargetValue": 77.0
}
}
}
/indicator/priorityGroups
Returns the list of top-level groupings (Priority Groups) displayed in the Regional & ICS Insights page. Returns a dictionary called "PriorityGroups", with each key being a Priority Group name, and each value being the array of indicators contained in that group. The "PriorityGroupDisplayOrder" indicates the order in which it should be displayed for the given Priority Group.
{
"PriorityGroups": {
"Chronic Kidney Disease": [
{
"IndicatorCode": "CVDP006CKD",
"IndicatorID": 29,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded CKD (G3a to G5), with a record of an eGFR test in the preceding 12 months",
"MetricID": 549,
"PathwayGroupID": 9.0,
"PathwayGroupName": "Chronic Kidney Disease",
"PriorityGroupDisplayOrder": 1,
"PriorityGroupID": 4,
"QuestionGroupName": "Monitoring"
},
{
"IndicatorCode": "CVDP005CKD",
"IndicatorID": 19,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded CKD (G3a to G5), hypertension and proteinuria, currently treated with renin-angiotensin system antagonists",
"MetricID": 330,
"PathwayGroupID": 9.0,
"PathwayGroupName": "Chronic Kidney Disease",
"PriorityGroupDisplayOrder": 2,
"PriorityGroupID": 4,
"QuestionGroupName": "Management"
},
...
],
"Lifestyle": [
{
"IndicatorCode": "CVDP001SMOK",
"IndicatorID": 24,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded CVD or CVD risk factors who are GP recorded current smokers or have no smoking status recorded, whose notes record smoking status in the preceding 12 months.",
"MetricID": 630,
"PathwayGroupID": 10.0,
"PathwayGroupName": "Smoking",
"PriorityGroupDisplayOrder": 1,
"PriorityGroupID": 3,
"QuestionGroupName": "Identification"
},
...
]
}
}
}
/indicator/pathwayGroup/<pathway_group_id>
Pathway groups are sub-groupings of Priority Groups, visible in the Regional & ICS Insights page. This endpoint returns a single pathway group for a given group ID. An error will be returned if there is no pathway group associated with the given ID. For a valid request, Pathway Group ID and name are returned as key value pairs, and the Indicators populate an array.
{
"PathwayGroup": {
"PathwayGroupID": 10,
"PathwayGroupName": "Smoking",
"Indicators": [
{
"IndicatorCode": "CVDP001SMOK",
"IndicatorID": 24,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded CVD or CVD risk factors who are GP recorded current smokers or have no smoking status recorded, whose notes record smoking status in the preceding 12 months.",
"MetricID": 630,
"PathwayGroupDisplayOrder": 1,
"QuestionGroupName": "Identification"
},
{
"IndicatorCode": "CVDP002SMOK",
"IndicatorID": 26,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded CVD or CVD risk factors who are GP recorded current smokers, who have a record of an offer of support or treatment within the preceding 12 months.",
"MetricID": 657,
"PathwayGroupDisplayOrder": 2,
"QuestionGroupName": "Management"
}
]
}
}
/indicator/indicatorGroup/<indicator_group_ID>
Returns a single indicator group for a given group ID. An error will be returned if there is no indicator group associated with the given ID. IndicatorGroup is the primary key in the IndicatorGroup table, which also contains IndicatorGroupName and IndicatorGroupTypeID. The group type ID tells you what type of indicator group you’re dealing with, e.g. a Priority Group. IndicatorGroupTypeID is the primary key of IndicatorGroupType, and so IndicatorGroupTypeName is the associated name for the given group type ID. Finally, there is the array of indicators which are contained in this group, including display orders for the given group.
"IndicatorGroup": {
"IndicatorGroupID": 15,
"IndicatorGroupName": "Overtreatment",
"IndicatorGroupTypeID": 3,
"IndicatorGroupTypeName": "Key Question",
"Indicators": [
{
"DisplayOrder": 1,
"IndicatorCode": "CVDP006HYP",
"IndicatorID": 21,
"IndicatorName": "Percentage of patients aged 18 and over with GP recorded hypertension, prescribed at least one anti-hypertensive treatment with last systolic BP 100mmHg or less and a subsequent antihypertension medication prescription date",
"MetricID": 377
}
]
}
}
/indicator/timeSeriesByMetric/<metric_ID>
Returns data for the Time Series chart for specified metric ID and area ID. Contains an array of two areas in "Areas", one of which is the National data, with the other corresponding to the provided area ID. "TargetValue" is also returned in the "Data" dictionary.
Query Parameters:
areaID - area for which to return data for (compulsory)
{
"Data": {
"Areas": [
{
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"TimeSeriesData": [
{
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 59.61
},
{
"TimePeriodID": 6,
"TimePeriodName": "To June 2022",
"Value": 59.61
}
]
},
{
"AreaCode": "E54000011",
"AreaID": 8039,
"AreaName": "NHS Shropshire, Telford and Wrekin Integrated Care Board",
"TimeSeriesData": [
{
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 55.95
},
{
"TimePeriodID": 6,
"TimePeriodName": "To June 2022",
"Value": 55.95
}
]
}
],
"TargetValue": 77.0
}
}
/indicator/personsTimeSeriesByIndicator/<indicator_ID>
Returns data for the Inequalitiers Markers Time Series chart for provided indicator ID and area ID. "Data" contains info about the chosen area and the target value, as well as an array "InequalityMarkers" which contains all the timeseries data grouped into metric category types, e.g. age group, ethnicity, etc.
Query Parameters:
areaID - area for which to return data for (compulsory)
{
"Data": {
"AreaCode": "E54000011",
"AreaID": 8039,
"AreaName": "NHS Shropshire, Telford and Wrekin Integrated Care Board",
"InequalityMarkers": [
{
"CategoryData": [
{
"MetricCategoryID": 6,
"MetricCategoryName": "18-39",
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 37.29
}
],
"MetricCategoryTypeID": 1,
"MetricCategoryTypeName": "Age group"
},
{
"CategoryData": [
{
"MetricCategoryID": 16,
"MetricCategoryName": "1 - most deprived",
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 54.47
}
],
"MetricCategoryTypeID": 2,
"MetricCategoryTypeName": "Deprivation quintile"
},
{
"CategoryData": [
{
"MetricCategoryID": 21,
"MetricCategoryName": "Asian",
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 54.27
}
],
"MetricCategoryTypeID": 3,
"MetricCategoryTypeName": "Ethnicity"
},
{
"CategoryData": [
{
"MetricCategoryID": 28,
"MetricCategoryName": "Female",
"TimePeriodID": 5,
"TimePeriodName": "To June 2022",
"Value": 57.33
}
],
"MetricCategoryTypeID": 4,
"MetricCategoryTypeName": "Sex"
}
],
"TargetValue": 77.0
}
}
/indicator/metricSystemLevelComparison/<metric_ID>
Returns data for the SystemLevel Comparison chart for provided metric ID, area ID and time period ID. "Data" contains the target value, as well as an array "SystemLevels" which contains data grouped by system level.
Query Parameters:
timePeriodID - time period for which to return data for (compulsory)
areaID - area for which to return data for (compulsory)
{
"Data": {
"SystemLevels": [
{
"ComparisonData": [
{
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"Value": 59.61
}
],
"NationalLevel": "Y",
"SystemLevelID": 1,
"SystemLevelMedian": 59.61,
"SystemLevelName": "England",
"SystemLevelOrder": 1
},
{
"ComparisonData": [
{
"AreaCode": "E38000091",
"AreaID": 7934,
"AreaName": "NHS Cheshire and Merseyside ICB - 01J",
"Value": 54.01
},
{
"AreaCode": "E38000187",
"AreaID": 7935,
"AreaName": "NHS Greater Manchester ICB - 02A",
"Value": 57.45
},
...
],
"NationalLevel": "N",
"SystemLevelID": 8,
"SystemLevelMedian": 59.78,
"SystemLevelName": "Sub-ICB",
"SystemLevelOrder": 4
}
],
"TargetValue": 77.0
}
}
/indicator/metricAreaBreakdown/<metric_ID>
Returns data for the Area Breakdown chart for provided metric ID, area ID and time period ID. "Data" contains the target value, as well as an array "SystemLevels" which contains data grouped by system level.
Query Parameters:
timePeriodID - time period for which to return data for (compulsory)
areaID - area for which to return data for (compulsory)
{
"Data": {
"SystemLevels": [
{
"ComparisonData": [
{
"AreaCode": "E92000001",
"AreaID": 1,
"AreaName": "England",
"ParentAreaID": null,
"Value": 59.61
}
],
"NationalLevel": "Y",
"SystemLevelID": 1,
"SystemLevelMedian": 59.61,
"SystemLevelName": "England",
"SystemLevelOrder": 1
},
{
"ComparisonData": [
{
"AreaCode": "E38000257",
"AreaID": 8017,
"AreaName": "NHS Shropshire, Telford and Wrekin ICB - M2L0M",
"ParentAreaID": null,
"Value": 55.95
}
],
"NationalLevel": "N",
"SystemLevelID": 8,
"SystemLevelMedian": 55.95,
"SystemLevelName": "Sub-ICB",
"SystemLevelOrder": 4
},
{
"ComparisonData": [
{
"AreaCode": "U13205",
"AreaID": 226,
"AreaName": "Wrekin PCN",
"ParentAreaID": 8017.0,
"Value": 41.75
},
{
"AreaCode": "U64003",
"AreaID": 435,
"AreaName": "Newport And Central PCN",
"ParentAreaID": 8017.0,
"Value": 56.14
}
],
"NationalLevel": "N",
"SystemLevelID": 4,
"SystemLevelMedian": 57.075,
"SystemLevelName": "PCN",
"SystemLevelOrder": 5
},
{
"ComparisonData": [
{
"AreaCode": "M82002",
"AreaID": 5271,
"AreaName": "Mytton Oak Medical Pract.",
"ParentAreaID": 1373.0,
"Value": 52.43
},
{
"AreaCode": "M82003",
"AreaID": 5272,
"AreaName": "Stirchley Medical Practice",
"ParentAreaID": 731.0,
"Value": 57.21
}
],
"NationalLevel": "N",
"SystemLevelID": 5,
"SystemLevelMedian": 55.54,
"SystemLevelName": "Practice",
"SystemLevelOrder": 6
}
],
"TargetValue": 77.0
}
}
External Resource
/externalResource
Returns a list of all external resources.
Response:
{
"externalResourceList": [
{
"ExternalResourceCategory": "Data Packs",
"ExternalResourceID": 2,
"ExternalResourceOrder": 1,
"ExternalResourceSource": "Public Health England",
"ExternalResourceTitle": "Cardiovascular Disease Prevention Data Packs",
"ExternalResourceType": "website",
"ExternalResourceURL": "https://fingertips.phe.org.uk/profile/cardiovascular-disease-prevention",
"Tags": [
{
"IndicatorTagID": 24.0,
"IndicatorTagName": "prevention"
}
]
},
{
"ExternalResourceCategory": "Data Packs",
"ExternalResourceID": 3,
"ExternalResourceOrder": 2,
"ExternalResourceSource": "NHS England",
"ExternalResourceTitle": "Equality and Health Inequality Packs",
"ExternalResourceType": "document",
"ExternalResourceURL": "https://www.england.nhs.uk/rightcare/products/ccg-data-packs/equality-and-health-inequality-nhs-rightcare-packs/",
"Tags": [
{
"IndicatorTagID": 25.0,
"IndicatorTagName": "equality"
},
{
"IndicatorTagID": 26.0,
"IndicatorTagName": "inequality"
},
{
"IndicatorTagID": 27.0,
"IndicatorTagName": "rightcare"
}
]
},
...
]
}
Data Availability
/dataAvailability
Returns the data availability.
Query parameters:
timePeriodID (compulsory)
systemLevelID (compulsory)
indicatorID (optional)
metricCategoryTypeID (optional)
Response:
DataAvailabilityID - ID of the resource as found in the database.
DataAvailabilityName - explanation for the data availability.
IsAvailable - ‘Y' for data is available, 'N’ for data is unavailable, and NULL for unknown data.
{
"DataAvailability": [
{
"DataAvailabilityID": 169,
"DataAvailabilityName": "Data available",
"IndicatorID": 11,
"IsAvailable": "Y",
"MetricCategoryTypeID": 4,
"MetricCategoryTypeName": "Sex",
"SystemLevelID": 1,
"TimePeriodID": 6
},
{
"DataAvailabilityID": 170,
"DataAvailabilityName": "Data available",
"IndicatorID": 11,
"IsAvailable": "Y",
"MetricCategoryTypeID": 2,
"MetricCategoryTypeName": "Deprivation quintile",
"SystemLevelID": 1,
"TimePeriodID": 6
},
{
"DataAvailabilityID": 171,
"DataAvailabilityName": "Data available",
"IndicatorID": 11,
"IsAvailable": "Y",
"MetricCategoryTypeID": 1,
"MetricCategoryTypeName": "Age group",
"SystemLevelID": 1,
"TimePeriodID": 6
},
{
"DataAvailabilityID": 172,
"DataAvailabilityName": "Data not available due to absence of reliable ethnic breakdown of denominator population ",
"IndicatorID": 11,
"IsAvailable": "N",
"MetricCategoryTypeID": 3,
"MetricCategoryTypeName": "Ethnicity",
"SystemLevelID": 1,
"TimePeriodID": 6
}
]
}