Direct data access (API)

The data presented on the MyHospitals pages is available for consumption via an API. This API provides read-only access to the data in both JSON and XLSX formats. Some calls also provide the data in CSV format with more coming in the future. 

What is a web API?

The web API (Application Programming Interface) is an interface that allows us to share data machine to machine across the internet.

This image shows a diagram of how the web API (Application Programming Interface) connects the AIHW to  other locations via the internet including websites, tablets, smart phones, other agencies, NGOs, companies and enterprise apps.

This allows users to retrieve published aggregate data directly from AIHW into their own systems, removing the need to manually download Excels and copy and paste numbers into other spreadsheets. The API allows you to specify just the data you want, and always returns the most up-to-date published data.

The AIHW also uses the API to automatically refresh products with the latest data across multiple locations on our website.

The API supports interoperability and openness, by making data freely available for use within agencies, between agencies, in the private sector and by citizens.

Getting started

The API currently allows you to search for specific data across the MyHospitals national hospital reporting platform. This data provides information about your local hospital, hospitals within your region, state or territory and nationally.

To avoid the need for programming, the API also returns some data in machine readable CSV format and/or XLSX format.

You can see what information is available from the API, and how you can filter and search for specific information, by exploring the interactive home page.

Information types

The API allows access to data organised into the following high-level concepts:

Measures

Measures are statistics used to measure something. Some measures are performance indicators such as median waiting times for elective surgery. Some, such as the number of elective surgeries, provide context for those indicators.

The list of available measures can be accessed from the API here.

Reported measures

Measures can be broken down into different categories or disaggregations. These are referred to as Reported measures and cover a specific subset of data within a measure. For example, Emergency department waiting times for urgent presentations only.

The list of available reported measures can be accessed here.

Reporting units

A Reporting unit indicates what unit of analysis a specific data value corresponds to (often a geographical or otherwise bordered area). Examples of reporting units range from specific hospitals through to Local Hospital Networks and then up to states and national reporting.

The list of available reporting unit types can be accessed here

The specific reporting units can be accessed here.

Data sets

A Data set represents a specific data period for a specific reported measure and is used to group comparable data values. A data period may cover a financial year, like for emergency department waiting times or it may cover a specific Audit period, like for hand hygiene rates.

Within a data set sits a series of Data items, with each data item being specific to a single reporting unit.

Further information

You can see what additional information is available from the API, and how you can filter and search for specific information, by exploring the interactive home page.