Disaster declaration status for a postcode
declarations_by_postcodeReturns the declaration STATUS for a postcode: declared, partial, activation_only, not_declared, uncertain, or unknown_postcode, with per-LGA detail and official source links. Reports declared-area status only; the billing/eligibility decision rests with the practitioner. Built for Medicare disaster telehealth checks.
Requires the "declarations" entitlement on the API key. Accounts without it get a clear error rather than an empty result, so an empty response never means "not entitled".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_at | No | Point-in-time check (YYYY-MM-DD). Defaults to today. | |
| suburb | No | Optional suburb/locality name (ABS SAL) to narrow the result to the local government areas that suburb falls in, within this postcode only. Matching is exact after normalisation; there is no fuzzy matching. An unmatched suburb never fails the lookup: the full-postcode result is returned with narrowing.applied=false, a reason, and the postcode's known suburbs. Narrowing can legitimately change matchStatus (for example partial to declared); a suburb that itself spans two LGAs stays partial, and a bare name that denotes suburbs on both sides of a border (Mingoola in 4380) matches all of them. | |
| postcode | Yes | ||
| include_expired | No | Include expired records in the per-LGA lists. Never changes matchStatus. | |
| instrument_type | No | Trim the returned record lists to one instrument type. Never changes matchStatus. |