Versions Compared

Key

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

...

Code Block
{
  "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).

...

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"
  }
}

...

*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)

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

...