Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://api.cvdprevent.nhs.uk

...

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
minLevel1
maxLevel76
outlinefalse
styledefault
typelist
printabletrue

...

Time Period

/timePeriod

Returns all available time periods.

...

languagejson

...

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
languagejson
{
  "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"
    },
    ...
  ]
}

...

  • timePeriodID - time period to return data for (compulsory)

  • systemLevelID - system level to return data for (compulsory)

{ "indicatorList": [ {
Code Block
languagejson
{
  "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
languagejson
{
  "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
languagejson
{
   "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,
                  "AxisCharacterMedian":3.1,
  "%"                "Min":1.2,
      "DataUpdateInterval": null,            "Numerator":3130.0,
                  "FormatDisplayNameQ20": "Proportion %",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
languagejson
{         "indicatorListValueNote":[
""
               },
     {          "AxisCharacterExternalCategoryID":"%"29,
               "MetricCategoryID":29,
         "Categories":[      "MetricCategoryName":"Male",
               {"MetricCategoryOrder":2,
               "CategoryAttributeMetricCategoryTypeName":"Persons""Sex",
               "MetricID":172,
               "DataTimeSeries":{[
                  {
  "AreaID":97,                   "Count":105.0,EndDate":"Tue, 31 Mar 2020 00:00:00 GMT",
                     "DataIDMedian":28489,3.1,
                     "StartDate":"Mon, 01 Jan 1900 00:00:00 GMT",
   "Denominator":204430.0,                   "FactorTimePeriodID":1.0,
                     "LowerConfidenceLimitTimePeriodName":2.6"To March 2020",
                     "MaxValue":43.2,1
                   "Median":2.6,}
               ]
   "Min":1.1,         },
         "Numerator":5415.0,   {
               "Q20CategoryAttribute":1.1"Female",
                  "Q40Data":2.2,{
                  "Q60AreaID":2.797,
                  "Q80Count":3105.0,
                  "TimePeriodIDDataID":126949,
                  "UpperConfidenceLimitDenominator":2102960.70,
                  "ValueFactor":21.60,
                  "ValueNoteLowerConfidenceLimit":""2.1,
               },                "MetricCategoryID":30"Max":3.7,
                  "MetricCategoryNameMedian":"Persons",2.2,
                  "MetricCategoryOrderMin":1.0,
                  "MetricCategoryTypeNameNumerator":"Sex",2285.0,
                  "MetricIDQ20":1901.0,
                  "TimeSeriesQ40":[1.9,
                  {
  "Q60":2.2,
                  "EndDateQ80":"Tue2.5,
31 Mar 2020 00:00:00 GMT",
                     "MedianTimePeriodID":2.61,

                    "StartDateUpperConfidenceLimit":"Mon2.3,
01  Jan 1900 00:00:00 GMT",             "Value":2.2,
        "TimePeriodID":1,          "ValueNote":""
           "TimePeriodName":"To March 2020",  },
               "ExternalCategoryID":28,
   "Value":2.6            "MetricCategoryID":28,
      }         "MetricCategoryName":"Female",
      ]         "MetricCategoryOrder":3,
   },             {"MetricCategoryTypeName":"Sex",
                "CategoryAttributeMetricID":"Male"171,
               "DataTimeSeries":{[
                  {
 "AreaID":97,                    "Count":105.0,EndDate":"Tue, 31 Mar 2020 00:00:00 GMT",
                     "DataIDMedian":26956,2.2,
                     "StartDate"Denominator":101470.0:"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
languagejson
{
  "indicatorTagList": [
 "UpperConfidenceLimit":3.2,   {
      "IndicatorTagID": 1, 
      "ValueIndicatorTagName":3.1, "Anticogulation drug therapy"
    }, 
    {
      "ValueNoteIndicatorTagID":"" 2, 
      "IndicatorTagName": "Atrial Fibrillation"
    },
   
    {
      "ExternalCategoryIDIndicatorTagID":29 3, 
              "MetricCategoryID"IndicatorTagName":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
languagejson
{
   "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
languagejson
{
  "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": "TueCVDP002HYP", 
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": null71.0, 
     }
   ]
}

...

/indicator/tags

Returns a list of all available tags, which can be used to filter indicators.

Query parameter:
None

Code Block
languagejson
{     "indicatorTagListSystemLevelID": [
 3, 
        "SystemLevelName": "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
languagejson
{
  "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
languagejson
{
  "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": "Prevalence of GP recorded atrial fibrillation in patients aged 18 and over"1.0, 
          "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
languagejson
{
  "siblingData": {"Numerator": 28155.0, 
          "Q20": 62.1, 
          "CategoryAttributeQ40": "Female"66.3, 
    "Data":  [    "Q60": 67.4, 
{          "AreaCodeQ80": "E54000029"68.1, 
          "AreaIDTimePeriodID": 301, 
          "AreaNameUpperConfidenceLimit": "East London Health and Care Partnership"64.5, 
          "Value": 64.1, 
          "CountValueNote": 42.0""
        }, 
        "DataIDCategoryAttribute": 4812"Persons", 
        "DenominatorExternalCategoryID": 77090.030, 
        "FactorMetricCategoryID": 1.030, 
        "LowerConfidenceLimitMetricCategoryName": 73.3"Persons", 
        "MaxMetricCategoryOrder": 73.61, 
        "MedianMetricCategoryTypeName": 68.8"Sex", 
        "MinNationalData": 64.0,{
          "NumeratorAreaCode": 56745.0"E92000001", 
          "Q20AreaID": 64.01, 
          "Q40AreaName": 67.2,"England", 
          "Q60Count": 68.9null, 
          "Q80DataID": 69.94748, 
          "SystemLevelIDDenominator": 25068900.0, 
          "SystemLevelNameFactor": "STP"1.0, 
          "TimePeriodIDLowerConfidenceLimit": 167.5, 
          "TimePeriodNameMax": "Tonull, March
2020",          "UpperConfidenceLimitMedian": 73.9null, 
          "ValueMin": 73.6null, 
          "ValueNoteNumerator": ""3422314.0, 
      },    "Q20": null, 
 {         "AreaCodeQ40": "E54000050"null, 
          "AreaIDQ60": 38null, 
          "AreaNameQ80": "Cumbrianull, and
North East",          "CountTimePeriodID": 42.01, 
          "DataIDUpperConfidenceLimit": 482167.6, 
          "DenominatorValue": 15067067.05, 
          "FactorValueNote": 1.0, ""
        }
 "LowerConfidenceLimit": 71.2,    }, 
    "Max": 73.6, {
        "MedianAreaData": 68.8,{
          "MinAreaCode": 64.0"E54000011", 
          "NumeratorAreaID": 107555.02, 
          "Q20AreaName": 64.0, "Shropshire and Telford and Wrekin", 
          "Q40Count": 6742.20, 
          "Q60DataID": 68.94749, 
          "Q80Denominator": 6923330.90, 
          "SystemLevelIDFactor": 21.0, 
          "SystemLevelNameLowerConfidenceLimit": "STP",61.7, 
          "TimePeriodIDMax": 169.7, 
          "TimePeriodNameMedian": "To March 2020",65.85, 
          "UpperConfidenceLimitMin": 7160.64, 
          "ValueNumerator": 7114535.40, 
          "ValueNoteQ20": ""60.4, 
     }     ], 
    "IndicatorCode"Q40": "CVDP002HYP"65.2, 
    "IndicatorID": 2,      "IndicatorNameQ60": "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",65.9, 
          "Q80": 66.9, 
          "TimePeriodID": 1, 
          "IndicatorOrderUpperConfidenceLimit": 5,62.9, 
          "IndicatorShortNameValue": "AF: prevalence"62.3, 
   "MetricCategoryID": 28,      "MetricCategoryNameValueNote": "Female",
       "MetricCategoryOrder": 3}, 
        "MetricCategoryTypeNameCategoryAttribute": "SexMale", 
 }
}

/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": {       "ExternalCategoryID": 29, 
        "MetricCategoryID": 29, 
        "CategoryAttributeMetricCategoryName": "Male", 
        "FemaleMetricCategoryOrder": 2, 
        "DataMetricCategoryTypeName": [ "Sex", 
        "NationalData": {
          "AreaCode": "E38000257E92000001", 
          "AreaID": 741, 
          "AreaName": "England"NHS Shropshire, Telford
and Wrekin CCG",          "Count": 105.0null, 
          "DataID": 58964725, 
          "Denominator": 206152662000.0, 
          "Factor": 1.0, 
          "LowerConfidenceLimit": 6566.42, 
          "Max": 75.5null, 
          "Median": 69.0null, 
          "Min": 61.6null, 
          "Numerator": 136251762593.0, 
          "Q20": 61.6null, 
          "Q40": 67.1null, 
          "Q60": 69.1null, 
          "Q80": 71.0null, 
          "SystemLevelIDTimePeriodID": 31, 
          "SystemLevelNameUpperConfidenceLimit": "CCG"66.3, 
          "TimePeriodIDValue": 166.2, 
          "TimePeriodNameValueNote": "To March 2020",
         "UpperConfidenceLimit": 66.7,}
      }
   "Value": 66.1, 
 ], 
      "ValueNoteFormatDisplayName": "Proportion %", 
     }
    ]"IndicatorCode": "CVDP002HYP", 
    "IndicatorCodeIndicatorFormatID": "CVDP002HYP"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 March     "MetricCategoryOrder": 3, 
    "MetricCategoryTypeName": "Sex"
  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
languagejson
{
  "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

...