Quality Assurance Reporting Requirements API : Beginning 2008

This featured Application Programming Interface (API) page serves as a reference for developers who are building tools that interact with the data on Health Data NY. The page provides examples on how to retrieve data from each of the fields within the dataset. A description of each field is also provided. This specific API page is for the Quality Assurance Reporting Requirements: Beginning 2008 dataset. As a way of monitoring managed care plan performance and improving the quality of care provided to New York State residents, the New York State Department of Health (NYSDOH) collects data for four types of managed care insurance (commercial HMO, commercial Preferred Provider Organization, Medicaid managed care, and Child Health Plus) on an annual basis. Not all measures are collected each year. Some services require more resource intensive methods of collection, and these measures are collected every other year to reduce the burden associated with reviewing patient records. Refer to the Health Measures Descriptions document to learn about the specific measures included in this dataset. Measure specification changes and health plan mergers and closures preclude the ability to trend this data over time. Please use caution when attempting to compare measures and/or health plans over time. For more information, check out http://www.health.ny.gov/health_care/managed_care/reports/quality_performance_improvement.htm, or go to the "About" tab. This data set is available at: https://health.data.ny.gov/Health/Quality-Assurance-Reporting-Requirements-Beginning/vbkk-tipq. For more information about the dataset, go to the dataset and look in the "About" section.

Getting Started

All communication with the API is done through HTTPS, and errors are communicated through HTTP response codes. Available response types include JSON, XML, and CSV, which are selectable by the "extension" on API requests or by HTTP Accepts headers.

This documentation also includes inline, runable examples. Click on any link that contains a gear symbol next to it to run that example live against the Quality Assurance Reporting Requirements API : Beginning 2008 API.

App Tokens

All requests should include an app token that identifies your application, and each application should have its own unique app token. A limited number of requests can be made without an app token, but they are subject to much lower throttling limits than request that do include one. If you don't have an app token yet, click the button to the right to sign up for one.

Once you have an app token, you can include it with your request either by using the X-App-Token HTTP header, or by passing it via the $app_token parameter on your URL.

Response Codes

One of the following response codes will be returned with every request:

  1. 200Successful request.
  2. 202Request processing. You can retry your request, and when it's complete, you'll get a 200 instead.
  3. 400Bad request
  4. 401Unauthorized. You're not authorized to access this resource.
  5. 404Not found. The resource requested doesn't exist.
  6. 429Too Many Requests. The client has made too many requests and is currently being rate limited.
  7. 500Server errors. Our bad!

Code Samples

#!/usr/bin/env ruby

require 'net/https'
uri = URI('https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?recall_id=94')

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER

request = Net::HTTP::Get.new(uri.request_uri)
request.add_field('X-App-Token', ARGV[0])

response = http.request(request)
puts response.code
puts response.body
#!/usr/bin/env python

import sys
import requests

r = requests.get('https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?recall_id=94', headers={'X-App-Token': sys.argv[1]})
print r.status_code
print r.text
request = require 'request'
options = uri: 'https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$$app_token=APP_TOKEN&recall_id=94'
request options, (err, response, body) ->  console.log body
#!/bin/sh 

curl --header "X-App-Token: $1" "https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?recall_id=94"

Fields

The following fields are available on the Quality Assurance Reporting Requirements API : Beginning 2008 API.

measurement_year

Human Name: Measurement Year
Type: number
Measurement year.

Examples

Retrieve all records with measurement_year equal to 2013:

Retrieve all records where measurement_year is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(measurement_year, 47.598177,-122.33448, 1000)

payer

Human Name: Payer
Type: text
Payer.

Examples

Retrieve all records with payer equal to Medicaid Managed Care:

Retrieve all records where payer is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(payer, 47.598177,-122.33448, 1000)

plan_id

Human Name: Plan ID
Type: text
Health Plan ID.

Examples

Retrieve all records with plan_id equal to S99B010:

Retrieve all records where plan_id is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(plan_id, 47.598177,-122.33448, 1000)

plan_name

Human Name: Plan Name
Type: text
Health plan name.

Examples

Retrieve all records with plan_name equal to WellCare of New York:

Retrieve all records where plan_name is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(plan_name, 47.598177,-122.33448, 1000)

domain

Human Name: Domain
Type: text
Measure domain.

Examples

Retrieve all records with domain equal to Womens Health:

Retrieve all records where domain is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(domain, 47.598177,-122.33448, 1000)

sub_domain

Human Name: Sub Domain
Type: text
Measure sub domain.

Examples

Retrieve all records with sub_domain equal to Use of Services:

Retrieve all records where sub_domain is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(sub_domain, 47.598177,-122.33448, 1000)

measure_description

Human Name: Measure Description
Type: text
Description of quality measure.

Examples

Retrieve all records with measure_description equal to Wellness Discussion:

Retrieve all records where measure_description is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(measure_description, 47.598177,-122.33448, 1000)

measure

Human Name: Measure
Type: text
Measure short name

Examples

Retrieve all records with measure equal to Wellness Discuss:

Retrieve all records where measure is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(measure, 47.598177,-122.33448, 1000)

method_of_data_collection

Human Name: Method of Data Collection
Type: text
Method of collecting quality data.

Examples

Retrieve all records with method_of_data_collection equal to Hybrid Review:

Retrieve all records where method_of_data_collection is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(method_of_data_collection, 47.598177,-122.33448, 1000)

eligible_population

Human Name: Eligible Population
Type: number
Number of persons eligible for service.

Examples

Retrieve all records with eligible_population equal to 2016191:

Retrieve all records where eligible_population is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(eligible_population, 47.598177,-122.33448, 1000)

denominator

Human Name: Denominator
Type: number
Number of persons meeting denominator criteria.

Examples

Retrieve all records with denominator equal to 1345850:

Retrieve all records where denominator is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(denominator, 47.598177,-122.33448, 1000)

numerator

Human Name: Numerator
Type: number
Number of persons numerator compliant.

Examples

Retrieve all records with numerator equal to 1221672:

Retrieve all records where numerator is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(numerator, 47.598177,-122.33448, 1000)

rate

Human Name: Rate
Type: number
Rate.

Examples

level_of_significance

Human Name: Level of Significance
Type: text
Level of Significance.

Examples

Retrieve all records with level_of_significance equal to Significantly worse than the statewide average:

Retrieve all records where level_of_significance is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(level_of_significance, 47.598177,-122.33448, 1000)

percentile_90th

Human Name: Percentile 90th
Type: number
10% of plans have a rate above this value.

Examples

Retrieve all records with percentile_90th equal to 100:

Retrieve all records where percentile_90th is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(percentile_90th, 47.598177,-122.33448, 1000)

percentile_75th

Human Name: Percentile 75th
Type: number
25% of plans have a rate above this value.

Examples

Retrieve all records with percentile_75th equal to 100:

Retrieve all records where percentile_75th is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(percentile_75th, 47.598177,-122.33448, 1000)

percentile_50th

Human Name: Percentile 50th
Type: number
50% of plans have a rate above and below this value.

Examples

Retrieve all records with percentile_50th equal to 100:

Retrieve all records where percentile_50th is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(percentile_50th, 47.598177,-122.33448, 1000)

percentile_25th

Human Name: Percentile 25th
Type: number
75% of plans have a rate above this value.

Examples

Retrieve all records with percentile_25th equal to 100:

Retrieve all records where percentile_25th is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(percentile_25th, 47.598177,-122.33448, 1000)

percentile_10th

Human Name: Percentile 10th
Type: number
90% of plans have a rate above this value.

Examples

Retrieve all records with percentile_10th equal to 100:

Retrieve all records where percentile_10th is within 1 kilometer of Seattle, WA (47.598177,-122.33448):

https://health.data.ny.gov/resource/quality-assurance-reporting-requirements-beginning-2008.json?$where=within_circle(percentile_10th, 47.598177,-122.33448, 1000)