Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
Definitions for the StructureDefinition-au-address Profile.
| 1. Address | |
| Definition | An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats). |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Comments | Note: address is for postal addresses, not physical locations. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) inv-add-0: The address shall at least have text or a line (: text.exists() or line.exists()) inv-add-1: If asserting no fixed address, the type shall be 'physical' (: extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address' and value=true).exists() implies type='physical') inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' (: extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')) inv-add-3: Postal code shall be 4 digits (: postalCode.exists() implies postalCode.matches('^[0-9]{4}$')) |
| 2. Address.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. Address.extension | |
| Definition | An Extension |
| Control | 0..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Address.extension:noFixedAddress | |
| SliceName | noFixedAddress |
| Definition | No fixed address indicator. |
| Control | 0..1 |
| Type | Extension(NoFixedAddress) (Extension Type: boolean) |
| 5. Address.use | |
| Definition | The purpose of this address. |
| Control | 0..1 |
| Binding | The use of an address The codes SHALL be taken from AddressUse |
| Type | code |
| Is Modifier | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Example | General:home |
| 6. Address.type | |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Control | 0..1 |
| Binding | The type of an address (physical / postal) The codes SHALL be taken from AddressType |
| Type | code |
| Example | General:both |
| 7. Address.text | |
| Definition | A full text representation of the address. |
| Control | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. |
| Example | General:137 Nowhere Street, Erewhon 9132 |
| 8. Address.line | |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Control | 0..* |
| Type | string |
| Requirements | home | work | temp | old - purpose of this address. |
| Example | General:137 Nowhere Street |
| 9. Address.city | |
| Definition | The name of the city, town, village, suburb, or other community or delivery center. |
| Control | 0..1 |
| Type | string |
| Alternate Names | Municpality |
| Example | General:Erewhon |
| 10. Address.district | |
| Definition | The name of the administrative area (county). |
| Control | 0..1 |
| Type | string |
| Alternate Names | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Example | General:Madison |
| 11. Address.state | |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 |
| Type | string |
| Alternate Names | Province, Territory |
| 12. Address.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..1 |
| Type | string |
| Alternate Names | Zip |
| Example | General:9132 |
| 13. Address.country | |
| Definition | Fixed value if present otherwise assumed to be Australia in this context. |
| Control | 0..1 |
| Type | string |
| Comments | ISO 3166 3 letter codes can be used in place of a full country name. |
| Fixed Value | AU |
| 14. Address.period | |
| Definition | Time period when address was/is in use. |
| Control | 0..1 |
| Type | Period |
| Requirements | Allows addresses to be placed in historical context. |
| Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23T00:00:00+11:00"/> <end value="2010-07-01T00:00:00+10:00"/> </valuePeriod> |
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
