AIHW MyHospitals （独立发布者）（预览版）

MyHospitals 国家报告平台允许用户浏览有关其当地医院和地方医院网络（LHN）的信息，以及澳大利亚各地的趋势

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	保罗·库姆西
URL	https://www.sevensigma.com.au
Email	paul.culmsee@sevensigma.com.au

连接器元数据
发布者	保罗·库姆西
Website	https://www.aihw.gov.au/reports-data/myhospitals/content/api
隐私策略	https://www.aihw.gov.au/privacy-policy
类别	Data

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

获取单一报告单位类型	获取与提供的报表单元类型代码匹配的单个报告单位类型。
获取单个度量值	获取与提供的度量值代码匹配的单个度量值。
获取单个度量值类别	获取与提供的度量值类别代码匹配的单个度量值类别。
获取单个报告单位	获取与提供的报表单元代码匹配的单个报告单元。
获取单个报告度量值	获取单个报告度量值。
获取单个数据集	获取与提供的数据集 ID 匹配的单个数据集。
获取单个注意事项	获取与提供的警告代码匹配的注意事项。
获取可用于度量值的报表单位	获取具有可用于指定度量值的数据的所有报告单位的列表。
获取可用于报告单位的数据的度量值	获取具有可用于指定报告单位的数据的所有度量值的列表。
获取可用的度量值下载	获取由度量值下载代码编制索引的字典，其中包含可用于度量值下载 API 调用的所有可用度量值下载代码和说明。
获取可用的报告单元数据表代码	获取由数据表代码编制索引的字典，其中包含可用于报告单元下载 API 调用的所有可用报表单元数据表代码和说明。
获取可用的简单下载	获取由简单下载代码编制索引的字典，其中包含可用于简单下载 API 调用的所有可用简单下载代码和说明。
获取平面数据	获取平展结构中的数据，每个项对应于单个数据点。数据限制在单个度量值类别内，并且可以选择性地按度量值、报告单位类型和报告日期进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。注意：此查询当前存在分页限制，可将请求限制为最多 1000 个结果。使用 skip 和 top 控制此分页。排序当前不可用。
获取平面格式数据	获取平展结构中的格式化数据，其中包含对应于单个数据点的每个项。数据仅限于单个度量值类别，并且可以根据需要按度量值、报告单位代码、报告单位类型和报告日期进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。注意：此查询当前存在分页限制，可将请求限制为最多 1000 个结果。使用 skip 和 top 控制此分页。排序当前不可用。
获取度量值	按度量值类别代码列表获取所有度量值的列表（（可选）筛选（OR）。
获取度量值下载	获取提供的度量值下载代码的度量值下载，格式为 XLSX。
获取度量值的数据项	获取指定度量值的所有数据项的列表。
获取度量值类别	获取度量值类别的列表。
获取度量值类别代码的报告度量值类别	获取与提供的已报告度量值类别代码匹配的列表报告度量值类别。注意：报告的度量值代码在系统中不受限制为唯一。
获取度量值类别的度量值	获取指定度量值类别代码的度量值列表。
获取报告单位	通过报告单元类型代码的列表，获取所有报告单位的列表（可以选择使用逻辑分解（OR）进行筛选。
获取报告单位类型	获取报告单位类型的列表。
获取报告单元数据下载	获取提供的报表单元代码和数据表代码的 XLSX 格式的报告单元数据下载。
获取报告单元映射下载	获取以 XLSX 格式下载的报告单元映射。
获取报告度量值	获取报告度量值的列表，可以选择按度量值代码列表进行筛选。
获取报告度量值的数据项	获取指定报告度量值的所有数据项的列表。
获取报告度量值类别	获取所有报告度量值类别的列表。
获取报告度量值类别的报告度量值	获取指定报告度量值类别代码的所有报告度量值的列表。
获取报表单元代码和可用砖块的字典	获取指定报告单位类型的报表单位代码及其可用砖块的字典。
获取报表单元的数据项	获取指定报告单元的所有数据项的列表。
获取报表单元的砖块代码	获取可用于指定报告单位的所有砖代码的列表。
获取数据集	获取数据集列表，可以选择按度量值列表和报告度量值代码进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。
获取数据集项	通过报告单元代码的列表，获取数据集的数据项列表，可以选择使用逻辑析构（OR）进行筛选。
获取注意事项	获取注意事项的列表。
获取简单下载	获取提供的下载代码的简单下载，采用 XLSX 格式。
获取跨报表单元的度量值下载	获取所提供度量值下载代码的跨报告单元下载的度量值（采用 XLSX 格式）。

获取单一报告单位类型

操作 ID:: GetSingleReportingUnitType

获取与提供的报表单元类型代码匹配的单个报告单位类型。

参数

名称	密钥	必需	类型	说明
报告单元类型代码。	reporting-unit-type-code	True	string	报告单元类型代码。

名称	路径	类型	说明
结果	result	ReportingUnitType	ReportingUnitType 指示 ReportingUnit 的类型，用于对 ReportingUnit 进行分组。
version_information	version_information	VersionInformation	API 版本信息

获取单个度量值

操作 ID:: GetMeasure

获取与提供的度量值代码匹配的单个度量值。

参数

名称	密钥	必需	类型	说明
度量值类别代码	measure-code	True	string	度量值类别代码。

名称	路径	类型	说明
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	适用于此度量值的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
单位	result.units	UnitsModel	单位指示度量值的数据值应如何表示。
version_information	version_information	VersionInformation	API 版本信息

获取单个度量值类别

操作 ID:: GetSingleMeasureCategory

获取与提供的度量值类别代码匹配的单个度量值类别。

参数

名称	密钥	必需	类型	说明
度量值类别代码	measure-category-code	True	string	度量值类别代码。

名称	路径	类型	说明
结果	result	MeasureCategoryModel	MeasureCategory 用于提供度量值分组。
version_information	version_information	VersionInformation	API 版本信息

获取单个报告单位

操作 ID:: GetSingleReportingUnit

获取与提供的报表单元代码匹配的单个报告单元。

参数

名称	密钥	必需	类型	说明
报告单元代码	reporting-unit-code	True	string	报告单元代码。

名称	路径	类型	说明
结果	result	ReportingUnitModel	ReportingUnit 指示特定数据值所对应的分析单位（通常是地理或其他边界区域）。
version_information	version_information	VersionInformation	API 版本信息

获取单个报告度量值

操作 ID:: GetSingleReportedMeasure

获取单个报告度量值。

参数

名称	密钥	必需	类型	说明
报告度量值类别代码。	reported-measure-code	True	string	报告的度量值类别代码。

ReportedMeasure 是特定度量值的分解。这种分解由 1 个或多个 ReportedMeasureCategories 指示。

Body: ReportedMeasureModel

获取单个数据集

操作 ID:: GetDataSet

获取与提供的数据集 ID 匹配的单个数据集。

参数

名称	密钥	必需	类型	说明
数据集 ID	dataset-id	True	integer	数据集 ID。

名称	路径	类型	说明
结果	result	DatasetModel
version_information	version_information	VersionInformation	API 版本信息

获取单个注意事项

操作 ID:: GetCaveat

获取与提供的警告代码匹配的注意事项。

参数

名称	密钥	必需	类型	说明
警告代码	caveat-code	True	string	警告代码

名称	路径	类型	说明
结果	result	CaveatModel	警告是用于应用于或代替数据值的脚注或抑制。
version_information	version_information	VersionInformation	API 版本信息

获取可用于度量值的报表单位

操作 ID:: GetReportingUnitsForMeasure

获取具有可用于指定度量值的数据的所有报告单位的列表。

参数

名称	密钥	必需	类型	说明
度量值代码	measure-code	True	string	度量值代码。

名称	路径	类型	说明
结果	result	array of ReportingUnitSummaryModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取可用于报告单位的数据的度量值

操作 ID:: GetSingleReportingUnitMeasures

获取具有可用于指定报告单位的数据的所有度量值的列表。

参数

名称	密钥	必需	类型	说明
报告单元代码	reporting-unit-code	True	string	报告单元代码

名称	路径	类型	说明
结果	result	array of MeasureSummaryModel
version_information	version_information	VersionInformation	API 版本信息

获取可用的度量值下载

操作 ID:: GetMeasureDownloads

获取由度量值下载代码编制索引的字典，其中包含可用于度量值下载 API 调用的所有可用度量值下载代码和说明。

名称	路径	类型	说明
results	results	array of object	results
Name	results.Name	string	Name
详细信息	results.Details	array of DatasheetConfigurationSummaryModel	详细信息

获取可用的报告单元数据表代码

操作 ID:: GetReportingUnitDatasheetCodes

获取由数据表代码编制索引的字典，其中包含可用于报告单元下载 API 调用的所有可用报表单元数据表代码和说明。

名称	路径	类型	说明
结果	result
version_information	version_information	VersionInformation	API 版本信息

获取可用的简单下载

操作 ID:: GetSimpleDownloads

获取由简单下载代码编制索引的字典，其中包含可用于简单下载 API 调用的所有可用简单下载代码和说明。

获取平面数据

操作 ID:: GetFlatData

获取平展结构中的数据，每个项对应于单个数据点。数据限制在单个度量值类别内，并且可以选择性地按度量值、报告单位类型和报告日期进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。注意：此查询当前存在分页限制，可将请求限制为最多 1000 个结果。使用 skip 和 top 控制此分页。排序当前不可用。

参数

名称	密钥	必需	类型	说明
度量值类别代码	measure-category-code	True	string	指定数据应属于哪些度量值类别代码。
措施	measure_code		string	仅包含与指定度量值匹配的数据
报告单位类型	reporting_unit_type_code		string	仅包含指定报告单位类型的数据。
报告单位	reporting_unit_code		string	仅包含指定报告单位的数据。
要跳过的记录数	skip	True	integer	要跳过的记录数。这用于数据结果的分页，以确定从何处开始获取结果。
要获取的记录数	top	True	integer	要获取的记录数。这用于数据结果的分页以确定检索的结果数。此值必须介于 1 到 1000 之间。
开始日期	start_date		string	startDate 可以是 yyyy、y-MM 或 yyyy-MM-dd 形式的日期。仅指定一年时，搜索周期从年初开始，当指定一年和月份时，搜索周期从本月初开始
结束日期	end_date		string	endDate 可以是 yyyy、y-MM 或 yyyy-MM-dd 形式的日期。如果仅指定了一年，则搜索期将在年底结束，当指定了一年和一个月时，搜索周期将在月底结束。

名称	路径	类型	说明
结果	result	PaginatedFormattedDataExtractModel	分页结果集，其中包含 FormattedDataExtract 项的列表和请求的分页信息。
version_information	version_information	VersionInformation	API 版本信息

获取平面格式数据

操作 ID:: GetFlatFormattedData

获取平展结构中的格式化数据，其中包含对应于单个数据点的每个项。数据仅限于单个度量值类别，并且可以根据需要按度量值、报告单位代码、报告单位类型和报告日期进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。注意：此查询当前存在分页限制，可将请求限制为最多 1000 个结果。使用 skip 和 top 控制此分页。排序当前不可用。

参数

名称	密钥	必需	类型	说明
度量值类别代码	measure-category-code	True	string	指定数据应属于哪些度量值类别代码。
措施	measure_code		string	仅包含与指定度量值匹配的数据
报告单位类型	reporting_unit_type_code		string	仅包含指定报告单位类型的数据。
报告单位	reporting_unit_code		string	仅包含指定报告单位的数据。
要跳过的记录数	skip	True	integer	要跳过的记录数。这用于数据结果的分页，以确定从何处开始获取结果。
要获取的记录数	top	True	integer	要获取的记录数。这用于数据结果的分页以确定检索的结果数。此值必须介于 1 到 1000 之间。
开始日期	start_date		string	startDate 可以是 yyyy、y-MM 或 yyyy-MM-dd 形式的日期。仅指定一年时，搜索周期从年初开始，当指定一年和月份时，搜索周期从本月初开始
结束日期	end_date		string	endDate 可以是 yyyy、y-MM 或 yyyy-MM-dd 形式的日期。如果仅指定了一年，则搜索期将在年底结束，当指定了一年和一个月时，搜索周期将在月底结束。

名称	路径	类型	说明
结果	result	PaginatedFormattedDataExtractModel	分页结果集，其中包含 FormattedDataExtract 项的列表和请求的分页信息。
version_information	version_information	VersionInformation	API 版本信息

获取度量值

操作 ID:: GetMeasures

按度量值类别代码列表获取所有度量值的列表（（可选）筛选（OR）。

参数

名称	密钥	必需	类型	说明
度量值类别代码	measure_category_code		string	度量值类别代码。

名称	路径	类型	说明
结果	result	array of object	结果
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	适用于此度量值的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
单位	result.units	UnitsModel	单位指示度量值的数据值应如何表示。
version_information	version_information	VersionInformation	API 版本信息

获取度量值下载

操作 ID:: GetMeasureDownload

获取提供的度量值下载代码的度量值下载，格式为 XLSX。

参数

名称	密钥	必需	类型	说明
度量值下载代码	measure-download-code	True	string	度量值下载代码。

获取度量值的数据项

操作 ID:: GetMeasureDataItems

获取指定度量值的所有数据项的列表。

参数

名称	密钥	必需	类型	说明
度量值代码	measure-code	True	string	度量值代码。

名称	路径	类型	说明
结果	result	array of DataItemModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取度量值类别

操作 ID:: GetMeasureCategories

获取度量值类别的列表。

名称	路径	类型	说明
结果	result	array of MeasureCategoryModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取度量值类别代码的报告度量值类别

操作 ID:: GetReportedMeasureCategory

获取与提供的已报告度量值类别代码匹配的列表报告度量值类别。注意：报告的度量值代码在系统中不受限制为唯一。

参数

名称	密钥	必需	类型	说明
报告度量值类别代码	reported-measure-category-code	True	string	报告的度量值类别代码。

名称	路径	类型	说明
结果	result	ReportedMeasureCategoryModel	ReportedMeasureCategory 提供了特定度量值的分类方法，还允许对 ReportedMeasures 进行分组。
version_information	version_information	VersionInformation	API 版本信息

获取度量值类别的度量值

操作 ID:: GetSingleMeasureCategoryMeasures

获取指定度量值类别代码的度量值列表。

参数

名称	密钥	必需	类型	说明
度量类别代码。	measure-category-code	True	string	度量值类别代码。

名称	路径	类型	说明
结果	result	array of MeasureModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告单位

操作 ID:: GetReportingUnits

通过报告单元类型代码的列表，获取所有报告单位的列表（可以选择使用逻辑分解（OR）进行筛选。

参数

名称	密钥	必需	类型	说明
报告单位类型代码	reporting_unit_type_code		string	报告单位类型代码。

名称	路径	类型	说明
结果	result	array of ReportingUnitModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告单位类型

操作 ID:: GetReportingUnitTypes

获取报告单位类型的列表。

名称	路径	类型	说明
结果	result	array of ReportingUnitType	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告单元数据下载

操作 ID:: GetsReportingUnitDataDownload

获取提供的报表单元代码和数据表代码的 XLSX 格式的报告单元数据下载。

参数

名称	密钥	必需	类型	说明
数据表代码	datasheet-code	True	string	数据表代码
报告单元代码	reporting-unit-code	True	string	报告单元代码

获取报告单元映射下载

操作 ID:: GetReportingUnitMappingDownload

获取以 XLSX 格式下载的报告单元映射。

获取报告度量值

操作 ID:: GetReportedMeasures

获取报告度量值的列表，可以选择按度量值代码列表进行筛选。

参数

名称	密钥	必需	类型	说明
度量值代码	measure_code		string	度量值代码

名称	路径	类型	说明
结果	result	array of ReportedMeasureModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告度量值的数据项

操作 ID:: GetSingleReportedMeasureDataItems

获取指定报告度量值的所有数据项的列表。

参数

名称	密钥	必需	类型	说明
报告度量值类别代码。	reported-measure-code	True	string	报告的度量值类别代码。

名称	路径	类型	说明
结果	result	array of DataItemModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告度量值类别

操作 ID:: GetReportedMeasureCategories

获取所有报告度量值类别的列表。

名称	路径	类型	说明
结果	result	array of ReportedMeasureCategoryModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报告度量值类别的报告度量值

操作 ID:: GetReportedMeasureCategoryMeasures

获取指定报告度量值类别代码的所有报告度量值的列表。

参数

名称	密钥	必需	类型	说明
报告度量值类别。	reported-measure-category-code	True	string	报告的度量值类别。

名称	路径	类型	说明
结果	result	array of ReportedMeasureModel
version_information	version_information	VersionInformation	API 版本信息

获取报表单元代码和可用砖块的字典

操作 ID:: GetSingleReportUnitTypeBricks

获取指定报告单位类型的报表单位代码及其可用砖块的字典。

参数

名称	密钥	必需	类型	说明
报告单元类型代码。	reporting-unit-type-code	True	string	报告单元类型代码。

名称	路径	类型	说明
version_information	version_information	VersionInformation	API 版本信息

获取报表单元的数据项

操作 ID:: GetSingleReportingUnitDataitems

获取指定报告单元的所有数据项的列表。

参数

名称	密钥	必需	类型	说明
报告单元代码。	reporting-unit-code	True	string	报告单元代码。

名称	路径	类型	说明
结果	result	array of DataItemModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取报表单元的砖块代码

操作 ID:: GetSingleReportingUnitBricks

获取可用于指定报告单位的所有砖代码的列表。

参数

名称	密钥	必需	类型	说明
报告单元代码	reporting-unit-code	True	string	报告单元代码。

名称	路径	类型	说明
结果	result	array of string	结果
version_information	version_information	VersionInformation	API 版本信息

获取数据集

操作 ID:: GetDataSets

获取数据集列表，可以选择按度量值列表和报告度量值代码进行筛选。每个筛选器中的匹配由逻辑分解（OR）进行，并且跨筛选器的匹配由逻辑结合（AND）进行。

参数

名称	密钥	必需	类型	说明
度量值代码	measure_code		string	度量值代码。
报告的度量值代码	reported_measure_code		string	报告的度量值代码。

名称	路径	类型	说明
结果	result	array of DatasetModel

获取数据集项

操作 ID:: GetDatasetItems

通过报告单元代码的列表，获取数据集的数据项列表，可以选择使用逻辑析构（OR）进行筛选。

参数

名称	密钥	必需	类型	说明
数据集 ID	dataset-id	True	string	数据集 ID。
报告单元代码	reporting_unit_code		string	报告单元代码。

名称	路径	类型	说明
结果	result	array of DataItemModel	结果
version_information	version_information	VersionInformation	API 版本信息

获取注意事项

操作 ID:: GetCaveats

获取注意事项的列表。

名称	路径	类型	说明
结果	result	array of CaveatModel
version_information	version_information	VersionInformation	API 版本信息

获取简单下载

操作 ID:: GetSimpleDownload

获取提供的下载代码的简单下载，采用 XLSX 格式。

参数

名称	密钥	必需	类型	说明
下载代码。	download-code	True	string	下载代码。

获取跨报表单元的度量值下载

操作 ID:: GetMeasureReportingunitDownload

获取所提供度量值下载代码的跨报告单元下载的度量值（采用 XLSX 格式）。

参数

名称	密钥	必需	类型	说明
度量值下载代码	measure-download-code	True	string	度量值下载代码。

定义

CaveatModel

警告是用于应用于或代替数据值的脚注或抑制。

名称	路径	类型	说明
警告代码	caveat_code	string	相应注意事项的代码。
警告显示值	caveat_display_value	string	相应注意事项的显示值或符号。如果警告没有符号，则此字段将为 null。
注意脚注	caveat_footnote	string	相应注意事项的脚注/说明文本。如果警告没有文本，则此字段将为 null。
警告名称	caveat_name	string	相应警告的名称。

MeasureModel

度量值是用于度量某些内容的统计信息。一些度量值是绩效指标（例如选择性手术的等待时间中值），一些指标为这些指标（例如选择性手术的数量）提供了背景。

名称	路径	类型	说明
measure_categories	measure_categories	array of MeasureCategoryModel	适用于此度量值的 MeasureCategories 列表。
measure_code	measure_code	string	相应度量值的代码。
measure_name	measure_name	string	相应度量值的名称。
meta_tags	meta_tags	array of MetaTagModel	适用于此度量值的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
单位	units	UnitsModel	单位指示度量值的数据值应如何表示。

MeasureCategoryModel

MeasureCategory 用于提供度量值分组。

名称	路径	类型	说明
measure_category_code	measure_category_code	string	相应 MeasureCategory 的代码。
measure_category_name	measure_category_name	string	相应 MeasureCategory 的名称。

ReportedMeasureCategoryTypeModel

报告的度量值类别类型模型。

名称	路径	类型	说明
reported_measure_category_type_code	reported_measure_category_type_code	string	相应的 ReportedMeasureCategoryType 的代码
reported_measure_category_type_name	reported_measure_category_type_name	string	相应的 ReportedMeasureCategoryType 的名称。

ReportedMeasureCategoryModel

ReportedMeasureCategory 提供了特定度量值的分类方法，还允许对 ReportedMeasures 进行分组。

名称	路径	类型	说明
reported_measure_category_code	reported_measure_category_code	string	表示 ReportedMeasureCategory 的代码。
reported_measure_category_name	reported_measure_category_name	string	ReportedMeasureCategory 的显示文本。
reported_measure_category_type	reported_measure_category_type	ReportedMeasureCategoryTypeModel	报告的度量值类别类型模型。

ReportingUnitSummaryModel

ReportingUnitSummary 详细说明 ReportingUnit 的代码和名称，包括关联的 ReportingUnitType 的摘要。

名称	路径	类型	说明
报告单元代码	reporting_unit_code	string	相应 ReportingUnit 的代码。
报告单位名称	reporting_unit_name	string	相应 ReportingUnit 的名称。
reporting_unit_type	reporting_unit_type	ReportingUnitType	ReportingUnitType 指示 ReportingUnit 的类型，用于对 ReportingUnit 进行分组。

ReportingUnitType

ReportingUnitType 指示 ReportingUnit 的类型，用于对 ReportingUnit 进行分组。

名称	路径	类型	说明
报告单元类型代码	reporting_unit_type_code	string	相应 ReportingUnitType 的代码。
报告单位类型名称	reporting_unit_type_name	string	相应的 ReportingUnitType 的名称。

ReportingUnitModel

ReportingUnit 指示特定数据值所对应的分析单位（通常是地理或其他边界区域）。

名称	路径	类型	说明
alternative_names	alternative_names	array of	此 ReportingUnit 的备用名称列表。如果没有备用名称，则此列表将为空。
ReportingUnit 已关闭	closed	boolean	指示此 ReportingUnit 是否已关闭。
ReportingUnit 是专用的	private	boolean	指示此 ReportingUnit 是否是私人的，例如私立医院。
ReportingUnit 纬度	latitude	float	ReportingUnit 的纬度。如果没有地理点适用于 ReportingUnit，则此字段可能为 null。
ReportingUnit 经度	longitude	float	ReportingUnit 的经度。如果没有地理点适用于 ReportingUnit，则此字段可能为 null。
mapped_reporting_units	mapped_reporting_units	MappedReportingUnitModel	适用于此 ReportingUnit 的映射 ReportingUnit 的列表。如果没有映射，此列表将为空。
meta_tags	meta_tags	array of MetaTagModel	适用于此报告单元的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
reporting_unit_code	reporting_unit_code	string	相应 ReportingUnit 的代码。
reporting_unit_name	reporting_unit_name	string	相应 ReportingUnit 的名称。
reporting_unit_type	reporting_unit_type	ReportingUnitType	ReportingUnitType 指示 ReportingUnit 的类型，用于对 ReportingUnit 进行分组。

ReportedMeasureModel

ReportedMeasure 是特定度量值的分解。这种分解由 1 个或多个 ReportedMeasureCategories 指示。

名称	路径	类型	说明
度量值	measure	MeasureModel	度量值是用于度量某些内容的统计信息。一些度量值是绩效指标（例如选择性手术的等待时间中值），一些指标为这些指标（例如选择性手术的数量）提供了背景。
meta_tags	meta_tags	array of MetaTagModel	适用于此度量值的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
reported_measure_categories	reported_measure_categories	array of ReportedMeasureCategoryModel	适用于此 ReportedMeasure 的 ReportedMeasureCategories 列表。
reported_measure_code	reported_measure_code	string	相应 ReportedMeasure 的代码。
reported_measure_name	reported_measure_name	string	相应 ReportedMeasure 的名称。

MappedReportingUnitModel

适用于此 ReportingUnit 的映射 ReportingUnit 的列表。如果没有映射，此列表将为空。

名称	路径	类型	说明
mapped_reporting_unit	mapped_reporting_unit	ReportingUnitSummaryModel	ReportingUnitSummary 详细说明 ReportingUnit 的代码和名称，包括关联的 ReportingUnitType 的摘要。
映射的报告单元代码	map_type.mapped_reporting_unit_code	string	对应 MappedReportingUnitType 的代码
映射的报告单位名称	map_type.mapped_reporting_unit_name	string	对应 MappedReportingUnitType 的名称。

UnitsModel

单位指示度量值的数据值应如何表示。

名称	路径	类型	说明
decimal_places	decimal_places	integer	可以表示数据的小数位数。
units_are_prefix	units_are_prefix	boolean	是否应将单元作为前缀或后缀应用于数据值。例如 $ （prefix）和 % （后缀）。
units_display	units_display	string	单位的显示符号或文本。对于没有符号的单位，这将为 null。
units_name	units_name	string	相应单位的名称。

MetaTagTypeModel

MetaTagType 指示一系列 MetaTag 的类型，并充当 MetaTag 分组。

名称	路径	类型	说明
元标记类型代码	meta_tag_type_code	string	相应 MetaTagType 的代码。
元标记类型代码	meta_tag_type_name	string	相应 MetaTagType 的名称。

MetaTagModel

MetaTag 是一个分组类别，可应用于 Measure、ReportingMeasure、ReportingUnit 或 DataSet。

名称	路径	类型	说明
元标记代码	meta_tag_code	string	表示 MetaTag 的代码。
元标记名称	meta_tag_name	string	MetaTag 的显示文本。
meta_tag_type	meta_tag_type	MetaTagTypeModel	MetaTagType 指示一系列 MetaTag 的类型，并充当 MetaTag 分组。

MeasureSummaryModel

MeasureSummaryModel 仅详细说明了 Measure 的代码和名称，而无需任何其他字段。

名称	路径	类型	说明
度量值代码	measure_code	string	相应度量值的代码。
度量值名称	measure_name	string	相应度量值的名称。

ReportedMeasureSummaryModel

ReportedMeasureSummary 详细说明了 ReportedMeasure 的代码和名称，包括关联度量值的摘要。

名称	路径	类型	说明
measure_summary	measure_summary	MeasureSummaryModel	MeasureSummaryModel 仅详细说明了 Measure 的代码和名称，而无需任何其他字段。
报告度量值代码	reported_measure_code	string	相应 ReportedMeasure 的代码。
报告度量值名称	reported_measure_name	string	相应 ReportedMeasure 的名称。

DatasetModel

名称	路径	类型	说明
警告	caveats	array of CaveatModel	适用于此数据集的注意事项列表。如果没有警告，此列表将为空。
数据集 ID	data_set_id	integer	数据集的 ID。
数据集名称	data_set_name	string	相应数据集的显示名称。
meta_tags	meta_tags	array of MetaTagModel	适用于此数据集的 MetaTag 列表。如果没有 MetaTag，此列表将为空。
reported_measure_summary	reported_measure_summary	ReportedMeasureSummaryModel	ReportedMeasureSummary 详细说明了 ReportedMeasure 的代码和名称，包括关联度量值的摘要。
报告结束日期	reporting_end_date	string	数据集数据周期的结束日期。
报告开始日期	reporting_start_date	string	数据集数据周期的开始日期。

SuppressionModel

名称	路径	类型	说明
抑制代码	suppression_code	string	相应抑制的代码
抑制显示值	suppression_display_value	string	相应抑制的显示值或符号。如果“抑制”没有符号，则此字段将为 null。
抑制脚注	suppression_footnote	string	相应抑制的脚注/说明文本。如果“抑制”没有文本，则此字段将为 null。
抑制名称	suppression_name	string	相应抑制的名称。

FormattedDataExtractModel

FormattedDataExtract 项是一种平展结构，它封装单个 DataItem，并包括格式化的显示值和 DataItem 的关联属性。

名称	路径	类型	说明
警告	caveat	string	适用于此 DataItem 的注意事项符号。如果没有警告，则为 null。
caveat_codes	caveat_codes	string	适用于此 DataItem 的警告代码的分号分隔列表。如果没有警告，则为 null。
caveat_footnotes	caveat_footnotes	string	分号分隔的注意事项符号列表及其适用于此 DataItem 的解释脚注。如果没有警告，则为 null。
data_set_caveat	data_set_caveat	string	适用于相应数据集的注意事项符号。如果没有警告，则为 null。
data_set_caveat_codes	data_set_caveat_codes	string	适用于相应数据集的警告代码的分号分隔列表。如果没有警告，则为 null。
data_set_caveat_footnotes	data_set_caveat_footnotes	string	分号分隔的注意事项符号列表及其适用于相应数据集的解释脚注。如果没有警告，则为 null。
data_period	data_period	string	数据周期（包括开始日期和结束日期）的格式显示。
data_period_type	data_period_type	string	数据周期类型的说明，例如 FinancialYear。
data_set_id	data_set_id	integer	相应数据集的 ID。
data_set_meta_tag_codes	data_set_meta_tag_codes	string	对应数据集的 MetaTag 代码的分号分隔列表。如果没有 DataSet MetaTag，则此值将为 null。
data_set_meta_tags	data_set_meta_tags	string	对应数据集的 MetaTag 值的分号分隔列表。如果没有 DataSet MetaTag，则此值将为 null。
data_set_meta_tags_with_type	data_set_meta_tags_with_type	string	对应数据集的 MetaTag 值的分号分隔列表。每个 MetaTag 值匹配模式 MetaTagTypeCode \|MetaTagValue。如果没有 DataSet MetaTag，则此值将为 null。
formatted_peer_value	formatted_peer_value	string	对等数据值的格式化显示，包括任何注意事项和单位。如果没有对等方，则为 null。
formatted_value	formatted_value	string	数据值的格式化显示，包括任何注意事项和单位。
group_number	group_number	string	指示数据值的五位数、十分位数或其他分组编号。如果不适用，则为 null。
专用	private	boolean	指示此 ReportingUnit 是否是私人的，例如私立医院。
mapped_local_hospital_network	mapped_local_hospital_network	string	对应 ReportingUnit 的关联 LHN 的 LHN 名称。如果 ReportingUnit 没有映射的 LHN，则为 null。
mapped_primary_health_network	mapped_primary_health_network	string	相应 ReportingUnit 关联 PHN 的 PHN 的 PHN 名称。如果 ReportingUnit 没有映射的 PHN，则为 null。
mapped_state	mapped_state	string	相应 ReportingUnit 关联状态的状态缩写。
measure_category_code	measure_category_code	string	关联的 MeasureCategory 的代码。
measure_category_name	measure_category_name	string	关联的 MeasureCategory 的名称。
measure_code	measure_code	string	关联的度量值的代码。
measure_meta_tag_codes	measure_meta_tag_codes	string	对应 Measure 的 MetaTag 代码的分号分隔列表。如果没有 Measure MetaTag，则为 null。
measure_meta_tags	measure_meta_tags	string	对应 Measure 的 MetaTag 值的分号分隔列表。如果没有 Measure MetaTag，则为 null。
measure_meta_tags_with_type	measure_meta_tags_with_type	string	对应 Measure 的 MetaTag 值的分号分隔列表。每个 MetaTag 值匹配模式 MetaTagTypeCode \|MetaTagValue。如果没有 Measure MetaTag，则为 null。
measure_name	measure_name	string	关联的度量值的名称。
peer_group_code	peer_group_code	string	关联的 PeerGroup 的代码。如果没有对等方，则为 null。
peer_group_name	peer_group_name	string	关联的 PeerGroup 的名称。如果没有对等方，则为 null。
proxy_reporting_unit_name	proxy_reporting_unit_name	string	代表关联的 ReportingUnit 报告的代理报告单位的名称。如果没有代理报告，则为 null。
raw_lower_value	raw_lower_value		如果此 DataItem 是数据范围或置信区间，则表示较低的数据值，否则为 null。
raw_peer_value	raw_peer_value		此 DataItem 的对等数据值。如果取消对等数据或没有对等数据，则这可能是 null。
raw_upper_value	raw_upper_value		如果此 DataItem 是数据范围或置信区间，则表示高数据值，否则为 null。
raw_value	raw_value	double	此项的数据值。如果取消数据，则此数据值可能为 null，在这种情况下，警告将在“注意事项”列表中显示。
reported_measure_category_code	reported_measure_category_code	string	第一个 ReportedMeasure 类别的代码。
reported_measure_category_name	reported_measure_category_name	string	第一个 ReportedMeasure 类别的名称
reported_measure_category_three_code	reported_measure_category_three_code	string	第三个 ReportedMeasure 类别的代码。如果 ReportedMeasure 没有 3 个类别，则为 null。
reported_measure_category_three_name	reported_measure_category_three_name	string	第三个 ReportedMeasure 类别的名称。如果 ReportedMeasure 没有 3 个类别，则为 null。
reported_measure_category_two_code	reported_measure_category_two_code	string	第二个 ReportedMeasure 类别的代码。如果 ReportedMeasure 没有 2 个类别，则为 null。
reported_measure_category_two_name	reported_measure_category_two_name	string	第二个 ReportedMeasure 类别的名称。如果 ReportedMeasure 没有 2 个类别，则为 null。
reported_measure_category_type_code	reported_measure_category_type_code	string	第一个 ReportedMeasure 类别的代码。
reported_measure_category_type_name	reported_measure_category_type_name	string	第一个 ReportedMeasure 类别类型的名称。
reported_measure_category_three_type_code	reported_measure_category_three_type_code	string	第三个 ReportedMeasure 类别类型的代码。如果 ReportedMeasure 没有 3 个类别，则为 null。
reported_measure_category_three_type_name	reported_measure_category_three_type_name	string	第三个 ReportedMeasure 类别类型的名称。如果 ReportedMeasure 没有 3 个类别，则为 null。
reported_measure_category_two_type_code	reported_measure_category_two_type_code	string	第二个 ReportedMeasure 类别类型的代码。如果 ReportedMeasure 没有 2 个类别，则为 null。
reported_measure_category_two_type_name	reported_measure_category_two_type_name	string	第二个 ReportedMeasure 类别类型的名称。如果 ReportedMeasure 没有 2 个类别，则为 null。
reported_measure_code	reported_measure_code	string	关联的 ReportedMeasure 的代码。
reported_measure_meta_tag_codes	reported_measure_meta_tag_codes	string	相应 ReportedMeasure 的 MetaTag 代码的分号分隔列表。如果没有 ReportedMeasure MetaTag，则为 null。
reported_measure_meta_tags	reported_measure_meta_tags	string	相应的 ReportedMeasure 的 MetaTag 值的分号分隔列表。如果没有 ReportedMeasure MetaTag，则为 null。
reported_measure_meta_tags_with_type	reported_measure_meta_tags_with_type	string	相应的 ReportedMeasure 的 MetaTag 值的分号分隔列表。每个 MetaTag 值匹配模式 MetaTagTypeCode \|MetaTagValue。如果没有 ReportedMeasure MetaTag，则为 null。
reported_measure_name	reported_measure_name	string	关联的 ReportedMeasure 的名称。
reporting_end_date	reporting_end_date	string	数据集数据周期的结束日期。
reporting_start_date	reporting_start_date	string	数据集数据周期的开始日期。
reporting_unit_code	reporting_unit_code	string	关联的 ReportingUnit 的代码。
reporting_unit_meta_tag_codes	reporting_unit_meta_tag_codes	string	相应 ReportingUnit 的 MetaTag 代码的分号分隔列表。如果没有 ReportingUnit MetaTag，则为 null。
reporting_unit_meta_tags	reporting_unit_meta_tags	string	相应 ReportingUnit 的 MetaTag 值的分号分隔列表。如果没有 ReportingUnit MetaTag，则为 null。
reporting_unit_meta_tags_with_type	reporting_unit_meta_tags_with_type	string	相应 ReportingUnit 的 MetaTag 值的分号分隔列表。每个 MetaTag 值匹配模式 MetaTagTypeCode \|MetaTagValue。如果没有 ReportingUnit MetaTag，则为 null。
reporting_unit_name	reporting_unit_name	string	关联的 ReportingUnit 的名称。
reporting_unit_type_code	reporting_unit_type_code	string	关联的 ReportingUnitType 的代码。
reporting_unit_type_name	reporting_unit_type_name	string	关联的 ReportingUnitType 的名称。
抑制	suppression	string	适用于此 DataItem 的抑制符号。如果没有抑制，则为 null
suppression_codes	suppression_codes	string	适用于此 DataItem 的抑制代码的分号分隔列表。如果没有抑制，则为 null。

DataExtractPagination

提供分页结果集的分页详细信息。

名称	路径	类型	说明
results_returned	results_returned	integer	此响应中返回的结果数。
starting_result_index	starting_result_index	integer	此列表中的起始结果的索引。这对应于分页请求中的 skip + 1。
total_results_available	total_results_available	integer	通过分页获得的结果总数。

PaginatedFormattedDataExtractModel

分页结果集，其中包含 FormattedDataExtract 项的列表和请求的分页信息。

名称	路径	类型	说明
数据	data	array of FormattedDataExtractModel	FormattedDataExtract 项的列表。
分页	pagination	DataExtractPagination	提供分页结果集的分页详细信息。

DatasheetConfigurationSummaryModel

DatasheetConfigurationSummary 提供了哪些数据表可供生成的详细信息。

名称	路径	类型	说明
datasheet_code	datasheet_code	string	用于指定数据表下载的代码。
datasheet_description	datasheet_description	string	将使用此代码生成的数据表的说明。
datasheet_type	datasheet_type	string	将使用此代码生成的数据表的类型。

DataItemModel

DataItem 封装特定单位（ReportingUnit）的数据值，涵盖特定数据周期（DataSet）。

名称	路径	类型	说明
警告	caveats	array of CaveatModel	适用于此 DataItem 的注意事项列表。如果没有警告，此列表将为空。
data_set_id	data_set_id	integer	关联的数据集的 ID。
group_number	group_number	integer	指示数据值的五位数、十分位数或其他分组编号。如果不适用，则为 null。
lower_value	lower_value		如果此 DataItem 是数据范围或置信区间，则表示较低的数据值，否则为 null。
measure_code	measure_code	string	关联的度量值的代码。
peer_group_summary	peer_group_summary	ReportingUnitSummaryModel	ReportingUnitSummary 详细说明 ReportingUnit 的代码和名称，包括关联的 ReportingUnitType 的摘要。
proxy_reporting_unit_summary	proxy_reporting_unit_summary	ReportingUnitSummaryModel	ReportingUnitSummary 详细说明 ReportingUnit 的代码和名称，包括关联的 ReportingUnitType 的摘要。
reported_measure_code	reported_measure_code	string	关联的 ReportedMeasure 的代码
reporting_unit_summary	reporting_unit_summary	ReportingUnitSummaryModel	ReportingUnitSummary 详细说明 ReportingUnit 的代码和名称，包括关联的 ReportingUnitType 的摘要。
禁止显示	suppressions	array of SuppressionModel	获取或设置抑制。
上限值	upper_value	double	如果此 DataItem 是数据范围或置信区间，则表示高数据值，否则为 null。
value	value	double	此 DataItem 的数据值。如果取消数据，则此数据值可能为 null，在这种情况下，警告将在“注意事项”列表中显示。

VersionInformation

API 版本信息

名称	路径	类型	说明
API 版本	api_version	string	Api 版本
数据版本	data_version	integer	数据版本
已上传日期	date_uploaded	string	上传数据的日期
请求的时间戳	requested_time_stamp	string	请求的时间戳

通过

AIHW MyHospitals （独立发布者） （预览版）

限制

操作