This page is part of the Australian Base IG (v0.9.3: AU Base 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.
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 not a fixed address, the type shall be 'physical' (: extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress' and value=true).exists() implies type='physical') inv-add-2: If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS' (: extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress').exists() implies text.startsWith('NO FIXED ADDRESS')) |
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 |
Address.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Address.extension ([CanonicalType[http://hl7.org.au/fhir/StructureDefinition/no-fixed-address]]) | |
Definition | No Fixed Address indicator. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Address.extension.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 |
Address.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Address.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org.au/fhir/StructureDefinition/no-fixed-address |
Address.extension.valueBoolean | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | boolean |
Fixed Value | true |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Invariants | Defined on this element inv-add-3: Postal code shall be 4 digits (: (country='AU' and postalCode.exists()) implies postalCode.matches('^\\d{4}$')) |
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 |
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> |