AIHW MyHospitals (Independent Publisher) (プレビュー)
MyHospitals の全国レポートプラットフォームを使用すると、ユーザーは地元の病院と地元の病院ネットワーク (LHN) に関する情報、およびオーストラリア全体の傾向を調べることができます
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Paul Culmsee |
| [URL] | https://www.sevensigma.com.au |
| メール | paul.culmsee@sevensigma.com.au |
| Connector Metadata | |
|---|---|
| 発行者 | Paul Culmsee |
| Web サイト | https://www.aihw.gov.au/reports-data/myhospitals/content/api |
| プライバシー ポリシー | https://www.aihw.gov.au/privacy-policy |
| カテゴリー | 日付 |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 1 つのデータセットを取得する |
指定されたデータセット ID に一致する単一のデータセットを取得します。 |
| 1 つのメジャー カテゴリを取得する |
指定されたメジャー カテゴリ コードに一致する単一のメジャー カテゴリを取得します。 |
| 1 つのメジャーを取得する |
指定されたメジャー コードに一致する単一のメジャーを取得します。 |
| 1 つのレポート ユニット タイプを取得する |
指定されたレポート ユニット タイプ コードに一致する単一のレポート ユニット タイプを取得します。 |
| 1 つのレポート ユニットを取得する |
指定されたレポート ユニット コードに一致する単一のレポート ユニットを取得します。 |
| 1 つのレポートされたメジャーを取得する |
1 つのレポートされたメジャーを取得します。 |
| 1 つの注意事項を取得する |
指定された注意事項コードに一致する注意事項を取得します。 |
| シンプル ダウンロードを取得する |
提供されたダウンロード コードについて、XLSX 形式でシンプル ダウンロードを取得します。 |
| データセットを取得する |
データセットのリストを取得します。オプションで、メジャーとレポートされたメジャー コードのリストでフィルターされます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。 |
| データセット項目を取得する |
データセットのデータ項目のリストを取得します。オプションで、論理和 (OR) を使用して、レポート ユニット コードのリストによってフィルター処理されます。 |
| フラット データを取得する |
各アイテムが単一のデータ ポイントに対応するフラット化された構造でデータを取得します。 データは単一のメジャー カテゴリ内に制限されており、オプションで、メジャー、レポート ユニット タイプ、およびレポート日付でフィルタリングできます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。 注: 現在、このクエリにはページ割りの制限があり、リクエストを最大 1000 件の結果に制限しています。 このページ割りを制御するには、スキップとトップを使用します。 ソートは現在使用できません。 |
| フラットに書式設定されたされたデータを取得する |
各アイテムが単一のデータ ポイントに対応するフラット化された構造で書式設定されたデータを取得します。 データは単一のメジャー カテゴリ内に制限されており、オプションで、レポート ユニット コード、レポート ユニット タイプ、およびレポート日付でフィルタリングできます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。 注: 現在、このクエリにはページ割りの制限があり、リクエストを最大 1000 件の結果に制限しています。 このページ割りを制御するには、スキップとトップを使用します。 ソートは現在使用できません。 |
| メジャー カテゴリ コードのレポートされたメジャー カテゴリを取得する |
提供されたレポートされたメジャー カテゴリ コードに一致するレポートされたメジャー カテゴリのリストを取得します。 注: レポートされたメジャー コードは、システム内で一意になるように制約されていません。 |
| メジャー カテゴリのメジャーを取得する |
指定されたメジャー カテゴリ コードのメジャーのリストを取得します。 |
| メジャー カテゴリを取得する |
メジャー カテゴリの一覧を取得します。 |
| メジャー ダウンロードを取得する |
提供されたメジャー ダウンロード コードについて、XLSX 形式でレポート ユニットのメジャーを取得します。 |
| メジャーに利用可能なレポート ユニットを取得する |
指定されたメジャーに対して使用可能なデータがあるすべてのレポート ユニットのリストを取得します。 |
| メジャーのデータ項目を取得する |
指定されたメジャーのすべてのデータ項目のリストを取得します。 |
| メジャーを取得する |
メジャー カテゴリ コードのリストによって、論理和 (OR) を使用して、オプションでフィルタリングされたすべてのメジャーのリストを取得します。 |
| レポーティング ユニットのブリック コードを取得する |
指定されたレポート ユニットで使用可能なすべてのブリック コードのリストを取得します。 |
| レポート メジャー カテゴリを取得する |
使用可能なレポートされるメジャー カテゴリのリストを取得します。 |
| レポート ユニット コードと利用可能なブリックの辞書を取得する |
指定されたレポート ユニット タイプについて、レポート ユニット コードとその使用可能なブリックの辞書を取得します。 |
| レポート ユニット タイプを取得する |
レポート ユニット タイプの一覧を取得します。 |
| レポート ユニットで利用可能なデータを使用してメジャーを取得する |
指定されたレポート ユニットで使用可能なデータがあるすべてのメジャーのリストを取得します。 |
| レポート ユニットのダウンロード全体でメジャーを取得する |
提供されたメジャー ダウンロード コードについて、XLSX 形式でレポート ユニットのダウンロード全体のメジャーを取得します。 |
| レポート ユニットのデータ ダウンロードを取得する |
提供されたレポート ユニット コードとデータシート コードのレポート ユニット データのダウンロードを XLSX 形式で取得します。 |
| レポート ユニットのデータ項目を取得する |
指定のレポート ユニットのすべてのデータ項目のリストを取得します。 |
| レポート ユニットのマッピング ダウンロードを取得する |
レポート ユニット マッピングのダウンロードを XLSX 形式で取得します。 |
| レポート ユニットを取得する |
すべてのレポート ユニットのリストを取得します。オプションで、論理和 (OR) を使用して、レポート ユニット タイプ コードのリストによってフィルター処理されます。 |
| レポートされたメジャー カテゴリのレポートされたメジャーを取得する |
指定のレポートされたメジャー カテゴリ コードのすべてのレポートされたメジャーのリストを取得します。 |
| レポートされたメジャーのデータ項目を取得する |
指定のレポートされるメジャーのすべてのデータ項目のリストを取得します。 |
| レポートされるメジャーを取得する |
レポートされたメジャーのリストを取得し、オプションで、メジャー コードのリストでフィルターされます。 |
| 利用可能なシンプル ダウンロードを取得する |
シンプル ダウンロード API 呼び出しで使用できる、使用可能なすべてのシンプル ダウンロード コードと説明の、シンプル ダウンロード コードでインデックス付けされた辞書を取得します。 |
| 利用可能なメジャー ダウンロードを取得する |
メジャー ダウンロード API 呼び出しで使用できる、使用可能なすべてのメジャー ダウンロード コードと説明の、メジャー ダウンロード コードでインデックス付けされた辞書を取得します。 |
| 利用可能なレポート ユニットのデータセット コードを取得する |
レポート ユニット ダウンロード API 呼び出しで使用できる、使用可能なすべてのレポート ユニット データシート コードと説明の、データシート コードでインデックス付けされた辞書を取得します。 |
| 注意事項を取得する |
注意事項の一覧を取得します。 |
1 つのデータセットを取得する
指定されたデータセット ID に一致する単一のデータセットを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Dataset Id
|
dataset-id | True | integer |
データセット ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | DatasetModel | |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
1 つのメジャー カテゴリを取得する
指定されたメジャー カテゴリ コードに一致する単一のメジャー カテゴリを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード
|
measure-category-code | True | string |
メジャー カテゴリ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | MeasureCategoryModel |
MeasureCategory は、メジャーのグループ化を提供するために使用されます。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
1 つのメジャーを取得する
指定されたメジャー コードに一致する単一のメジャーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード
|
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 |
このメジャーに適用可能な MetaTags のリスト。 MetaTag がない場合、このリストは空になります。 |
|
units
|
result.units | UnitsModel |
ユニットは、メジャーのデータ値をどのように表現するかを示します。 |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
1 つのレポート ユニット タイプを取得する
指定されたレポート ユニット タイプ コードに一致する単一のレポート ユニット タイプを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポート ユニット タイプ コード。
|
reporting-unit-type-code | True | string |
レポート ユニット タイプ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | ReportingUnitType |
ReportingUnitType は、ReportingUnit のタイプを示し、ReportingUnit をグループ化するために使用されます。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
1 つのレポート ユニットを取得する
指定されたレポート ユニット コードに一致する単一のレポート ユニットを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Reporting unit code
|
reporting-unit-code | True | string |
レポート ユニット コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | ReportingUnitModel |
ReportingUnit は、特定のデータ値がどの分析単位に対応するかを示します (多くの場合、地理的またはその他の境界領域)。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
1 つのレポートされたメジャーを取得する
1 つのレポートされたメジャーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートされたメジャー カテゴリ コード。
|
reported-measure-code | True | string |
レポートされたメジャー カテゴリ コード。 |
戻り値
ReportedMeasure は、特定のメジャーの分解です。 この分解は、1 つ以上の ReportedMeasureCategories によって示されます。
- Body
- ReportedMeasureModel
1 つの注意事項を取得する
指定された注意事項コードに一致する注意事項を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Caveat code
|
caveat-code | True | string |
注意事項コード |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | CaveatModel |
注意事項とは、データ値に適用するため、またはデータ値の代わりに使用される脚注または抑制です。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
シンプル ダウンロードを取得する
提供されたダウンロード コードについて、XLSX 形式でシンプル ダウンロードを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ダウンロード コード。
|
download-code | True | string |
ダウンロード コード。 |
戻り値
データセットを取得する
データセットのリストを取得します。オプションで、メジャーとレポートされたメジャー コードのリストでフィルターされます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー コード
|
measure_code | string |
メジャー コード。 |
|
|
レポートされたメジャー コード
|
reported_measure_code | string |
レポートされたメジャー コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of DatasetModel |
データセット項目を取得する
データセットのデータ項目のリストを取得します。オプションで、論理和 (OR) を使用して、レポート ユニット コードのリストによってフィルター処理されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
データセット ID
|
dataset-id | True | string |
データセット ID。 |
|
レポートするユニット コード
|
reporting_unit_code | string |
レポートするユニット コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of DataItemModel |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
フラット データを取得する
各アイテムが単一のデータ ポイントに対応するフラット化された構造でデータを取得します。 データは単一のメジャー カテゴリ内に制限されており、オプションで、メジャー、レポート ユニット タイプ、およびレポート日付でフィルタリングできます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。 注: 現在、このクエリにはページ割りの制限があり、リクエストを最大 1000 件の結果に制限しています。 このページ割りを制御するには、スキップとトップを使用します。 ソートは現在使用できません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード
|
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、yyyy-MM、または yyyy-MM-dd の形式のいずれかの日付にすることができます。 年のみを指定した場合は、年の初めから検索期間を開始し、年と月を指定した場合は、月の初めから検索期間を開始します |
|
|
終了日
|
end_date | string |
endDate は、yyyy、yyyy-MM、または yyyy-MM-dd の形式のいずれかの日付にすることができます。 年のみを指定した場合は、年の終わりに検索期間を終了し、年と月を指定した場合は、月の終わりに検索期間を終了します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | PaginatedFormattedDataExtractModel |
FormattedDataExtract アイテムのリストとリクエストのページ割り情報を含むページ割りされた結果セット。 |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
フラットに書式設定されたされたデータを取得する
各アイテムが単一のデータ ポイントに対応するフラット化された構造で書式設定されたデータを取得します。 データは単一のメジャー カテゴリ内に制限されており、オプションで、レポート ユニット コード、レポート ユニット タイプ、およびレポート日付でフィルタリングできます。 各フィルター内のマッチングは論理和 (OR) によるものであり、フィルター間のマッチングは論理積 (AND) によるものです。 注: 現在、このクエリにはページ割りの制限があり、リクエストを最大 1000 件の結果に制限しています。 このページ割りを制御するには、スキップとトップを使用します。 ソートは現在使用できません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード
|
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、yyyy-MM、または yyyy-MM-dd の形式のいずれかの日付にすることができます。 年のみを指定した場合は、年の初めから検索期間を開始し、年と月を指定した場合は、月の初めから検索期間を開始します |
|
|
終了日
|
end_date | string |
endDate は、yyyy、yyyy-MM、または yyyy-MM-dd の形式のいずれかの日付にすることができます。 年のみを指定した場合は、年の終わりに検索期間を終了し、年と月を指定した場合は、月の終わりに検索期間を終了します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | PaginatedFormattedDataExtractModel |
FormattedDataExtract アイテムのリストとリクエストのページ割り情報を含むページ割りされた結果セット。 |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
メジャー カテゴリ コードのレポートされたメジャー カテゴリを取得する
提供されたレポートされたメジャー カテゴリ コードに一致するレポートされたメジャー カテゴリのリストを取得します。 注: レポートされたメジャー コードは、システム内で一意になるように制約されていません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートされたメジャー カテゴリ コード
|
reported-measure-category-code | True | string |
レポートされたメジャー カテゴリ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | ReportedMeasureCategoryModel |
ReportedMeasureCategory は、特定のメジャーを分解するためのメソッドを提供し、ReportedMeasures のグループ化も可能にします。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
メジャー カテゴリのメジャーを取得する
指定されたメジャー カテゴリ コードのメジャーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード。
|
measure-category-code | True | string |
メジャー カテゴリ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of MeasureModel |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
メジャー カテゴリを取得する
メジャー カテゴリの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of MeasureCategoryModel |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
メジャー ダウンロードを取得する
提供されたメジャー ダウンロード コードについて、XLSX 形式でレポート ユニットのメジャーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー ダウンロード コード
|
measure-download-code | True | string |
メジャー ダウンロード コード。 |
戻り値
メジャーに利用可能なレポート ユニットを取得する
指定されたメジャーに対して使用可能なデータがあるすべてのレポート ユニットのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー コード
|
measure-code | True | string |
メジャー コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportingUnitSummaryModel |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
メジャーのデータ項目を取得する
指定されたメジャーのすべてのデータ項目のリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー コード
|
measure-code | True | string |
メジャー コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of DataItemModel |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
メジャーを取得する
メジャー カテゴリ コードのリストによって、論理和 (OR) を使用して、オプションでフィルタリングされたすべてのメジャーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー カテゴリ コード
|
measure_category_code | string |
メジャー カテゴリ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
このメジャーに適用可能な MetaTags のリスト。 MetaTag がない場合、このリストは空になります。 |
|
units
|
result.units | UnitsModel |
ユニットは、メジャーのデータ値をどのように表現するかを示します。 |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポーティング ユニットのブリック コードを取得する
指定されたレポート ユニットで使用可能なすべてのブリック コードのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートするユニット コード
|
reporting-unit-code | True | string |
レポートするユニット コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of string |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
レポート メジャー カテゴリを取得する
使用可能なレポートされるメジャー カテゴリのリストを取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportedMeasureCategoryModel |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポート ユニット コードと利用可能なブリックの辞書を取得する
指定されたレポート ユニット タイプについて、レポート ユニット コードとその使用可能なブリックの辞書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポート ユニット タイプ コード。
|
reporting-unit-type-code | True | string |
レポート ユニット タイプ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
レポート ユニット タイプを取得する
レポート ユニット タイプの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportingUnitType |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポート ユニットで利用可能なデータを使用してメジャーを取得する
指定されたレポート ユニットで使用可能なデータがあるすべてのメジャーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートするユニット コード
|
reporting-unit-code | True | string |
レポートするユニット コード |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of MeasureSummaryModel | |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポート ユニットのダウンロード全体でメジャーを取得する
提供されたメジャー ダウンロード コードについて、XLSX 形式でレポート ユニットのダウンロード全体のメジャーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メジャー ダウンロード コード
|
measure-download-code | True | string |
メジャー ダウンロード コード。 |
戻り値
レポート ユニットのデータ ダウンロードを取得する
提供されたレポート ユニット コードとデータシート コードのレポート ユニット データのダウンロードを XLSX 形式で取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
データシート コード
|
datasheet-code | True | string |
データシート コード |
|
レポートするユニット コード
|
reporting-unit-code | True | string |
レポート ユニット コード |
戻り値
レポート ユニットのデータ項目を取得する
指定のレポート ユニットのすべてのデータ項目のリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートするユニット コード。
|
reporting-unit-code | True | string |
レポートするユニット コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of DataItemModel |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
レポート ユニットのマッピング ダウンロードを取得する
レポート ユニット マッピングのダウンロードを XLSX 形式で取得します。
戻り値
レポート ユニットを取得する
すべてのレポート ユニットのリストを取得します。オプションで、論理和 (OR) を使用して、レポート ユニット タイプ コードのリストによってフィルター処理されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポート ユニット タイプ コード
|
reporting_unit_type_code | string |
レポート ユニット タイプ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportingUnitModel |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポートされたメジャー カテゴリのレポートされたメジャーを取得する
指定のレポートされたメジャー カテゴリ コードのすべてのレポートされたメジャーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Reported Measure Category.
|
reported-measure-category-code | True | string |
レポートされたメジャー カテゴリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportedMeasureModel | |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
レポートされたメジャーのデータ項目を取得する
指定のレポートされるメジャーのすべてのデータ項目のリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レポートされたメジャー カテゴリ コード。
|
reported-measure-code | True | string |
レポートされたメジャー カテゴリ コード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of DataItemModel |
result |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
レポートされるメジャーを取得する
レポートされたメジャーのリストを取得し、オプションで、メジャー コードのリストでフィルターされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Measure codes
|
measure_code | string |
メジャー コード |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of ReportedMeasureModel |
result |
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
利用可能なシンプル ダウンロードを取得する
シンプル ダウンロード API 呼び出しで使用できる、使用可能なすべてのシンプル ダウンロード コードと説明の、シンプル ダウンロード コードでインデックス付けされた辞書を取得します。
戻り値
利用可能なメジャー ダウンロードを取得する
メジャー ダウンロード API 呼び出しで使用できる、使用可能なすべてのメジャー ダウンロード コードと説明の、メジャー ダウンロード コードでインデックス付けされた辞書を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
件名
|
results.Name | string |
件名 |
|
Details
|
results.Details | array of DatasheetConfigurationSummaryModel |
Details |
利用可能なレポート ユニットのデータセット コードを取得する
レポート ユニット ダウンロード API 呼び出しで使用できる、使用可能なすべてのレポート ユニット データシート コードと説明の、データシート コードでインデックス付けされた辞書を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | ||
|
version_information
|
version_information | VersionInformation |
API バージョン情報 |
注意事項を取得する
注意事項の一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
result
|
result | array of CaveatModel | |
|
バージョン情報
|
version_information | VersionInformation |
API バージョン情報 |
定義
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 |
このメジャーに適用可能な MetaTags のリスト。 MetaTag がない場合、このリストは空になります。 |
|
units
|
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 は、関連する ReportingUnitType の要約を含む、ReportingUnit のコードと名前の詳細を示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
レポート ユニット コード
|
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 |
このレポート ユニットに適用可能な MetaTags のリスト。 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
|
measure | MeasureModel |
メジャーは、何かを測定するために使用される統計です。 いくつかの指標はパフォーマンス指標 (例えば、選択的手術の待機時間の中央値) であり、いくつかはこれらの指標 (例えば、選択的手術の数) のコンテキストを提供します。 |
|
meta_tags
|
meta_tags | array of MetaTagModel |
このメジャーに適用可能な MetaTags のリスト。 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 は、関連する ReportingUnitType の要約を含む、ReportingUnit のコードと名前の詳細を示します。 |
|
マッピングされたレポート ユニット コード
|
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) および % (suffix)。 |
|
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、ReportedMeasure、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 Code
|
measure_code | string |
対応するメジャーのコード。 |
|
Measure Name
|
measure_name | string |
対応するメジャーの名前。 |
ReportedMeasureSummaryModel
ReportedMeasureSummary は、関連する Measure の要約を含む、ReportedMeasure のコードと名前の詳細を示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
measure_summary
|
measure_summary | MeasureSummaryModel |
MeasureSummaryModel は、追加のフィールドなしで、メジャーのコードと名前のみを詳細に示します。 |
|
レポートされたメジャー コード
|
reported_measure_code | string |
対応する ReportedMeasure のコード。 |
|
レポートされたメジャー名
|
reported_measure_name | string |
対応する ReportedMeasure の名前。 |
DatasetModel
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
注意事項
|
caveats | array of CaveatModel |
この DataSet に適用可能な注意事項のリスト。 注意事項がない場合、このリストは空になります。 |
|
データ セット ID
|
data_set_id | integer |
DataSet の ID。 |
|
データ セット名
|
data_set_name | string |
対応する DataSet の表示名。 |
|
meta_tags
|
meta_tags | array of MetaTagModel |
このデータセットに適用可能な MetaTags のリスト。 MetaTag がない場合、このリストは空になります。 |
|
reported_measure_summary
|
reported_measure_summary | ReportedMeasureSummaryModel |
ReportedMeasureSummary は、関連する Measure の要約を含む、ReportedMeasure のコードと名前の詳細を示します。 |
|
レポート終了日
|
reporting_end_date | string |
DataSet データ期間の終了日。 |
|
レポート開始日
|
reporting_start_date | string |
DataSet データ期間の開始日。 |
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 |
対応する DataSet に適用される注意事項記号。 注意事項がない場合、これは null になります。 |
|
data_set_caveat_codes
|
data_set_caveat_codes | string |
対応する DataSet に適用可能な注意事項コードのセミコロン区切りのリスト。 注意事項がない場合、これは null になります。 |
|
data_set_caveat_footnotes
|
data_set_caveat_footnotes | string |
対応する DataSet に適用可能な注意事項記号とその説明の脚注のセミコロン区切りのリスト。 注意事項がない場合、これは null になります。 |
|
data_period
|
data_period | string |
開始日と終了日を含むデータ期間の書式設定された表示。 |
|
data_period_type
|
data_period_type | string |
FinancialYear などのデータ期間タイプの説明。 |
|
data_set_id
|
data_set_id | integer |
対応する DataSet の ID。 |
|
data_set_meta_tag_codes
|
data_set_meta_tag_codes | string |
対応する DataSet の MetaTag コードのセミコロン区切りのリスト。 DataSet MetaTag がない場合、これは null になります。 |
|
data_set_meta_tags
|
data_set_meta_tags | string |
対応する DataSet の MetaTag 値のセミコロン区切りのリスト。 DataSet MetaTag がない場合、これは null になります。 |
|
data_set_meta_tags_with_type
|
data_set_meta_tags_with_type | string |
対応する DataSet の 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 |
データ値の 5分位、十分位数、またはその他のグループ化番号を示します。 該当しない場合、これは null になります。 |
|
非公開
|
private | boolean |
この ReportingUnit が私立病院 (例: 私立病院) であるかどうかを示します。 |
|
mapped_local_hospital_network
|
mapped_local_hospital_network | string |
対応する ReportingUnit's associated LHN の LHN 名。 ReportingUnit にマッピングされた LHN がない場合、これは null となります。 |
|
mapped_primary_health_network
|
mapped_primary_health_network | string |
対応する ReportingUnit's associated 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 |
対応するメジャーの MetaTag コードのセミコロン区切りのリスト。 メジャー MetaTag がない場合、これは null になります。 |
|
measure_meta_tags
|
measure_meta_tags | string |
対応するメジャーの MetaTag 値のセミコロン区切りのリスト。 メジャー MetaTag がない場合、これは null になります。 |
|
measure_meta_tags_with_type
|
measure_meta_tags_with_type | string |
対応するメジャーの MetaTag 値のセミコロン区切りのリスト。 各 MetaTag 値は、パターン MetaTagTypeCode|MetaTagValue と一致します。 メジャー 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 |
3 番目の ReportedMeasure カテゴリのコード。 ReportedMeasure に 3 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_three_name
|
reported_measure_category_three_name | string |
3 番目の ReportedMeasure カテゴリの名前。 ReportedMeasure に 3 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_two_code
|
reported_measure_category_two_code | string |
2 番目の ReportedMeasure カテゴリのコード。 ReportedMeasure に 2 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_two_name
|
reported_measure_category_two_name | string |
2 番目の 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 |
3 番目の ReportedMeasure カテゴリ タイプのコード。 ReportedMeasure に 3 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_three_type_name
|
reported_measure_category_three_type_name | string |
3 番目の ReportedMeasure カテゴリ タイプの名前。 ReportedMeasure に 3 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_two_type_code
|
reported_measure_category_two_type_code | string |
2 番目の ReportedMeasure カテゴリ タイプのコード。 ReportedMeasure に 2 つのカテゴリがない場合、これは null になります。 |
|
reported_measure_category_two_type_name
|
reported_measure_category_two_type_name | string |
2 番目の 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 |
DataSet データ期間の終了日。 |
|
reporting_start_date
|
reporting_start_date | string |
DataSet データ期間の開始日。 |
|
reporting_unit_code
|
reporting_unit_code | string |
関連する ReportingUnit のコード。 |
|
reporting_unit_meta_tag_codes
|
reporting_unit_meta_tag_codes | string |
対応する ReportingUnit の MetaTag コードのセミコロン区切りのリスト。 ReportingUnit MetaTags がない場合、これは null になります。 |
|
reporting_unit_meta_tags
|
reporting_unit_meta_tags | string |
対応する ReportingUnit の MetaTag 値のセミコロン区切りのリスト。 ReportingUnit MetaTags がない場合、これは null になります。 |
|
reporting_unit_meta_tags_with_type
|
reporting_unit_meta_tags_with_type | string |
対応する ReportingUnit の MetaTag 値のセミコロン区切りのリスト。 各 MetaTag 値は、パターン MetaTagTypeCode|MetaTagValue と一致します。 ReportingUnit MetaTags がない場合、これは 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
|
suppression | string |
この DataItem に適用される抑制記号。 抑制がない場合、これは null になります。 |
|
suppression_codes
|
suppression_codes | string |
この DataItem に適用可能な抑制コードのセミコロン区切りのリスト。 抑制がない場合、これは null になります。 |
DataExtractPagination
ページ割りされた結果セットのページ付けの詳細を提供します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results_returned
|
results_returned | integer |
この応答で返される結果の数。 |
|
starting_result_index
|
starting_result_index | integer |
このリストの開始結果のインデックス。 これは、ページ割り要求からのスキップ + 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 は、特定のデータ期間 (DataSet) をカバーする特定のユニット (ReportingUnit) のデータ値をカプセル化します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
注意事項
|
caveats | array of CaveatModel |
この DataItem に適用可能な注意事項のリスト。 注意事項がない場合、このリストは空になります。 |
|
data_set_id
|
data_set_id | integer |
関連付けられている DataSet の ID です。 |
|
group_number
|
group_number | integer |
データ値の 5分位、十分位数、またはその他のグループ化番号を示します。 該当しない場合、これは null になります。 |
|
lower_value
|
lower_value |
この DataItem がデータ範囲であるか、信頼区間がある場合は、より低いデータ値を表します。それ以外の場合、これは null になります。 |
|
|
measure_code
|
measure_code | string |
関連するメジャーのコード。 |
|
peer_group_summary
|
peer_group_summary | ReportingUnitSummaryModel |
ReportingUnitSummary は、関連する ReportingUnitType の要約を含む、ReportingUnit のコードと名前の詳細を示します。 |
|
proxy_reporting_unit_summary
|
proxy_reporting_unit_summary | ReportingUnitSummaryModel |
ReportingUnitSummary は、関連する ReportingUnitType の要約を含む、ReportingUnit のコードと名前の詳細を示します。 |
|
reported_measure_code
|
reported_measure_code | string |
関連する ReportedMeasure のコード |
|
reporting_unit_summary
|
reporting_unit_summary | ReportingUnitSummaryModel |
ReportingUnitSummary は、関連する ReportingUnitType の要約を含む、ReportingUnit のコードと名前の詳細を示します。 |
|
suppressions
|
suppressions | array of SuppressionModel |
抑制の取得または設定。 |
|
上限値
|
upper_value | double |
この DataItem がデータ範囲であるか、信頼区間がある場合は、より高いデータ値を表します。それ以外の場合、これは null になります。 |
|
価値
|
value | double |
この DataItem のデータ値。 データが抑制されている場合、このデータ値は null になる可能性があります。その場合、注意事項が注意事項リストに表示されます。 |
VersionInformation
API バージョン情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
API Version
|
api_version | string |
API バージョン |
|
データ バージョン
|
data_version | integer |
データ バージョン |
|
アップロードした日付
|
date_uploaded | string |
データがアップロードされた日付 |
|
Requested Time Stamp
|
requested_time_stamp | string |
要求のタイムスタンプ |