Contents:
| Table of Contents | ||||
|---|---|---|---|---|
|
Time Period
/timePeriod
Returns all available time periods.
...
| language | json |
|---|
...
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:
| Table of 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)
| Code Block | ||
|---|---|---|
| ||
{ "timePeriodList": [ { "EndDate": "SatTue, 31 DecMar 20222020 00:00:00 GMT", "StartDate": "Mon, 01 Jan 1900 00:00:00 GMT", "TimePeriodID": 91, "TimePeriodName": "To DecemberMarch 20222020" }, ...{ ] } |
...
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)
...
| language | json |
|---|
...
"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“
| Code Block | ||
|---|---|---|
| ||
{ "timePeriodList": [ { |
...
"EndDate": " |
...
Tue, 31 Mar 2020 00:00:00 GMT", " |
...
StartDate": |
...
"Mon, 01 Jan 1900 00:00:00 GMT", |
...
|
...
/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)
| Code Block | ||
|---|---|---|
| ||
{ "areaList"TimePeriodID": 1, "TimePeriodName": "To March 2020", "SystemLevels": [ { { "AreaCode": "E92000001", "AreaIDSystemLevelID": 1, "AreaNameSystemLevelName": "England", "Parents": [], "ParticipationRateIsVisible": 79.4"Y", "PopulationRateNationalLevel": 81.3,"Y" "SystemLevelID": 1}, "SystemLevelName": "England" { } ] } |
...
/area/<area_id>/details
Returns details of a specific area at a given time period.
Query parameters:
...
| language | json |
|---|
...
" |
...
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)
| Code Block | ||
|---|---|---|
| ||
{ "SystemLevelNamesystemLevels": "STP"[ { }, "IsVisible": "Y", { "AreaCodeNationalLevel": "E54000053Y", "AreaIDSystemLevelID": 201, "AreaNameSystemLevelName": "SussexEngland", and East Surrey Health and Care Partnership"SystemLevelOrder",: 1 }, "SystemLevelID": 2, { "SystemLevelNameIsVisible": "STPY", } "NationalLevel": "N", ], "ParentAreaListSystemLevelID": []2, "ParticipationRateSystemLevelName": 79.4"STP", "PopulationRate": 81.3, "SystemLevelIDSystemLevelOrder": 1,2 "SystemLevelName": "England"} ] } } |
...
*Proposed*/area/
...
systemLevel/timePeriods
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)
...
all available system levels, with an array of the time periods where the system levels occur.
Note: Inverse of “/timePeriod/systemLevels”
| Code Block | ||
|---|---|---|
| ||
{
"unassignedAreaListsystemLevels": [
{
"AreaCodeIsVisible": "L82021Y",
"AreaIDNationalLevel": 4978"Y",
"AreaNameSystemLevelID": "Alverton Practice"1,
"SystemLevelIDSystemLevelName": 5"England",
"SystemLevelNameSystemLevelOrder": "Practice"1
},
{
"AreaCodeIsVisible": "Y00260Y",
"AreaIDNationalLevel": 6546"N",
"AreaNameSystemLevelID": 2, "Arlesey
Medical Centre",
"SystemLevelID": 5,
"SystemLevelName": "Practice"
}STP",
{ "AreaCodeSystemLevelOrder": "J82220",2
"AreaID": 4575,
"AreaName": "Beggarwood Surgery - Nhuc",
"SystemLevelID": 5,
"SystemLevelName": "Practice"
}
]
} |
...
/area
...
Returns a list of Areas that match a partial name all areas for a given time period . Uses simple LIKE ‘%<partial_area_name>%’ comparison.
Query parameters:
...
partialAreaName - string to use to search for an Area (compulsory)
...
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)
| Code Block | ||
|---|---|---|
| ||
{
"foundAreaListareaList": [
{
"AreaCode": "P86619E92000001",
"AreaID": 63881,
"AreaName": "Dr Mb Ghafoor & PartnersEngland",
"IsVisibleParents": "N"[],
"NationalLevelParticipationRate": "N",79.4,
"SystemLevelIDPopulationRate": 581.3,
"SystemLevelNameSystemLevelID": "Practice"1,
"SystemLevelOrderSystemLevelName": 5"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)
| Code Block | ||
|---|---|---|
| ||
{ "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, |
...
|
...
|
...
/area/<area_id>/nestedSubSystems
Returns given area and children areas in a nested structure.
No query parameters.
...
"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)
| Code Block | ||
|---|---|---|
| ||
{ " |
...
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)
| Code Block |
|---|
{ "foundAreaList": [ { "AreaCode": "P86619", "SystemLevelIDAreaID": 56388, "AreaName": "Dr Mb Ghafoor & Partners", "IsVisible": "N", "SystemLevelNameNationalLevel": "PracticeN", "SystemLevelID": 5, "SystemLevelName": "Practice", }, "SystemLevelOrder": 5 }, { {"AreaCode": "B86011", "AreaID": 1991, "AreaName": "Hillfoot Surgery", "AreaCodeIsVisible": "F81078N", "NationalLevel": "N", "SystemLevelID": 5, "AreaIDSystemLevelName": 3349"Practice", "SystemLevelOrder": 5 }, { "AreaNameAreaCode": "Church Langley Medical PracticeP81132", "AreaID": 6155, "AreaName": "Waterfoot Medical Practice", "ChildrenIsVisible": []"N", "NationalLevel": "N", "SystemLevelID": 5, "ParentAreaIDSystemLevelName": 609"Practice", "SystemLevelOrder": 5 } ] } |
...
/area/<area_id>/nestedSubSystems
Returns given area and children areas in a nested structure.
No query parameters.
| Code Block |
|---|
{ "SystemLevelIDAreaRelationships": 5,{ "AreaCode": "E38000197", "SystemLevelNameAreaID": "Practice"79, "AreaName": "NHS West Essex CCG", }, "Children": [ { ... ]"AreaCode": "U34072", "ParentAreaIDAreaID": 79609, "SystemLevelIDAreaName": 4 "Harlow North PCN", "SystemLevelNameChildren": "PCN" [ }, { { "AreaCode": "U16446F81056", "AreaID": 6393338, "AreaName": "NorthJenner House UttlesfordOld PCNHarlow", "Children": [], { "ParentAreaID": 609, "SystemLevelID": 5, "SystemLevelName": "Practice" }, { "AreaCode": "F81009F81078", "AreaID": 33053349, "AreaName": "TheChurch GoldLangley StreetMedical SurgeryPractice", "Children": [], "ParentAreaID": 639609, "SystemLevelID": 5, "SystemLevelName": "Practice" }, ... ], "ParentAreaID": 79, "SystemLevelID": 4, "SystemLevelName": "PCN" }, ...{ ], "ParentAreaIDAreaCode": NaN"U16446", "SystemLevelID "AreaID": 3639, "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.
| Code Block |
|---|
{ "AreaRelationships": { "AreaName": "North Uttlesford PCN", "AreaCode": "E38000197", "AreaIDChildren": 79,[ "AreaName": "NHS West Essex CCG", { "ParentAreaID": NaN, "SubSystems": { "PCNAreaCode": ["F81009", { "AreaID": 3305, "AreaCode": "U34072", "AreaName": "The Gold Street Surgery", "AreaID": 609, "AreaNameChildren": [], "Harlow North PCN", "ParentAreaID": 79639, "SystemLevelID": 45, "SystemLevelName": "PCNPractice" }, { ... "AreaCode": "U16446", ], "AreaIDParentAreaID": 63979, "AreaNameSystemLevelID": "North Uttlesford PCN"4, "ParentAreaID": 79,"SystemLevelName": "PCN" }, "SystemLevelID": 4, ... ], "SystemLevelNameParentAreaID": "PCN"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.
| Code Block |
|---|
{ "AreaRelationships": { ], "AreaCode": "E38000197", "PracticeAreaID": [79, "AreaName": "NHS West Essex CCG", { "ParentAreaID": NaN, "SubSystems": { "PCN": [ { "AreaCode": "F81056U34072", "AreaID": 3338609, "AreaName": "JennerHarlow HouseNorth Old HarlowPCN", "ParentAreaID": 60979, "SystemLevelID": 54, "SystemLevelName": "PracticePCN" }, { "AreaCode": "F81078U16446", "AreaID": 3349639, "AreaName": "ChurchNorth LangleyUttlesford Medical PracticePCN", "ParentAreaID": 60979, "SystemLevelID": 54, "SystemLevelName": "PracticePCN" }, ... ], "Practice": [ },{ "SystemLevelID": 3, "SystemLevelNameAreaCode": "CCGF81056", } } |
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
| Info |
|---|
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)
| Code Block | ||
|---|---|---|
| ||
{ "indicatorList": [ { "AxisCharacter": "%", "DataUpdateInterval": null, "FormatDisplayName": "Proportion %", "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
| Info |
|---|
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)
| Code Block | ||
|---|---|---|
| ||
{
"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
| Info |
|---|
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)
| Code Block | ||
|---|---|---|
| ||
{
"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
| Info |
|---|
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)
| Code Block | ||
|---|---|---|
| ||
{ "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, "IndicatorCodeQ40": "CVDP002AF",2.6, "IndicatorFormatIDQ60": 3.1, "IndicatorID": 7, "IndicatorNameQ80":3.5, "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", "TimePeriodID":1, "IndicatorOrderUpperConfidenceLimit": 9,3.2, "IndicatorShortName": "CVD Prevalence", "IndicatorStatusValue":3.1, null } ... ] } |
/indicator
| Info |
|---|
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)
| Code Block | ||
|---|---|---|
| ||
{ "indicatorListValueNote":["" }, { "AxisCharacterExternalCategoryID":"%",29, "MetricCategoryID":29, "CategoriesMetricCategoryName":["Male", {"MetricCategoryOrder":2, "CategoryAttributeMetricCategoryTypeName":"PersonsSex", "DataMetricID":{172, "TimeSeries":[ "AreaID":97, { "Count":105.0, "DataID":28489,EndDate":"Tue, 31 Mar 2020 00:00:00 GMT", "DenominatorMedian":2044303.01, "Factor":1.0,StartDate":"Mon, 01 Jan 1900 00:00:00 GMT", "LowerConfidenceLimitTimePeriodID":2.61, "MaxTimePeriodName":4.2,"To March 2020", "MedianValue":23.6,1 "Min":1.1,} ] "Numerator":5415.0, }, "Q20":1.1, { "Q40CategoryAttribute":2.2, "Female", "Q60Data":2.7,{ "Q80AreaID":3.097, "TimePeriodIDCount":1105.0, "UpperConfidenceLimitDataID":2.726949, "ValueDenominator":2102960.60, "ValueNote":"" Factor":1.0, }, "MetricCategoryIDLowerConfidenceLimit":302.1, "MetricCategoryNameMax":"Persons"3.7, "MetricCategoryOrderMedian":12.2, "MetricCategoryTypeNameMin":"Sex",1.0, "MetricIDNumerator":1902285.0, "TimeSeriesQ20":[1.0, {"Q40":1.9, "EndDateQ60":"Tue2.2, 31 Mar 2020 00:00:00 GMT", "Q80":2.5, "Median":2.6, "TimePeriodID":1, "StartDate":"Mon, 01 Jan 1900 00:00:00 GMT", "UpperConfidenceLimit":2.3, "TimePeriodIDValue":12.2, "TimePeriodNameValueNote":"To March 2020","" }, "ValueExternalCategoryID":2.628, "MetricCategoryID":28, } "MetricCategoryName":"Female", ] },"MetricCategoryOrder":3, {"MetricCategoryTypeName":"Sex", "CategoryAttributeMetricID":"Male"171, "DataTimeSeries":{[ { "AreaID":97, "EndDate"Count":105.0,:"Tue, 31 Mar 2020 00:00:00 GMT", "DataIDMedian":269562.2, "Denominator":101470.0,StartDate":"Mon, 01 Jan 1900 00:00:00 GMT", "FactorTimePeriodID":1.0, "LowerConfidenceLimitTimePeriodName":3.0"To March 2020", "MaxValue":42.8,2 "Median":3.1,} ] "Min":1.2, } "Numerator":3130.0], "DataUpdateInterval": null, "Q20FormatDisplayName":1.2"Proportion %", "IndicatorCode":"CVDP001AF", "Q40IndicatorFormatID":2.61, "IndicatorID":1, "Q60IndicatorName":3.1, "Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over", "Q80IndicatorOrder":3.51, "IndicatorShortName": "AF: prevalence", "TimePeriodIDIndicatorStatus":1, null } ] } |
...
/indicator/tags
Returns a list of all available tags, which can be used to filter indicators.
Query parameter:
None
| Code Block | ||
|---|---|---|
| ||
{ "UpperConfidenceLimitindicatorTagList":3.2, [ { "ValueIndicatorTagID":3. 1, "IndicatorTagName": "Anticogulation drug therapy" }, "ValueNote":"" { "IndicatorTagID": 2, }, "IndicatorTagName": "Atrial Fibrillation" }, "ExternalCategoryID":29,{ "IndicatorTagID": 3, "MetricCategoryIDIndicatorTagName":29, "Blood pressure measures" } ] } |
...
/indicator/<indicator_ID>/details
Returns details of a single indicator
Query parameters:
None
| Info |
|---|
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. |
| Code Block | ||
|---|---|---|
| ||
{ "MetricCategoryNameindicatorDetails":"Male", { "DataUpdateInterval": null, "MetricCategoryOrder":2"IndicatorCode": "CVDP001AF", "IndicatorID": 1, "MetricCategoryTypeNameIndicatorName": "Sex",Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over", "MetricIDIndicatorOrder":172 1, "IndicatorShortName": "AF: prevalence", "TimeSeriesIndicatorStatus":[ null, "MetaData": { "Section 1: Indicator Overview & {Rationale": [ { "EndDateAgeStandardised": "TueY", 31 Mar 2020 00:00:00 GMT", "CategoryName": "Section 1: Indicator Overview & Rationale", "MedianMetaData":3.1, "Prevalence of GP recorded atrial fibrillation", "StartDateMetaDataCategoryID":"Mon 1, 01 Jan 1900 00:00:00 GMT", "MetaDataTitle": "Indicator title" "TimePeriodID":1}, { "TimePeriodNameCategoryName":"To March 2020",Section 1: Indicator Overview & Rationale", "ValueMetaData":3.1 "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)
| Code Block | ||
|---|---|---|
| ||
{
"siblingData": {
"CategoryAttribute": "Female",
"CategoryAttributeData":"Female", [
{
"DataAreaCode":{ "E54000029",
"AreaID": 30,
"AreaIDAreaName":97, "East London Health and Care Partnership",
"Count":105 42.0,
"DataID": 4812,
"DataIDDenominator":26949, 77090.0,
"Factor": 1.0,
"DenominatorLowerConfidenceLimit":102960 73.03,
"Max": 73.6,
"FactorMedian":1 68.08,
"Min": 64.0,
"LowerConfidenceLimitNumerator":2 56745.10,
"Q20": 64.0,
"MaxQ40":3 67.72,
"Q60": 68.9,
"MedianQ80":2 69.29,
"SystemLevelID": 2,
"MinSystemLevelName":1.0 "STP",
"TimePeriodID": 1,
"NumeratorTimePeriodName":2285.0 "To March 2020",
"UpperConfidenceLimit": 73.9,
"Q20Value":1 73.06,
"ValueNote": ""
"Q40":1.9},
{
"AreaCode": "Q60E54000050":2.2,
"AreaID": 38,
"Q80AreaName":2.5, "Cumbria and North East",
"TimePeriodIDCount":1 42.0,
"DataID": 4821,
"UpperConfidenceLimitDenominator":2 150670.30,
"Factor": 1.0,
"ValueLowerConfidenceLimit":2 71.2,
"Max": 73.6,
"ValueNoteMedian":"" 68.8,
"Min": 64.0,
}, "Numerator": 107555.0,
"ExternalCategoryIDQ20":28 64.0,
"Q40": 67.2,
"MetricCategoryID":28, "Q60": 68.9,
"MetricCategoryNameQ80":"Female",
69.9,
"MetricCategoryOrderSystemLevelID":3 2,
"SystemLevelName": "STP",
"MetricCategoryTypeName":"Sex", "TimePeriodID": 1,
"MetricIDTimePeriodName":171, "To March 2020",
"TimeSeriesUpperConfidenceLimit":[ 71.6,
"Value": 71.4,
{ "ValueNote": ""
}
],
"EndDateIndicatorCode": "CVDP002HYP"Tue,
31 Mar 2020 00:00:00 GMT""IndicatorID": 2,
"IndicatorName": "The percentage of patients aged 18 to 79 years with GP recorded hypertension, in "Median":2.2,
whom the last blood pressure reading within the preceding 12 months is equal to 140/90 mmHg or less",
"StartDateIndicatorOrder":"Mon 5, 01
Jan 1900 00:00:00 GMT"IndicatorShortName": "AF: prevalence",
"MetricCategoryID": 28,
"MetricCategoryName": "Female",
"TimePeriodIDMetricCategoryOrder":1 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)
| Code Block |
|---|
{ "childData": { "TimePeriodNameCategoryAttribute": "To March 2020Female", "Data": [ { "ValueAreaCode":2.2 "E38000257", "AreaID": 74, } "AreaName": "NHS Shropshire, Telford and Wrekin CCG", ] "Count": 105.0, "DataID": 5896, } ]"Denominator": 20615.0, "DataUpdateIntervalFactor": null1.0, "FormatDisplayNameLowerConfidenceLimit":"Proportion %" 65.4, "IndicatorCodeMax":"CVDP001AF" 75.5, "IndicatorFormatIDMedian":1 69.0, "IndicatorIDMin":1 61.6, "IndicatorNameNumerator":"Prevalence of GP recorded Atrial Fibrillation in patients aged 18 and over" 13625.0, "Q20": 61.6, "IndicatorOrderQ40": 67.1, "IndicatorShortNameQ60": "AF: prevalence"69.1, "IndicatorStatusQ80": 71.0, null } "SystemLevelID": 3, ] } |
...
/indicator/tags
Returns a list of all available tags, which can be used to filter indicators.
Query parameter:
None
| Code Block | ||
|---|---|---|
| ||
{ "indicatorTagListSystemLevelName": [ "CCG", { "IndicatorTagIDTimePeriodID": 1, "IndicatorTagNameTimePeriodName": "AnticogulationTo drugMarch therapy2020", }, {"UpperConfidenceLimit": 66.7, "IndicatorTagIDValue": 266.1, "IndicatorTagNameValueNote": "Atrial" Fibrillation" } ], { "IndicatorCode": "CVDP002HYP", "IndicatorTagIDIndicatorID": 32, "IndicatorTagNameIndicatorName": "BloodThe percentage of patients aged 18 to 79 years with GP recorded hypertension, in whom the last blood pressure measures"reading within the preceding 12 }months is equal ]to } |
/indicator/<indicator_ID>/details
Returns details of a single indicator
Query parameters:
None
| Info |
|---|
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. |
| Code Block | ||
|---|---|---|
| ||
{ "indicatorDetails": {140/90 mmHg or less", "IndicatorOrder": 5, "IndicatorShortName": "AF: prevalence", "DataUpdateIntervalMetricCategoryID": null28, "IndicatorCodeMetricCategoryName": "CVDP001AFFemale", "IndicatorIDMetricCategoryOrder": 13, "IndicatorNameMetricCategoryTypeName": "PrevalenceSex" of GP recorded Atrial Fibrillation in patients aged 18 and over", "IndicatorOrder": 1,} } |
...
/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)
| Code Block | ||
|---|---|---|
| ||
{ "indicatorData": { "IndicatorShortNameAxisCharacter": "AF: prevalence%", "IndicatorStatusCategories": [ null, "MetaData": { "Section 1: Indicator Overview & Rationale": [ "AreaData": { "AgeStandardisedAreaCode": "YE54000011", "CategoryNameAreaID": "Section 1: Indicator Overview & Rationale"2, "MetaDataAreaName": "PrevalenceShropshire ofand GPTelford recordedand atrial fibrillationWrekin", "MetaDataCategoryIDCount": 142.0, "MetaDataTitleDataID": "Indicator title" }5164, { "CategoryName": "Section 1: Indicator Overview & Rationale""Denominator": 43950.0, "MetaDataFactor": 1.0, "Prevalence of GP recorded atrial fibrillation in patients aged 18 and over""LowerConfidenceLimit": 63.6, "MetaDataCategoryIDMax": 171.5, "MetaDataTitleMedian": "Definition"67.3, } "Min": 62.1, ] } } } |
/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 indicators, 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)
| Code Block | ||
|---|---|---|
| ||
{ "siblingData": {"Numerator": 28155.0, "CategoryAttributeQ20": "Female"62.1, "Data": [ "Q40": 66.3, { "AreaCodeQ60": "E54000029"67.4, "AreaIDQ80": 3068.1, "AreaNameTimePeriodID": "East1, London Health and Care Partnership", "CountUpperConfidenceLimit": 4264.05, "DataIDValue": 481264.1, "DenominatorValueNote": 77090.0 "" }, "FactorCategoryAttribute": 1.0"Persons", "LowerConfidenceLimitExternalCategoryID": 73.330, "MaxMetricCategoryID": 73.630, "MedianMetricCategoryName": 68.8"Persons", "MinMetricCategoryOrder": 64.01, "NumeratorMetricCategoryTypeName": 56745.0"Sex", "Q20NationalData": 64.0,{ "Q40AreaCode": 67.2,"E92000001", "Q60AreaID": 68.91, "Q80AreaName": 69.9,"England", "SystemLevelIDCount": 2null, "SystemLevelNameDataID": "STP"4748, "TimePeriodIDDenominator": 15068900.0, "TimePeriodNameFactor": "To March 2020",1.0, "UpperConfidenceLimitLowerConfidenceLimit": 7367.95, "ValueMax": 73.6null, "ValueNoteMedian": ""null, }, "Min": null, { "AreaCodeNumerator": "E54000050",3422314.0, "AreaIDQ20": 38null, "AreaNameQ40": "Cumbrianull, and North East", "CountQ60": 42.0null, "DataIDQ80": 4821null, "DenominatorTimePeriodID": 150670.01, "FactorUpperConfidenceLimit": 167.06, "LowerConfidenceLimitValue": 7167.25, "MaxValueNote": 73.6,"" } "Median": 68.8, }, "Min": 64.0, { "NumeratorAreaData": { 107555.0, "Q20AreaCode": 64.0,"E54000011", "Q40AreaID": 67.2, "Q60AreaName": 68.9"Shropshire and Telford and Wrekin", "Q80Count": 6942.90, "SystemLevelIDDataID": 24749, "SystemLevelNameDenominator": "STP"23330.0, "TimePeriodIDFactor": 1.0, "TimePeriodNameLowerConfidenceLimit": "To March 2020",61.7, "UpperConfidenceLimitMax": 7169.67, "ValueMedian": 7165.485, "ValueNoteMin": "" }60.4, ], "IndicatorCodeNumerator": "CVDP002HYP"14535.0, "IndicatorID": 2, "IndicatorNameQ20": "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",60.4, "Q40": 65.2, "Q60": 65.9, "IndicatorOrderQ80": 566.9, "IndicatorShortName": "AF: prevalence", "MetricCategoryIDTimePeriodID": 281, "MetricCategoryName": "Female", "MetricCategoryOrderUpperConfidenceLimit": 362.9, "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)
| Code Block |
|---|
{ "childData": {"Value": 62.3, "ValueNote": "" }, "CategoryAttribute": "FemaleMale", "DataExternalCategoryID": [29, {"MetricCategoryID": 29, "AreaCodeMetricCategoryName": "E38000257Male", "AreaIDMetricCategoryOrder": 742, "AreaNameMetricCategoryTypeName": "NHS Shropshire, Telford and Wrekin CCG",Sex", "NationalData": { "CountAreaCode": 105.0"E92000001", "DataIDAreaID": 58961, "DenominatorAreaName": 20615.0"England", "FactorCount": 1.0null, "LowerConfidenceLimitDataID": 65.44725, "MaxDenominator": 752662000.50, "MedianFactor": 691.0, "MinLowerConfidenceLimit": 6166.62, "NumeratorMax": 13625.0, null, "Q20Median": 61.6null, "Q40Min": 67.1null, "Q60Numerator": 691762593.10, "Q80Q20": 71.0null, "SystemLevelIDQ40": 3null, "SystemLevelNameQ60": "CCG"null, "TimePeriodIDQ80": 1null, "TimePeriodNameTimePeriodID": "To1, March 2020", "UpperConfidenceLimit": 66.73, "Value": 66.12, "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", "MetricCategoryIDTimePeriodID": 281, "MetricCategoryNameTimePeriodName": "Female",To "MetricCategoryOrder": 3, "MetricCategoryTypeName": "Sex" March 2020" } } |
...
*Proposed*/indicator/
...
metric/<metric_id>/data
Returns all metric data for a specified indicatormetric. Data will include values for both selected area, and organisation at National Level (usually England).
...
| Code Block | ||
|---|---|---|
| ||
{
"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
...
timePeriodID - time period for which to return data for (compulsory)
systemLevelID - area system level for which to return data for (compulsory)
...