Seal of Illinois

Illinois Hospital Report Card

and Consumer Guide to Health Care

Measures

Measures serve as the foundational building blocks within our platform, encapsulating essential data types and facilitating core functionalities. On this page, we will explore various GET endpoints associated with the measure model.

The measure model

The measure model contains all relevant information needed to describe the values that belong to the measure, such as name, description, and rationale.

Properties

  • Name
    measure_id
    Type
    int
    Description

    Unique identifier for the measure.

  • Name
    name
    Type
    string
    Description

    A collection of names for the measure.

  • Name
    description
    Type
    string
    Description

    A collection of descriptions for the measure.

  • Name
    rationale
    Type
    string
    Description

    A collection of rationales for the measure.

  • Name
    author_measure_id
    Type
    string
    Description

    An external identifier for the measure.

  • Name
    evidence
    Type
    string
    Description

    Evidence for the measure. Can be one of: more_is_better, less_is_better, no_evidence, no_difference, within_range_is_better.

  • Name
    measure_type
    Type
    string
    Description

    Type of the measure. Can be one of: process, outcome, access, experience, utilization, structure, population.

  • Name
    default_unit
    Type
    string
    Description

    Default unit for the measure. Can be one of: percent, per 1000, per 100000, cases, ratio, days, hours, patients, dollars, na, minutes, people, square miles, years, households, per 100, per 10000, micrograms, discharges.

GET /api/measures

List all measures

This endpoint allows you to retrieve a paginated list of all measures. By default, a maximum of fifteen measures are shown per page.

Optional attributes

  • Name
    name
    Type
    string
    Description

    Filter measures by name.

  • Name
    description
    Type
    string
    Description

    Filter measures by description.

  • Name
    rationale
    Type
    string
    Description

    Filter measures by rationale.

  • Name
    author_measure_id
    Type
    string
    Description

    Filter measures by author_measure_id.

  • Name
    evidence
    Type
    string
    Description

    Filter measures by evidence type.

  • Name
    default_unit
    Type
    string
    Description

    Filter measures by default_unit.

  • Name
    measure_type
    Type
    string
    Description

    Filter measures by measure_type.

  • Name
    per_page
    Type
    int
    Description

    Set number of records returned per page (max 100).

Request

GET
/api/measures

Response
GET /api/measures/:measure_id

Retrieve a measure

This endpoint allows you to retrieve a measure by providing its measure_id. Refer to the list at the top of this page to see which properties are included with measure objects.

Request

GET
/api/measures/:measure_id

Response
GET /api/measures/:measure_id/values

Retrieve values belonging to a measure

This endpoint allows you to retrieve a values belonging to a specific measure. Refer to the value docs to see which properties are included with value objects, and available filtering options.

Request

GET
/api/measures/:measure_id/values

Response