Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 0.2.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-postal-address | Version: 0.2.0-preview | |||
| Standards status: Draft | Computable Name: HCPreferredPostalAddress | |||
Usage:Jurisdiction: Australia |
||||
Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/ |
||||
Preferred postal/mailing address for correspondence (PO Box or mailing address) that is distinct from the registered physical address.
Context of Use
This extension may be used on the following element(s)
Location
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension(4.0.1) | HC Preferred Postal Address | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | uri | "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-postal-address" | |
![]() ![]() |
1..1 | Address | Preferred postal/mailing address | |
![]() ![]() ![]() |
0..1 | code | postal | physical | both Fixed Value: postal | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension(4.0.1) | HC Preferred Postal Address Constraints: ext-1 | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
![]() ![]() |
1..1 | uri | "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-postal-address" | |
![]() ![]() |
1..1 | Address | Preferred postal/mailing address | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal |
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension(4.0.1) | HC Preferred Postal Address | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | uri | "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-postal-address" | |
![]() ![]() |
1..1 | Address | Preferred postal/mailing address | |
![]() ![]() ![]() |
0..1 | code | postal | physical | both Fixed Value: postal | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension(4.0.1) | HC Preferred Postal Address Constraints: ext-1 | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
![]() ![]() |
1..1 | uri | "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-postal-address" | |
![]() ![]() |
1..1 | Address | Preferred postal/mailing address | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal |
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x].use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Extension.value[x].type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Extension, Extension.value[x], Extension.value[x].extension, Extension.value[x].use, Extension.value[x].type, Extension.value[x].text, Extension.value[x].line, Extension.value[x].city, Extension.value[x].district, Extension.value[x].state, Extension.value[x].postalCode, Extension.value[x].country, Extension.value[x].period | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Extension, Extension.value[x].extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|