API Reference
Query
Field | Argument | Type | Description |
---|---|---|---|
data_A | [MeasureDatum_A] | ||
order | [MeasureDatumSortInput_A!] | ||
where | MeasureDatumFilterInput_A | ||
data_B | [MeasureDatum_B!]! |
This query will return a collection of data points. Data can be limited to a specific state. For querying data associated with one or more specific health measures, use the “measures” query. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
state | String |
A U.S. state postal code. Eg. “NY”. For national data use, “ALL”. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. | |
datum_A | [MeasureDatum_A] | ||
metricId | Int! | ||
order | [MeasureDatumSortInput_A!] | ||
where | MeasureDatumFilterInput_A | ||
datum_B | MeasureDatum_B |
This query will return an individual data point. Data can be limited to a specific state. For querying data associated with one or more specific health measures, use the “measures” query. | |
measureDatumId | Int! |
The id of an individual data record. | |
measure_A | Measure_A | ||
metricId | Int! | ||
measure_B | Measure_B |
This query will return an individual measure. You must provide a “measureId” argument to specify which measure you are seeking. | |
measureId | Int! |
The id of an individual measure. | |
measures_A | [Measure_A] | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
measures_B | [Measure_B!]! |
This query will return a collection of measures. Use the “skip” and “take” parameters to paginate the data. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. | |
populationCategories_A | [PopulationCategory_A] | ||
where | PopulationCategoryFilterInput_A | ||
populationCategories_B | [PopulationCategory_B!]! |
This query will return a collection of population categories. Use the “skip” and “take” parameters to paginate the data. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. | |
populationCategory_B | PopulationCategory_B |
This query will return an individual population category, such as “Age”. You must provide a “populationCategoryId” argument to specify which population category you are seeking. | |
populationCategoryId | Int! |
The id of an individual population category. | |
population_A | Population_A | ||
populationId | Int! | ||
population_B | Population_B |
This query will return an individual population. You must provide a “populationId” argument to specify which population you are seeking. | |
populationId | Int! |
The id of an individual population. | |
populations_A | [Population_A] | ||
order | [PopulationSortInput_A!] | ||
where | PopulationFilterInput_A | ||
populations_B | [Population_B!]! |
This query will return a collection of populations. Use the “skip” and “take” parameters to paginate the data. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. | |
reportTypes_A | [ReportType_A] | ||
order | [ReportTypeSortInput_A!] | ||
where | ReportTypeFilterInput_A | ||
report_A | Report_A | ||
editionId | Int! | ||
report_B | Report |
This query will return an individual report. You must provide a “reportId” argument to specify which report you are seeking. | |
reportId | Int! |
The id of an individual report. | |
reports_A | [Report_A] | ||
order | [ReportSortInput_A!] | ||
where | ReportFilterInput_A | ||
reports_B | [Report!]! |
This query will return a collection of reports. Use the “skip” and “take” parameters to paginate the data. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. | |
source_A | Source_A | ||
sourceId | Int! | ||
source_B | Source_B |
This query will return an individual data source. You must provide a “sourceId” argument to specify which population category you are seeking. | |
sourceId | Int! |
The id of an individual source. | |
sources_A | [Source_A] | ||
order | [SourceSortInput_A!] | ||
where | SourceFilterInput_A | ||
sources_B | [Source_B!]! |
This query will return a collection of data sources. Use the “skip” and “take” parameters to paginate the data. | |
skip | Int |
The number of items you would like to skip, useful for pagination of large data sets. | |
take | Int |
The number of items you would like to retrieve, useful for pagination of large data sets. |
Objects
DataNote_B
Field | Argument | Type | Description |
---|---|---|---|
dataNoteId | ID! | ||
measureDatum | MeasureDatum_B | ||
note | String! |
MeasureDataMissingReasonType_A
Field | Argument | Type | Description |
---|---|---|---|
description | String | ||
metricDataMissingReasonTypeId | Int! | ||
metricDataMissings | [MeasureDataMissing_A] | ||
name | String |
MeasureDataMissing_A
Field | Argument | Type | Description |
---|---|---|---|
metricData | MeasureDatum_A | ||
metricDataId | Int! | ||
metricDataMissingId | Int! | ||
metricDataMissingReasonType | MeasureDataMissingReasonType_A | ||
metricDataMissingReasonTypeId | Int! |
MeasureDatum_A
Field | Argument | Type | Description |
---|---|---|---|
dataNotes | [MeasureDataMissingReasonType_A] | ||
order | [MeasureDataMissingReasonTypeSortInput_A!] | ||
where | MeasureDataMissingReasonTypeFilterInput_A | ||
dateLabel | String | ||
endDate | DateTime_A | ||
lowerCI | Float | ||
measure | Measure_A | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
measureDatumId | ID! | ||
rank | Int | ||
score | Float | ||
startDate | DateTime_A | ||
state | String | ||
upperCI | Float | ||
value | Float |
MeasureDatum_B
The data points for a measure.
Field | Argument | Type | Description |
---|---|---|---|
dataNotes | [DataNote_B!] |
Information relevant to the MeasureDatum for instances in which data is not available, suppressed, or has other nuances to be taken into account. | |
dateLabel | String |
The date or time period from which the data is from. | |
endDate | Date |
The end date of the time period of the data. For data from a given year, endDate is set to “1/1/YYYY”. This field is useful for handling date ranges (i.e., startDate - endDate). | |
lowerCI | Float |
The lower 95% confidence interval, where available. Not all measures or data years for a specific measure have confidence intervals available. | |
measure | Measure_B! |
The name of the measure. | |
measureDatumId | ID! |
The ID unique to each data. | |
rank | Int |
The rank of each state’s value by healthiest (1) to least healthy (50). | |
startDate | Date |
The start date of the time period of the data. For data from a given year, startDate is set to “1/1/YYYY”. This field is useful for handling date ranges (i.e., startDate - endDate). | |
state | String |
The two-letter postal code of a state. Note the United States value is labeled as “ALL”. | |
upperCI | Float |
The upper 95% confidence interval, where available. | |
value | Float |
The value for a given measure, state, and data year. |
Measure_A
Field | Argument | Type | Description |
---|---|---|---|
data | [MeasureDatum_A] | ||
order | [MeasureDatumSortInput_A!] | ||
where | MeasureDatumFilterInput_A | ||
description | String | ||
format | String | ||
isWeightPositive | String | ||
measureId | ID! | ||
name | String | ||
population | Population_A | ||
precision | Int | ||
source | Source_A | ||
subpopulations | [Measure_A] | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
unitType | String |
Measure_B
Measures from the America’s Health Rankings platform that are indicators of or associated with population health.
Field | Argument | Type | Description |
---|---|---|---|
data | [MeasureDatum_B!]! |
The data points for the measure. | |
description | String! |
The description of the measure. | |
format | String |
The value type of the measure data value field, such as “Percent”, “Currency”, or “Numeric”. | |
isWeightPositive | String |
Indicates a positive association with health. For example, the measure ‘Exercise’ would return the value “Y” while Smoking would return the value “N”. | |
measureId | ID! |
The ID unique to the measure. Measures with the same ID are comparable over time. | |
name | String! |
The name of the measure. | |
population | Population_B! |
The population that the measure is for, such as “Hispanic” or “Ages 18-24”. | |
precision | Int! |
The precision of the measure data value field, indicating how many decimal places data should be displayed. | |
source | Source_B |
The original source of the measure's data. | |
subpopulations | [Measure_B!]! |
Measures pertaining to slices of the population - subpopulations. Only "root" measures have subpopulations. Note that some subpopulations are treated as root measures in this data set if they are featured in Health of Women and Children or Senior reports. | |
unitType | String! |
The description of the measure’s units, typically a shortened version of description. For example, “Deaths per 100,000 population.” |
PopulationCategory_A
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
populationCategoryId | Int! | ||
populations | [Population_A] | ||
order | [PopulationSortInput_A!] | ||
where | PopulationFilterInput_A |
PopulationCategory_B
The Population Category organizes populations into categories such as race, age, gender, income, and education.
Field | Argument | Type | Description |
---|---|---|---|
name | String! |
The name of the population category. | |
populationCategoryId | ID! |
The ID of the population category. | |
populations | [Population_B!]! |
The populations associated with each category. |
Population_A
Field | Argument | Type | Description |
---|---|---|---|
measures | [Measure_A] | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
name | String | ||
populationCategory | PopulationCategory_A | ||
where | PopulationCategoryFilterInput_A | ||
populationId | ID! |
Population_B
Population describes which segment of the population the measure is describing such as “Hispanic” or “Ages 18-24”. This is a property of subpopulations only.
Field | Argument | Type | Description |
---|---|---|---|
measures | [Measure_B!]! |
The name of the measure. | |
name | String! |
The name of the population. | |
populationCategory | PopulationCategory_B! |
The category of the population group, such as “Race” or “Age”. | |
populationId | ID! |
The ID of the population. |
Report
Field | Argument | Type | Description |
---|---|---|---|
liveOn | Date! |
The Report publish date | |
measures | [Measure_B!]! | ||
name | String! |
The name of the report | |
reportId | ID! |
The ID of the Report | |
reportType | String! |
The type of report | |
slug | String! |
ReportMeasureType_A
Field | Argument | Type | Description |
---|---|---|---|
endDate | DateTime_A | ||
measure | Measure_A | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
measureId | Int! | ||
report | Report_A | ||
order | [ReportSortInput_A!] | ||
where | ReportFilterInput_A | ||
reportId | Int! | ||
weight | Float |
ReportType_A
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
reportTypeId | Int! | ||
reports | [Report_A] | ||
order | [ReportSortInput_A!] | ||
where | ReportFilterInput_A |
Report_A
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
releaseDate | Int! | ||
reportId | Int! | ||
reportMeasures | [ReportMeasureType_A] | ||
order | [ReportMeasureTypeSortInput_A!] | ||
where | ReportMeasureTypeFilterInput_A | ||
reportType | ReportType_A | ||
reportTypeId | Int! |
Source_A
Field | Argument | Type | Description |
---|---|---|---|
measures | [Measure_A] | ||
order | [MeasureSortInput_A!] | ||
where | MeasureFilterInput_A | ||
name | String | ||
sourceId | Int! |
Source_B
The primary Source of the data. All data presented on the America’s Health Rankings platform is secondary data, except for the ‘state rankings’ index measures.
Field | Argument | Type | Description |
---|---|---|---|
measures | [Measure_B!]! |
The name of the measure. | |
name | String! |
The name of the original data source. | |
sourceId | ID! |
The ID of the source. |
Inputs
BooleanOperationFilterInput_A
Field | Type | Description | |
---|---|---|---|
eq | Boolean | ||
neq | Boolean |
ListFilterInputTypeOfMeasureDataMissingFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | MeasureDataMissingFilterInput_A | ||
any | Boolean | ||
none | MeasureDataMissingFilterInput_A | ||
some | MeasureDataMissingFilterInput_A |
ListFilterInputTypeOfMeasureDatumFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | MeasureDatumFilterInput_A | ||
any | Boolean | ||
none | MeasureDatumFilterInput_A | ||
some | MeasureDatumFilterInput_A |
ListFilterInputTypeOfMeasureFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | MeasureFilterInput_A | ||
any | Boolean | ||
none | MeasureFilterInput_A | ||
some | MeasureFilterInput_A |
ListFilterInputTypeOfPopulationFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | PopulationFilterInput_A | ||
any | Boolean | ||
none | PopulationFilterInput_A | ||
some | PopulationFilterInput_A |
ListFilterInputTypeOfReportFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | ReportFilterInput_A | ||
any | Boolean | ||
none | ReportFilterInput_A | ||
some | ReportFilterInput_A |
ListFilterInputTypeOfReportMeasureTypeFilterInput_A
Field | Type | Description | |
---|---|---|---|
all | ReportMeasureTypeFilterInput_A | ||
any | Boolean | ||
none | ReportMeasureTypeFilterInput_A | ||
some | ReportMeasureTypeFilterInput_A |
MeasureDataMissingFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [MeasureDataMissingFilterInput_A!] | ||
metricData | MeasureDatumFilterInput_A | ||
metricDataMissingReasonType | MeasureDataMissingReasonTypeFilterInput_A | ||
or | [MeasureDataMissingFilterInput_A!] |
MeasureDataMissingReasonTypeFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [MeasureDataMissingReasonTypeFilterInput_A!] | ||
description | StringOperationFilterInput_A | ||
metricDataMissings | ListFilterInputTypeOfMeasureDataMissingFilterInput_A | ||
name | StringOperationFilterInput_A | ||
or | [MeasureDataMissingReasonTypeFilterInput_A!] |
MeasureDataMissingReasonTypeSortInput_A
Field | Type | Description | |
---|---|---|---|
description | SortEnumType_A | ||
metricDataMissingReasonTypeId | SortEnumType_A | ||
name | SortEnumType_A |
MeasureDatumFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [MeasureDatumFilterInput_A!] | ||
dataNotes | ListFilterInputTypeOfMeasureDataMissingFilterInput_A | ||
dateLabel | StringOperationFilterInput_A | ||
measure | MeasureFilterInput_A | ||
or | [MeasureDatumFilterInput_A!] | ||
state | StringOperationFilterInput_A |
MeasureDatumSortInput_A
Field | Type | Description | |
---|---|---|---|
dateLabel | SortEnumType_A | ||
endDate | SortEnumType_A | ||
lowerCI | SortEnumType_A | ||
measure | MeasureSortInput_A | ||
measureDatumId | SortEnumType_A | ||
measureId | SortEnumType_A | ||
rank | SortEnumType_A | ||
startDate | SortEnumType_A | ||
state | SortEnumType_A | ||
upperCI | SortEnumType_A | ||
value | SortEnumType_A |
MeasureFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [MeasureFilterInput_A!] | ||
data | ListFilterInputTypeOfMeasureDatumFilterInput_A | ||
description | StringOperationFilterInput_A | ||
format | StringOperationFilterInput_A | ||
isWeightPositive | StringOperationFilterInput_A | ||
name | StringOperationFilterInput_A | ||
or | [MeasureFilterInput_A!] | ||
population | PopulationFilterInput_A | ||
source | SourceFilterInput_A | ||
unitType | StringOperationFilterInput_A |
MeasureSortInput_A
Field | Type | Description | |
---|---|---|---|
description | SortEnumType_A | ||
format | SortEnumType_A | ||
isWeightPositive | SortEnumType_A | ||
measureCategoryId | SortEnumType_A | ||
measureId | SortEnumType_A | ||
name | SortEnumType_A | ||
population | PopulationSortInput_A | ||
populationId | SortEnumType_A | ||
precision | SortEnumType_A | ||
source | SourceSortInput_A | ||
sourceId | SortEnumType_A | ||
unitType | SortEnumType_A |
PopulationCategoryFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [PopulationCategoryFilterInput_A!] | ||
name | StringOperationFilterInput_A | ||
or | [PopulationCategoryFilterInput_A!] | ||
populations | ListFilterInputTypeOfPopulationFilterInput_A |
PopulationFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [PopulationFilterInput_A!] | ||
measures | ListFilterInputTypeOfMeasureFilterInput_A | ||
name | StringOperationFilterInput_A | ||
or | [PopulationFilterInput_A!] | ||
populationCategory | PopulationCategoryFilterInput_A |
PopulationSortInput_A
Field | Type | Description | |
---|---|---|---|
name | SortEnumType_A | ||
populationCategoryId | SortEnumType_A | ||
populationId | SortEnumType_A |
ReportFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [ReportFilterInput_A!] | ||
name | StringOperationFilterInput_A | ||
or | [ReportFilterInput_A!] | ||
reportMeasureTypes | ListFilterInputTypeOfReportMeasureTypeFilterInput_A | ||
reportPath | StringOperationFilterInput_A |
ReportMeasureTypeFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [ReportMeasureTypeFilterInput_A!] | ||
measure | MeasureFilterInput_A | ||
or | [ReportMeasureTypeFilterInput_A!] | ||
report | ReportFilterInput_A |
ReportMeasureTypeSortInput_A
Field | Type | Description | |
---|---|---|---|
endDate | SortEnumType_A | ||
measure | MeasureSortInput_A | ||
measureId | SortEnumType_A | ||
report | ReportSortInput_A | ||
reportId | SortEnumType_A | ||
weight | SortEnumType_A |
ReportSortInput_A
Field | Type | Description | |
---|---|---|---|
name | SortEnumType_A | ||
releaseDate | SortEnumType_A | ||
reportId | SortEnumType_A | ||
reportPath | SortEnumType_A | ||
reportTypeId | SortEnumType_A |
ReportTypeFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [ReportTypeFilterInput_A!] | ||
name | StringOperationFilterInput_A | ||
or | [ReportTypeFilterInput_A!] |
ReportTypeSortInput_A
Field | Type | Description | |
---|---|---|---|
name | SortEnumType_A | ||
reportTypeId | SortEnumType_A |
SourceFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [SourceFilterInput_A!] | ||
metrics | ListFilterInputTypeOfMeasureFilterInput_A | ||
name | StringOperationFilterInput_A | ||
or | [SourceFilterInput_A!] |
SourceSortInput_A
Field | Type | Description | |
---|---|---|---|
name | SortEnumType_A | ||
sourceId | SortEnumType_A |
StringOperationFilterInput_A
Field | Type | Description | |
---|---|---|---|
and | [StringOperationFilterInput_A!] | ||
contains | String | ||
endsWith | String | ||
eq | String | ||
in | [String] | ||
ncontains | String | ||
nendsWith | String | ||
neq | String | ||
nin | [String] | ||
nstartsWith | String | ||
or | [StringOperationFilterInput_A!] | ||
startsWith | String |
Enums
SortEnumType_A
Value | Description |
---|---|
ASC | |
DESC |
Scalars
Boolean
The Boolean
scalar type represents true
or false
.
Date
Date custom scalar type
DateTime_A
The DateTime
scalar represents an ISO-8601 compliant date time type.
Decimal_A
The built-in Decimal
scalar type.
Float
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754 (opens in a new tab).
ID
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
Int
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Long_A
The Long
scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Short_A
The Short
scalar type represents non-fractional signed whole 16-bit numeric values. Short can represent values between -(2^15) and 2^15 - 1.
String
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.