Dela via

AIHW MyHospitals (Independent Publisher) (Preview)

  • Reference

The MyHospitals national reporting platform allows users to explore information about their local hospital and Local Hospital Network (LHN), as well as trends across Australia

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Paul Culmsee
URL https://www.sevensigma.com.au
Email paul.culmsee@sevensigma.com.au
Connector Metadata
Publisher Paul Culmsee
Website https://www.aihw.gov.au/reports-data/myhospitals/content/api
Privacy Policy https://www.aihw.gov.au/privacy-policy
Categories Data

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get Brick Codes for Reporting Unit

Gets list of all brick codes available for the specified reporting unit.
Get Caveats

Gets a list of caveats.
Get Data Items for Measure

Gets a list of all data items for the specified measure.
Get Data Items for Reported Measure

Gets a list of all data items for the specified reported measure.
Get Data Items for Reporting Unit

Gets a list of all data items for the specified reporting unit.
Get Dataset Items

Gets a list of data items for a dataset,, optionally filtered, using logical disjunction (OR), by a list of reporting unit codes.
Get Datasets

Gets a list of datasets, optionally filtered by a list of measure and reported measure codes. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND).
Get Dictionary of Reporting Unit Codes and Available Bricks

Gets a dictionary of reporting units codes and their available bricks, for the specified reporting unit type.
Get Flat Data

Gets data in a flattened structure with each item corresponding to a single data point. Data is restricted to within a single measure category and can be optionally filtered by measure, reporting unit type and reporting dates. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND). NOTE: There is currently a pagination restriction on this query that restricts requests to a maximum of 1000 results. Use skip and top to control this pagination. Sorting is not currently available.
Get Flat Formatted Data

Gets formatted data in a flattened structure with each item corresponding to a single data point. Data is restricted to within a single measure category and can be optionally filtered by measure, reporting unit code, reporting unit type and reporting dates. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND). NOTE: There is currently a pagination restriction on this query that restricts requests to a maximum of 1000 results. Use skip and top to control this pagination. Sorting is not currently available.
Get Measure Across Reporting Unit Download

Gets a measure across reporting unit download, in XLSX format, for the supplied measure download code.
Get Measure Categories

Gets a list of measure categories.
Get Measure Download

Gets a measure download, in XLSX format, for the supplied measure download code.
Get Measure Downloads Available

Gets dictionary, indexed by the measure download code, of all available measure download codes and descriptions that can be used in the measure download API call.
Get Measures

Gets list of all measures, optionally filtered, using logical disjunction (OR), by a list of measure category codes.
Get Measures for a Measure Category

Gets a list of measures for the specified measure category code.
Get Measures with Data Available for Reporting Unit

Get list of all measures that have data available for the specified reporting unit.
Get Reported Measure Categories

Gets list of all reported measure categories available.
Get Reported Measure Categories for Measure Category Code

Gets a list reported measure categories matching the supplied reported measure category codes. NOTE: Reported measure codes are not constrained to be unique in the system.
Get Reported Measures

Gets list of reported measures, optionally filtered by a list of measure codes.
Get Reported Measures for Reported Measure Category

Gets a list of all reported measures for a specified reported measure category code.
Get Reporting Unit Data Download

Gets a reporting unit data download, in XLSX format, for the supplied reporting unit code and datasheet code.
Get Reporting Unit Datasheet Codes Available

Gets dictionary, indexed by the datasheet code, of all available reporting unit datasheet codes and descriptions that can be used in the reporting unit download API call.
Get Reporting Unit Mapping Download

Gets the reporting unit mapping download, in XLSX format.
Get Reporting Unit Types

Gets a list of reporting unit types.
Get Reporting Units

Gets list of all reporting units, optionally filtered, using logical disjunction (OR), by a list of reporting unit type codes.
Get Reporting Units Available for Measure

Gets a list of all reporting units that have data available for the specified measure.
Get Simple Download

Gets a simple download, in XLSX format, for the supplied download code.
Get Simple Downloads Available

Gets dictionary, indexed by the simple download code, of all available simple download codes and descriptions that can be used in the simple download API call.
Get Single Caveat

Gets a caveat matching the supplied caveat code.
Get Single Dataset

Gets a single dataset matching the supplied dataset id.
Get Single Measure

Gets a single measure matching the supplied measure code.
Get Single Measure Category

Gets a single measure category matching the supplied measure category code.
Get Single Reported Measure

Gets a single reported measure.
Get Single Reporting Unit

Gets a single reporting unit matching the supplied reporting unit code.
Get Single Reporting Unit Type

Gets a single reporting unit type matching the supplied reporting unit type code.

Get Brick Codes for Reporting Unit

Operation ID:
GetSingleReportingUnitBricks

Gets list of all brick codes available for the specified reporting unit.

Parameters

Name Key Required Type Description
Reporting unit code
 reporting-unit-code True string

The reporting unit code.

Returns

Name Path Type Description
result
 result array of string

result
version_information
 version_information VersionInformation

API Version Information

Get Caveats

Operation ID:
GetCaveats

Gets a list of caveats.

Returns

Name Path Type Description
result
 result array of CaveatModel
version_information
 version_information VersionInformation

API Version Information

Get Data Items for Measure

Operation ID:
GetMeasureDataItems

Gets a list of all data items for the specified measure.

Parameters

Name Key Required Type Description
The measure code
 measure-code True string

The measure code.

Returns

Name Path Type Description
result
 result array of DataItemModel

result
version_information
 version_information VersionInformation

API Version Information

Get Data Items for Reported Measure

Operation ID:
GetSingleReportedMeasureDataItems

Gets a list of all data items for the specified reported measure.

Parameters

Name Key Required Type Description
Reported measure category codes.
 reported-measure-code True string

The reported measure category codes.

Returns

Name Path Type Description
result
 result array of DataItemModel

result
version_information
 version_information VersionInformation

API Version Information

Get Data Items for Reporting Unit

Operation ID:
GetSingleReportingUnitDataitems

Gets a list of all data items for the specified reporting unit.

Parameters

Name Key Required Type Description
Reporting unit code.
 reporting-unit-code True string

The reporting unit code.

Returns

Name Path Type Description
result
 result array of DataItemModel

result
version_information
 version_information VersionInformation

API Version Information

Get Dataset Items

Operation ID:
GetDatasetItems

Gets a list of data items for a dataset,, optionally filtered, using logical disjunction (OR), by a list of reporting unit codes.

Parameters

Name Key Required Type Description
Dataset Id
 dataset-id True string

The dataset Id.
Reporting unit codes
 reporting_unit_code string

The reporting unit codes.

Returns

Name Path Type Description
result
 result array of DataItemModel

result
version_information
 version_information VersionInformation

API Version Information

Get Datasets

Operation ID:
GetDataSets

Gets a list of datasets, optionally filtered by a list of measure and reported measure codes. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND).

Parameters

Name Key Required Type Description
Measure codes
 measure_code string

The measure codes.
The reported measure codes
 reported_measure_code string

The reported measure codes.

Returns

Name Path Type Description
result
 result array of DatasetModel

Get Dictionary of Reporting Unit Codes and Available Bricks

Operation ID:
GetSingleReportUnitTypeBricks

Gets a dictionary of reporting units codes and their available bricks, for the specified reporting unit type.

Parameters

Name Key Required Type Description
Reporting unit type code.
 reporting-unit-type-code True string

The reporting unit type code.

Returns

Name Path Type Description
version_information
 version_information VersionInformation

API Version Information

Get Flat Data

Operation ID:
GetFlatData

Gets data in a flattened structure with each item corresponding to a single data point. Data is restricted to within a single measure category and can be optionally filtered by measure, reporting unit type and reporting dates. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND). NOTE: There is currently a pagination restriction on this query that restricts requests to a maximum of 1000 results. Use skip and top to control this pagination. Sorting is not currently available.

Parameters

Name Key Required Type Description
Measure category code
 measure-category-code True string

Specifies what measure category code the data should belongs to.
Measures
 measure_code string

Only include data that matches the specified measures
Reporting unit type
 reporting_unit_type_code string

Only include data for the specified reporting unit types.
Reporting unit
 reporting_unit_code string

Only include data for the specified reporting units.
Number of records to skip
 skip True integer

The number of records to skip. This is used in the pagination of the data results to determine where to start taking the results from.
Number of records to take
 top True integer

The number of records to take. This is used in the pagination of the data results to determine how many results are retrieved. This value must be between 1 and 1000.
Start date
 start_date string

startDate can be a date of the form yyyy, yyyy-MM or yyyy-MM-dd. When only a year is specified, the search period starts at the beginning of the year, when a year and month are specified, the search period starts at the beginning of the month
End date
 end_date string

endDate can be a date of the form yyyy, yyyy-MM or yyyy-MM-dd. When only a year is specified, the search period ends at the end of the year, when a year and month are specified, the search period ends at the end of the month.

Returns

Name Path Type Description
result
 result PaginatedFormattedDataExtractModel

A paginated results set containing a list of FormattedDataExtract items and the pagination information for the request.
version_information
 version_information VersionInformation

API Version Information

Get Flat Formatted Data

Operation ID:
GetFlatFormattedData

Gets formatted data in a flattened structure with each item corresponding to a single data point. Data is restricted to within a single measure category and can be optionally filtered by measure, reporting unit code, reporting unit type and reporting dates. Matching within each filter is by logical disjunction (OR) and matching across filters is by logical conjunction (AND). NOTE: There is currently a pagination restriction on this query that restricts requests to a maximum of 1000 results. Use skip and top to control this pagination. Sorting is not currently available.

Parameters

Name Key Required Type Description
Measure category code
 measure-category-code True string

Specifies what measure category code the data should belongs to.
Measures
 measure_code string

Only include data that matches the specified measures
Reporting unit type
 reporting_unit_type_code string

Only include data for the specified reporting unit types.
Reporting unit
 reporting_unit_code string

Only include data for the specified reporting units.
Number of records to skip
 skip True integer

The number of records to skip. This is used in the pagination of the data results to determine where to start taking the results from.
Number of records to take
 top True integer

The number of records to take. This is used in the pagination of the data results to determine how many results are retrieved. This value must be between 1 and 1000.
Start date
 start_date string

startDate can be a date of the form yyyy, yyyy-MM or yyyy-MM-dd. When only a year is specified, the search period starts at the beginning of the year, when a year and month are specified, the search period starts at the beginning of the month
End date
 end_date string

endDate can be a date of the form yyyy, yyyy-MM or yyyy-MM-dd. When only a year is specified, the search period ends at the end of the year, when a year and month are specified, the search period ends at the end of the month.

Returns

Name Path Type Description
result
 result PaginatedFormattedDataExtractModel

A paginated results set containing a list of FormattedDataExtract items and the pagination information for the request.
version_information
 version_information VersionInformation

API Version Information

Get Measure Across Reporting Unit Download

Operation ID:
GetMeasureReportingunitDownload

Gets a measure across reporting unit download, in XLSX format, for the supplied measure download code.

Parameters

Name Key Required Type Description
The measure download code
 measure-download-code True string

The measure download code.

Returns

Get Measure Categories

Operation ID:
GetMeasureCategories

Gets a list of measure categories.

Returns

Name Path Type Description
result
 result array of MeasureCategoryModel

result
version_information
 version_information VersionInformation

API Version Information

Get Measure Download

Operation ID:
GetMeasureDownload

Gets a measure download, in XLSX format, for the supplied measure download code.

Parameters

Name Key Required Type Description
The measure download code
 measure-download-code True string

The measure download code.

Returns

Get Measure Downloads Available

Operation ID:
GetMeasureDownloads

Gets dictionary, indexed by the measure download code, of all available measure download codes and descriptions that can be used in the measure download API call.

Returns

Name Path Type Description
results
 results array of object

results
Name
 results.Name string

Name
Details
 results.Details array of DatasheetConfigurationSummaryModel

Details

Get Measures

Operation ID:
GetMeasures

Gets list of all measures, optionally filtered, using logical disjunction (OR), by a list of measure category codes.

Parameters

Name Key Required Type Description
Measure category codes
 measure_category_code string

The measure category codes.

Returns

Name Path Type Description
result
 result array of object

result
measure_categories
 result.measure_categories array of MeasureCategoryModel

measure_categories
measure_code
 result.measure_code string

measure_code
measure_name
 result.measure_name string

measure_name
meta_tags
 result.meta_tags array of MetaTagModel

List of MetaTags applicable to this Measure. This list will be empty if there are no MetaTags.
units
 result.units UnitsModel

Units indicates how data values for a Measure should be expressed.
version_information
 version_information VersionInformation

API Version Information

Get Measures for a Measure Category

Operation ID:
GetSingleMeasureCategoryMeasures

Gets a list of measures for the specified measure category code.

Parameters

Name Key Required Type Description
Measure category code.
 measure-category-code True string

The measure category code.

Returns

Name Path Type Description
result
 result array of MeasureModel

result
version_information
 version_information VersionInformation

API Version Information

Get Measures with Data Available for Reporting Unit

Operation ID:
GetSingleReportingUnitMeasures

Get list of all measures that have data available for the specified reporting unit.

Parameters

Name Key Required Type Description
Reporting unit code
 reporting-unit-code True string

Reporting unit code

Returns

Name Path Type Description
result
 result array of MeasureSummaryModel
version_information
 version_information VersionInformation

API Version Information

Get Reported Measure Categories

Operation ID:
GetReportedMeasureCategories

Gets list of all reported measure categories available.

Returns

Name Path Type Description
result
 result array of ReportedMeasureCategoryModel

result
version_information
 version_information VersionInformation

API Version Information

Get Reported Measure Categories for Measure Category Code

Operation ID:
GetReportedMeasureCategory

Gets a list reported measure categories matching the supplied reported measure category codes. NOTE: Reported measure codes are not constrained to be unique in the system.

Parameters

Name Key Required Type Description
Reported measure category code
 reported-measure-category-code True string

The reported measure category code.

Returns

Name Path Type Description
result
 result ReportedMeasureCategoryModel

A ReportedMeasureCategory provides the method for the disaggregation of a particular Measure and also allows grouping of ReportedMeasures.
version_information
 version_information VersionInformation

API Version Information

Get Reported Measures

Operation ID:
GetReportedMeasures

Gets list of reported measures, optionally filtered by a list of measure codes.

Parameters

Name Key Required Type Description
Measure codes
 measure_code string

The measure codes

Returns

Name Path Type Description
result
 result array of ReportedMeasureModel

result
version_information
 version_information VersionInformation

API Version Information

Get Reported Measures for Reported Measure Category

Operation ID:
GetReportedMeasureCategoryMeasures

Gets a list of all reported measures for a specified reported measure category code.

Parameters

Name Key Required Type Description
Reported Measure Category.
 reported-measure-category-code True string

The Reported Measure Category.

Returns

Name Path Type Description
result
 result array of ReportedMeasureModel
version_information
 version_information VersionInformation

API Version Information

Get Reporting Unit Data Download

Operation ID:
GetsReportingUnitDataDownload

Gets a reporting unit data download, in XLSX format, for the supplied reporting unit code and datasheet code.

Parameters

Name Key Required Type Description
The datasheet code
 datasheet-code True string

The datasheet code
Reporting unit code
 reporting-unit-code True string

The reporting unit code

Returns

Get Reporting Unit Datasheet Codes Available

Operation ID:
GetReportingUnitDatasheetCodes

Gets dictionary, indexed by the datasheet code, of all available reporting unit datasheet codes and descriptions that can be used in the reporting unit download API call.

Returns

Name Path Type Description
result
 result
version_information
 version_information VersionInformation

API Version Information

Get Reporting Unit Mapping Download

Operation ID:
GetReportingUnitMappingDownload

Gets the reporting unit mapping download, in XLSX format.

Returns

Get Reporting Unit Types

Operation ID:
GetReportingUnitTypes

Gets a list of reporting unit types.

Returns

Name Path Type Description
result
 result array of ReportingUnitType

result
version_information
 version_information VersionInformation

API Version Information

Get Reporting Units

Operation ID:
GetReportingUnits

Gets list of all reporting units, optionally filtered, using logical disjunction (OR), by a list of reporting unit type codes.

Parameters

Name Key Required Type Description
Reporting unit type codes
 reporting_unit_type_code string

The reporting unit type codes.

Returns

Name Path Type Description
result
 result array of ReportingUnitModel

result
version_information
 version_information VersionInformation

API Version Information

Get Reporting Units Available for Measure

Operation ID:
GetReportingUnitsForMeasure

Gets a list of all reporting units that have data available for the specified measure.

Parameters

Name Key Required Type Description
Measure codes
 measure-code True string

The measure codes.

Returns

Name Path Type Description
result
 result array of ReportingUnitSummaryModel

result
version_information
 version_information VersionInformation

API Version Information

Get Simple Download

Operation ID:
GetSimpleDownload

Gets a simple download, in XLSX format, for the supplied download code.

Parameters

Name Key Required Type Description
The download code.
 download-code True string

The download code.

Returns

Get Simple Downloads Available

Operation ID:
GetSimpleDownloads

Gets dictionary, indexed by the simple download code, of all available simple download codes and descriptions that can be used in the simple download API call.

Returns

Get Single Caveat

Operation ID:
GetCaveat

Gets a caveat matching the supplied caveat code.

Parameters

Name Key Required Type Description
Caveat code
 caveat-code True string

Caveat code

Returns

Name Path Type Description
result
 result CaveatModel

A Caveat is a footnote or suppression used to apply to, or instead of, a data value.
version_information
 version_information VersionInformation

API Version Information

Get Single Dataset

Operation ID:
GetDataSet

Gets a single dataset matching the supplied dataset id.

Parameters

Name Key Required Type Description
Dataset Id
 dataset-id True integer

The dataset Id.

Returns

Name Path Type Description
result
 result DatasetModel
version_information
 version_information VersionInformation

API Version Information

Get Single Measure

Operation ID:
GetMeasure

Gets a single measure matching the supplied measure code.

Parameters

Name Key Required Type Description
Measure category codes
 measure-code True string

The measure category codes.

Returns

Name Path Type Description
measure_categories
 result.measure_categories array of MeasureCategoryModel

measure_categories
measure_code
 result.measure_code string

measure_code
measure_name
 result.measure_name string

measure_name
meta_tags
 result.meta_tags array of MetaTagModel

List of MetaTags applicable to this Measure. This list will be empty if there are no MetaTags.
units
 result.units UnitsModel

Units indicates how data values for a Measure should be expressed.
version_information
 version_information VersionInformation

API Version Information

Get Single Measure Category

Operation ID:
GetSingleMeasureCategory

Gets a single measure category matching the supplied measure category code.

Parameters

Name Key Required Type Description
Measure category code
 measure-category-code True string

The measure category code.

Returns

Name Path Type Description
result
 result MeasureCategoryModel

A MeasureCategory is used to provide grouping of Measures.
version_information
 version_information VersionInformation

API Version Information

Get Single Reported Measure

Operation ID:
GetSingleReportedMeasure

Gets a single reported measure.

Parameters

Name Key Required Type Description
Reported measure category codes.
 reported-measure-code True string

The reported measure category codes.

Returns

A ReportedMeasure is a disaggregation of a particular Measure. This disaggregation is indicated by 1 or more ReportedMeasureCategories.

Body
ReportedMeasureModel

Get Single Reporting Unit

Operation ID:
GetSingleReportingUnit

Gets a single reporting unit matching the supplied reporting unit code.

Parameters

Name Key Required Type Description
Reporting unit code
 reporting-unit-code True string

The reporting unit code.

Returns

Name Path Type Description
result
 result ReportingUnitModel

A ReportingUnit indicates what unit of analysis a specific data value corresponds to (often a geographical or otherwise bordered area).
version_information
 version_information VersionInformation

API Version Information

Get Single Reporting Unit Type

Operation ID:
GetSingleReportingUnitType

Gets a single reporting unit type matching the supplied reporting unit type code.

Parameters

Name Key Required Type Description
Reporting unit type code.
 reporting-unit-type-code True string

The reporting unit type code.

Returns

Name Path Type Description
result
 result ReportingUnitType

A ReportingUnitType indicates the type for a ReportingUnit and is used to group ReportingUnits.
version_information
 version_information VersionInformation

API Version Information

Definitions

CaveatModel

A Caveat is a footnote or suppression used to apply to, or instead of, a data value.

Name Path Type Description
Caveat Code
 caveat_code string

The code for the corresponding Caveat.
Caveat Display Value
 caveat_display_value string

The display value or symbol for the corresponding Caveat. If the Caveat has no symbol then this field will be null.
Caveat Footnote
 caveat_footnote string

The footnote/explanation text for the corresponding Caveat. If the Caveat has no text then this field will be null.
Caveat Name
 caveat_name string

The name for the corresponding Caveat.

MeasureModel

A Measure is a statistic used to measure something. Some measures are performance indicators (e.g. median waiting times for elective surgery) and some provide context for these indicators (e.g. number of elective surgeries).

Name Path Type Description
measure_categories
 measure_categories array of MeasureCategoryModel

List of MeasureCategories applicable to this Measure.
measure_code
 measure_code string

The code for the corresponding Measure.
measure_name
 measure_name string

The name for the corresponding Measure.
meta_tags
 meta_tags array of MetaTagModel

List of MetaTags applicable to this Measure. This list will be empty if there are no MetaTags.
units
 units UnitsModel

Units indicates how data values for a Measure should be expressed.

MeasureCategoryModel

A MeasureCategory is used to provide grouping of Measures.

Name Path Type Description
measure_category_code
 measure_category_code string

The code for the corresponding MeasureCategory.
measure_category_name
 measure_category_name string

The name for the corresponding MeasureCategory.

ReportedMeasureCategoryTypeModel

The reported measure category type model.

Name Path Type Description
reported_measure_category_type_code
 reported_measure_category_type_code string

The code for the corresponding ReportedMeasureCategoryType
reported_measure_category_type_name
 reported_measure_category_type_name string

The name for the corresponding ReportedMeasureCategoryType.

ReportedMeasureCategoryModel

A ReportedMeasureCategory provides the method for the disaggregation of a particular Measure and also allows grouping of ReportedMeasures.

Name Path Type Description
reported_measure_category_code
 reported_measure_category_code string

The code representing the ReportedMeasureCategory.
reported_measure_category_name
 reported_measure_category_name string

The display text for the ReportedMeasureCategory.
reported_measure_category_type
 reported_measure_category_type ReportedMeasureCategoryTypeModel

The reported measure category type model.

ReportingUnitSummaryModel

A ReportingUnitSummary details the code and name of a ReportingUnit, including a summary of the associated ReportingUnitType.

Name Path Type Description
Reporting Unit Code
 reporting_unit_code string

The code for the corresponding ReportingUnit.
Reporting Unit Name
 reporting_unit_name string

The name for the corresponding ReportingUnit.
reporting_unit_type
 reporting_unit_type ReportingUnitType

A ReportingUnitType indicates the type for a ReportingUnit and is used to group ReportingUnits.

ReportingUnitType

A ReportingUnitType indicates the type for a ReportingUnit and is used to group ReportingUnits.

Name Path Type Description
Reporting Unit Type Code
 reporting_unit_type_code string

The code for the corresponding ReportingUnitType.
Reporting Unit Type Name
 reporting_unit_type_name string

The name for the corresponding ReportingUnitType.

ReportingUnitModel

A ReportingUnit indicates what unit of analysis a specific data value corresponds to (often a geographical or otherwise bordered area).

Name Path Type Description
alternative_names
 alternative_names array of

The list of alternate names for this ReportingUnit. If there are no alternate names then this list will be empty.
ReportingUnit is closed
 closed boolean

Indicates whether this ReportingUnit is closed.
ReportingUnit is private
 private boolean

Indicates whether this ReportingUnit is private, e.g. a private hospital.
ReportingUnit latitude
 latitude float

The latitude for the ReportingUnit. This field may be null if no geographical point is applicable for the ReportingUnit.
ReportingUnit longitude
 longitude float

The longitude for the ReportingUnit. This field may be null if no geographical point is applicable for the ReportingUnit.
mapped_reporting_units
 mapped_reporting_units MappedReportingUnitModel

List of mapped ReportingUnits applicable to this ReportingUnit. This list will be empty if there are no mappings.
meta_tags
 meta_tags array of MetaTagModel

List of MetaTags applicable to this Reporting Unit. This list will be empty if there are no MetaTags.
reporting_unit_code
 reporting_unit_code string

The code for the corresponding ReportingUnit.
reporting_unit_name
 reporting_unit_name string

The name for the corresponding ReportingUnit.
reporting_unit_type
 reporting_unit_type ReportingUnitType

A ReportingUnitType indicates the type for a ReportingUnit and is used to group ReportingUnits.

ReportedMeasureModel

A ReportedMeasure is a disaggregation of a particular Measure. This disaggregation is indicated by 1 or more ReportedMeasureCategories.

Name Path Type Description
measure
 measure MeasureModel

A Measure is a statistic used to measure something. Some measures are performance indicators (e.g. median waiting times for elective surgery) and some provide context for these indicators (e.g. number of elective surgeries).
meta_tags
 meta_tags array of MetaTagModel

List of MetaTags applicable to this Measure. This list will be empty if there are no MetaTags.
reported_measure_categories
 reported_measure_categories array of ReportedMeasureCategoryModel

List of ReportedMeasureCategories applicable to this ReportedMeasure.
reported_measure_code
 reported_measure_code string

The code for the corresponding ReportedMeasure.
reported_measure_name
 reported_measure_name string

The name for the corresponding ReportedMeasure.

MappedReportingUnitModel

List of mapped ReportingUnits applicable to this ReportingUnit. This list will be empty if there are no mappings.

Name Path Type Description
mapped_reporting_unit
 mapped_reporting_unit ReportingUnitSummaryModel

A ReportingUnitSummary details the code and name of a ReportingUnit, including a summary of the associated ReportingUnitType.
Mapped Reporting Unit Code
 map_type.mapped_reporting_unit_code string

The code for the corresponding MappedReportingUnitType
Mapped Reporting Unit Name
 map_type.mapped_reporting_unit_name string

The name for the corresponding MappedReportingUnitType.

UnitsModel

Units indicates how data values for a Measure should be expressed.

Name Path Type Description
decimal_places
 decimal_places integer

The number of decimal places that the data can be expressed to.
units_are_prefix
 units_are_prefix boolean

Whether the units should be applied as a prefix or suffix to the data value. e.g. $ (prefix) and % (suffix).
units_display
 units_display string

The display symbol or text for the units. For units without a symbol this will be null.
units_name
 units_name string

The name for the corresponding Units.

MetaTagTypeModel

A MetaTagType indicates the type for a series of MetaTags and acts as a MetaTag grouping.

Name Path Type Description
Meta Tag Type Code
 meta_tag_type_code string

The code for the corresponding MetaTagType.
Meta Tag Type Code
 meta_tag_type_name string

The name for the corresponding MetaTagType.

MetaTagModel

A MetaTag is a grouping category that can be applied to a Measure, ReportedMeasure, ReportingUnit or DataSet.

Name Path Type Description
Meta Tag Code
 meta_tag_code string

The code representing the MetaTag.
Meta Tag Name
 meta_tag_name string

The display text for the MetaTag.
meta_tag_type
 meta_tag_type MetaTagTypeModel

A MetaTagType indicates the type for a series of MetaTags and acts as a MetaTag grouping.

MeasureSummaryModel

A MeasureSummaryModel details just the code and name of a Measure without any additional fields.

Name Path Type Description
Measure Code
 measure_code string

The code for the corresponding Measure.
Measure Name
 measure_name string

The name for the corresponding Measure.

ReportedMeasureSummaryModel

A ReportedMeasureSummary details the code and name of a ReportedMeasure, including a summary of the associated Measure.

Name Path Type Description
measure_summary
 measure_summary MeasureSummaryModel

A MeasureSummaryModel details just the code and name of a Measure without any additional fields.
Reported Measure Code
 reported_measure_code string

The code for the corresponding ReportedMeasure.
Reported Measure Name
 reported_measure_name string

The name for the corresponding ReportedMeasure.

DatasetModel

Name Path Type Description
caveats
 caveats array of CaveatModel

List of Caveats applicable to this DataSet. This list will be empty if there are no Caveats.
Data Set Id
 data_set_id integer

The id for the DataSet.
Data Set Name
 data_set_name string

The display name for the corresponding DataSet.
meta_tags
 meta_tags array of MetaTagModel

List of MetaTags applicable to this Dataset. This list will be empty if there are no MetaTags.
reported_measure_summary
 reported_measure_summary ReportedMeasureSummaryModel

A ReportedMeasureSummary details the code and name of a ReportedMeasure, including a summary of the associated Measure.
Reporting End Date
 reporting_end_date string

The end date for the DataSet data period.
Reporting Start Date
 reporting_start_date string

The start date for the DataSet data period.

SuppressionModel

Name Path Type Description
Suppression Code
 suppression_code string

The code for the corresponding Suppression
Suppression Display Value
 suppression_display_value string

The display value or symbol for the corresponding Suppression. If the Suppression has no symbol then this field will be null.
Suppression Footnote
 suppression_footnote string

The footnote/explanation text for the corresponding Suppression. If the Suppression has no text then this field will be null.
Suppression Name
 suppression_name string

The name for the corresponding Suppression.

FormattedDataExtractModel

A FormattedDataExtract item is a flattened structure which encapsulates a single DataItem and includes a formatted display value and the DataItem's associated attributes.

Name Path Type Description
caveat
 caveat string

The Caveat symbols applicable to this DataItem. This will be null if there are no Caveats.
caveat_codes
 caveat_codes string

Semi-colon separated list of Caveat codes applicable to this DataItem. This will be null if there are no Caveats.
caveat_footnotes
 caveat_footnotes string

Semi-colon separated list of Caveat symbols and their explanatory footnote applicable to this DataItem. This will be null if there are no Caveats.
data_set_caveat
 data_set_caveat string

The Caveat symbols applicable to the corresponding DataSet. This will be null if there are no Caveats.
data_set_caveat_codes
 data_set_caveat_codes string

Semi-colon separated list of Caveat codes applicable to the corresponding DataSet. This will be null if there are no Caveats.
data_set_caveat_footnotes
 data_set_caveat_footnotes string

Semi-colon separated list of Caveat symbols and their explanatory footnote applicable to the corresponding DataSet. This will be null if there are no Caveats.
data_period
 data_period string

A formatted display of the data period including the start and end dates.
data_period_type
 data_period_type string

A description of the data period type, e.g. FinancialYear.
data_set_id
 data_set_id integer

The id for the corresponding DataSet.
data_set_meta_tag_codes
 data_set_meta_tag_codes string

Semi-colon separated list of MetaTag codes for the corresponding DataSet. This will be null if there are no DataSet MetaTags.
data_set_meta_tags
 data_set_meta_tags string

Semi-colon separated list of MetaTag values for the corresponding DataSet. This will be null if there are no DataSet MetaTags.
data_set_meta_tags_with_type
 data_set_meta_tags_with_type string

Semi-colon separated list of MetaTag values for the corresponding DataSet. Each MetaTag value matches the pattern MetaTagTypeCode|MetaTagValue. This will be null if there are no DataSet MetaTags.
formatted_peer_value
 formatted_peer_value string

A formatted display of the peer data value including any caveats and units. This will be null if there is no peer.
formatted_value
 formatted_value string

A formatted display of the data value including any caveats and units.
group_number
 group_number string

Indicates a quintile, decile or other grouping number for the data value. This will be null if it is not applicable.
private
 private boolean

Indicates whether this ReportingUnit is private, e.g. a private hospital.
mapped_local_hospital_network
 mapped_local_hospital_network string

The LHN name for the corresponding ReportingUnit's associated LHN. This will be null if the ReportingUnit has no mapped LHN.
mapped_primary_health_network
 mapped_primary_health_network string

The PHN name for the corresponding ReportingUnit's associated PHN. This will be null if the ReportingUnit has no mapped PHN.
mapped_state
 mapped_state string

The state abbreviation of the corresponding ReportingUnit's associated state.
measure_category_code
 measure_category_code string

The code for the associated MeasureCategory.
measure_category_name
 measure_category_name string

The name for the associated MeasureCategory.
measure_code
 measure_code string

The code for the associated Measure.
measure_meta_tag_codes
 measure_meta_tag_codes string

Semi-colon separated list of MetaTag codes for the corresponding Measure. This will be null if there are no Measure MetaTags.
measure_meta_tags
 measure_meta_tags string

Semi-colon separated list of MetaTag values for the corresponding Measure. This will be null if there are no Measure MetaTags.
measure_meta_tags_with_type
 measure_meta_tags_with_type string

Semi-colon separated list of MetaTag values for the corresponding Measure. Each MetaTag value matches the pattern MetaTagTypeCode|MetaTagValue. This will be null if there are no Measure MetaTags.
measure_name
 measure_name string

The name for the associated Measure.
peer_group_code
 peer_group_code string

The code for the associated PeerGroup. This will be null if there is no peer.
peer_group_name
 peer_group_name string

The name for the associated PeerGroup. This will be null if there is no peer.
proxy_reporting_unit_name
 proxy_reporting_unit_name string

The name of the proxy reporting unit that reports on behalf of the associated ReportingUnit. This will be null if there is no proxy reporting.
raw_lower_value
 raw_lower_value

Represents the lower data value if this DataItem is a data range or has a confidence interval, otherwise this will be null.
raw_peer_value
 raw_peer_value

The peer data value for this DataItem. This may be null if the peer data is suppressed or there is no peer.
raw_upper_value
 raw_upper_value

Represents the upper data value if this DataItem is a data range or has a confidence interval, otherwise this will be null.
raw_value
 raw_value double

The data value for this item. This data value may be null if the data is suppressed, in which case a caveat will be present in the Caveats list.
reported_measure_category_code
 reported_measure_category_code string

The code for the first ReportedMeasure category.
reported_measure_category_name
 reported_measure_category_name string

The name for the first ReportedMeasure category
reported_measure_category_three_code
 reported_measure_category_three_code string

The code for the third ReportedMeasure category. This will be null if the ReportedMeasure does not have 3 categories.
reported_measure_category_three_name
 reported_measure_category_three_name string

The name for the third ReportedMeasure category. This will be null if the ReportedMeasure does not have 3 categories.
reported_measure_category_two_code
 reported_measure_category_two_code string

The code for the second ReportedMeasure category. This will be null if the ReportedMeasure does not have 2 categories.
reported_measure_category_two_name
 reported_measure_category_two_name string

The name for the second ReportedMeasure category. This will be null if the ReportedMeasure does not have 2 categories.
reported_measure_category_type_code
 reported_measure_category_type_code string

The code for the first ReportedMeasure category.
reported_measure_category_type_name
 reported_measure_category_type_name string

The name for the first ReportedMeasure category type.
reported_measure_category_three_type_code
 reported_measure_category_three_type_code string

The code for the third ReportedMeasure category type. This will be null if the ReportedMeasure does not have 3 categories.
reported_measure_category_three_type_name
 reported_measure_category_three_type_name string

The name for the third ReportedMeasure category type. This will be null if the ReportedMeasure does not have 3 categories.
reported_measure_category_two_type_code
 reported_measure_category_two_type_code string

The code for the second ReportedMeasure category type. This will be null if the ReportedMeasure does not have 2 categories.
reported_measure_category_two_type_name
 reported_measure_category_two_type_name string

The name for the second ReportedMeasure category type. This will be null if the ReportedMeasure does not have 2 categories.
reported_measure_code
 reported_measure_code string

The code for the associated ReportedMeasure.
reported_measure_meta_tag_codes
 reported_measure_meta_tag_codes string

Semi-colon separated list of MetaTag codes for the corresponding ReportedMeasure. This will be null if there are no ReportedMeasure MetaTags.
reported_measure_meta_tags
 reported_measure_meta_tags string

Semi-colon separated list of MetaTag values for the corresponding ReportedMeasure. This will be null if there are no ReportedMeasure MetaTags.
reported_measure_meta_tags_with_type
 reported_measure_meta_tags_with_type string

Semi-colon separated list of MetaTag values for the corresponding ReportedMeasure. Each MetaTag value matches the pattern MetaTagTypeCode|MetaTagValue. This will be null if there are no ReportedMeasure MetaTags.
reported_measure_name
 reported_measure_name string

The name for the associated ReportedMeasure.
reporting_end_date
 reporting_end_date string

The end date for the DataSet data period.
reporting_start_date
 reporting_start_date string

The start date for the DataSet data period.
reporting_unit_code
 reporting_unit_code string

The code for the associated ReportingUnit.
reporting_unit_meta_tag_codes
 reporting_unit_meta_tag_codes string

Semi-colon separated list of MetaTag codes for the corresponding ReportingUnit. This will be null if there are no ReportingUnit MetaTags.
reporting_unit_meta_tags
 reporting_unit_meta_tags string

Semi-colon separated list of MetaTag values for the corresponding ReportingUnit. This will be null if there are no ReportingUnit MetaTags.
reporting_unit_meta_tags_with_type
 reporting_unit_meta_tags_with_type string

Semi-colon separated list of MetaTag values for the corresponding ReportingUnit. Each MetaTag value matches the pattern MetaTagTypeCode|MetaTagValue. This will be null if there are no ReportingUnit MetaTags.
reporting_unit_name
 reporting_unit_name string

The name for the associated ReportingUnit.
reporting_unit_type_code
 reporting_unit_type_code string

The code for the associated ReportingUnitType.
reporting_unit_type_name
 reporting_unit_type_name string

The name for the associated ReportingUnitType.
suppression
 suppression string

The Suppression symbols applicable to this DataItem. This will be null if there are no Suppressions
suppression_codes
 suppression_codes string

Semi-colon separated list of Suppression codes applicable to this DataItem. This will be null if there are no Suppressions.

DataExtractPagination

Provides the pagination details for a paginated results set.

Name Path Type Description
results_returned
 results_returned integer

The number of results returned in this response.
starting_result_index
 starting_result_index integer

The index of the starting result in this list. This corresponds to the skip + 1 from the pagination request.
total_results_available
 total_results_available integer

The total number of results available via pagination.

PaginatedFormattedDataExtractModel

A paginated results set containing a list of FormattedDataExtract items and the pagination information for the request.

Name Path Type Description
data
 data array of FormattedDataExtractModel

The list of FormattedDataExtract items.
pagination
 pagination DataExtractPagination

Provides the pagination details for a paginated results set.

DatasheetConfigurationSummaryModel

A DatasheetConfigurationSummary provides the details of what datasheets are available for generation.

Name Path Type Description
datasheet_code
 datasheet_code string

The code used to specify the datasheet download.
datasheet_description
 datasheet_description string

The description of the datasheet that will be generated using this code.
datasheet_type
 datasheet_type string

The type of datasheet that will be generated using this code.

DataItemModel

A DataItem encapsulates a data value for a specific Unit (ReportingUnit) covering a specific data period (DataSet).

Name Path Type Description
caveats
 caveats array of CaveatModel

List of Caveats applicable to this DataItem. This list will be empty if there are no Caveats.
data_set_id
 data_set_id integer

The id for the associated DataSet.
group_number
 group_number integer

Indicates a quintile, decile or other grouping number for the data value. This will be null if it is not applicable.
lower_value
 lower_value

Represents the lower data value if this DataItem is a data range or has a confidence interval, otherwise this will be null.
measure_code
 measure_code string

The code for the associated Measure.
peer_group_summary
 peer_group_summary ReportingUnitSummaryModel

A ReportingUnitSummary details the code and name of a ReportingUnit, including a summary of the associated ReportingUnitType.
proxy_reporting_unit_summary
 proxy_reporting_unit_summary ReportingUnitSummaryModel

A ReportingUnitSummary details the code and name of a ReportingUnit, including a summary of the associated ReportingUnitType.
reported_measure_code
 reported_measure_code string

The code for the associated ReportedMeasure
reporting_unit_summary
 reporting_unit_summary ReportingUnitSummaryModel

A ReportingUnitSummary details the code and name of a ReportingUnit, including a summary of the associated ReportingUnitType.
suppressions
 suppressions array of SuppressionModel

Gets or sets the suppressions.
Upper Value
 upper_value double

Represents the upper data value if this DataItem is a data range or has a confidence interval, otherwise this will be null.
value
 value double

The data value for this DataItem. This data value may be null if the data is suppressed, in which case a caveat will be present in the Caveats list.

VersionInformation

API Version Information

Name Path Type Description
API Version
 api_version string

Api Version
Data Version
 data_version integer

Data Version
Date Uploaded
 date_uploaded string

The date the data was uploaded
Requested Time Stamp
 requested_time_stamp string

The timestamp of the request