Versions Compared

Key

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

...

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

...