Seal of Illinois

Illinois Hospital Report Card

and Consumer Guide to Health Care

Values

Values hold all the data within our platform. On this page, we will explore various GET endpoints associated with the value model.

The value model

The value model contains all the data that is displayed within the Report Card.

Properties

  • Name
    measure_id
    Type
    int
    Description

    ID of the measure the value belongs to.

  • Name
    entity_id
    Type
    int
    Description

    ID of the entity the value belongs to.

  • Name
    date_start
    Type
    date
    Description

    Start date of the value.

  • Name
    date_end
    Type
    date
    Description

    End date of the value.

  • Name
    value
    Type
    float
    Description

    Value of the measure.

  • Name
    unit
    Type
    string
    Description

    Unit of the measure.

  • Name
    numerator
    Type
    ?int
    Description

    Numerator of the measure.

  • Name
    denominator
    Type
    ?int
    Description

    Denominator of the measure.

  • Name
    sig_var_state
    Type
    ?int
    Description

    State significance variation. -1 - Statistically significantly better or performing at the best possible rate, 0 - Not statistically significantly better or worse, 1 - Statistically significantly worse

  • Name
    lower_ci
    Type
    ?float
    Description

    Lower confidence interval.

  • Name
    upper_ci
    Type
    ?float
    Description

    Upper confidence interval.

GET /api/values

List all values

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

Optional attributes

  • Name
    measure_id
    Type
    int
    Description

    Filter values by measure_id.

  • Name
    entity_id
    Type
    int
    Description

    Filter values by entity_id.

  • Name
    date_start
    Type
    date
    Description

    Filter values by date_start.

  • Name
    date_end
    Type
    date
    Description

    Filter values by date_end.

  • Name
    on
    Type
    date
    Description

    Filter values by date.

  • Name
    value
    Type
    float
    Description

    Filter values by value.

  • Name
    unit
    Type
    string
    Description

    Filter values by unit.

  • Name
    numerator
    Type
    int
    Description

    Filter values by numerator.

  • Name
    denominator
    Type
    int
    Description

    Filter values by denominator.

  • Name
    sig_var_state
    Type
    int
    Description

    Filter values by sig_var_state.

  • Name
    lower_ci
    Type
    float
    Description

    Filter values by lower_ci.

  • Name
    upper_ci
    Type
    float
    Description

    Filter values by upper_ci.

Modifiers

These modifiers can be appended to any numeric filter, date_start, and date_end. Default is =.

  • Name
    __gt
    Type
    modifier
    Description

    Greater than.

  • Name
    __lt
    Type
    modifier
    Description

    Less than.

  • Name
    __gte
    Type
    modifier
    Description

    Greater than or equal to.

  • Name
    __lte
    Type
    modifier
    Description

    Less than or equal to.

  • Name
    __neq
    Type
    modifier
    Description

    Not equal to.

For example, to retrieve values with a value greater than 100, you would use ?value__gt=100. These can be chained to obtain values in a range. For example, you could use you would use ?date_start__gte=2018-01-01&date_start__lte=2018-12-31 to get all values that have a date_start in 2018.

Request

GET
/api/values

Response
GET /api/values/expand

Retrieve an expanded set of values

This endpoint allows you to retrieve the same value information as the normal /api/values endpoint, and includes relevant measure, hospital, and/or ASC information in the response.

All filters and modifiers available in the /api/values endpoint are also available here.

Request

GET
/api/values/expand

Response