Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.2.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R5 R4 R3

1.0 StructureDefinition-au-address

Australian Local Address Profile

This profile defines a profile on address for local Australian addresses.

This profile should not be used for international addresses, in that case use the base Address core definition

Examples

Australian Local Address

Australian No Fixed Address

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-address

Australian Address (discussion)

This profile builds on Address.

This profile was published on Fri May 05 05:09:53 AEST 2017 as a draft by HL7 FHIR Community.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Australian Address (Local) Profile

  1. Base: Address (as Address)
  2. Optional: Address Type (as AddressType, exclude when no fixed address)
  3. Optional: Address Text (as string, either text or lines required)
  4. Optional: Address Lines (as string, either text or lines required)
  5. Required: Australian Postcode (as string, require 4 digit numeric code)
  6. Optional: Australian State (as string, bound to Australian State value set - extensible)
  7. Required: Country (fixed ‘Australia’)
  8. Optional: No Fixed Address Extension
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*au-address-au-postalcode: postal code for Australian address must be 4 digits
au-address-au-addr: provider text or address line is required
au-address-au-nfa-no-type: type is not valid for no fixed address
au-address-au-nfa-text: no fixed address text
... state 0..1stringBinding: http://meteor.aihw.gov.au/content/index.phtml/itemId/430134#Codes (extensible)
... country 1..1stringAlways Australia
Fixed Value: Australia
... nofixedaddress 0..1booleanOptional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/nofixedaddress

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*An address expressed using postal conventions (as opposed to GPS or other location definition formats)
au-address-au-postalcode: postal code for Australian address must be 4 digits
au-address-au-addr: provider text or address line is required
au-address-au-nfa-no-type: type is not valid for no fixed address
au-address-au-nfa-text: no fixed address text
... id 0..1stringxml:id (or equivalent in JSON)
... nofixedaddress 0..1booleanOptional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/nofixedaddress
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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
... city Σ0..1stringName of city, town etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: http://meteor.aihw.gov.au/content/index.phtml/itemId/430134#Codes (extensible)
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ1..1stringAlways Australia
Fixed Value: Australia
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

doco Documentation for this format

Australian Address (Local) Profile

  1. Base: Address (as Address)
  2. Optional: Address Type (as AddressType, exclude when no fixed address)
  3. Optional: Address Text (as string, either text or lines required)
  4. Optional: Address Lines (as string, either text or lines required)
  5. Required: Australian Postcode (as string, require 4 digit numeric code)
  6. Optional: Australian State (as string, bound to Australian State value set - extensible)
  7. Required: Country (fixed ‘Australia’)
  8. Optional: No Fixed Address Extension

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*au-address-au-postalcode: postal code for Australian address must be 4 digits
au-address-au-addr: provider text or address line is required
au-address-au-nfa-no-type: type is not valid for no fixed address
au-address-au-nfa-text: no fixed address text
... state 0..1stringBinding: http://meteor.aihw.gov.au/content/index.phtml/itemId/430134#Codes (extensible)
... country 1..1stringAlways Australia
Fixed Value: Australia
... nofixedaddress 0..1booleanOptional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/nofixedaddress

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*An address expressed using postal conventions (as opposed to GPS or other location definition formats)
au-address-au-postalcode: postal code for Australian address must be 4 digits
au-address-au-addr: provider text or address line is required
au-address-au-nfa-no-type: type is not valid for no fixed address
au-address-au-nfa-text: no fixed address text
... id 0..1stringxml:id (or equivalent in JSON)
... nofixedaddress 0..1booleanOptional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/nofixedaddress
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValue of extension
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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
... city Σ0..1stringName of city, town etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: http://meteor.aihw.gov.au/content/index.phtml/itemId/430134#Codes (extensible)
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ1..1stringAlways Australia
Fixed Value: Australia
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-address

none defined