NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: nhsd-address

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address Version: 4.0.1
Draft as of 2022-07-20 Computable Name: NHSDAddress

Copyright/Legal: Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile applies to NHSD to define an address structure, for use in an Australian context, to specifically represent an Australian (location) address.

Extension: nhsd-address

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x] 1..1 Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, DeliveryPointIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUGNAFIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.type This element is included in summaries. 1..1 code Type of address (only 'physical' is supported)
Binding: AddressType (required): The type of an address (physical / postal).
Fixed Value: physical (no extensions allowed)
Address.line This element is included in summaries. 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
Address.city This element is included in summaries. 1..1 string Name of city, town or suburb
Example General: Erewhon
Address.state This element is included in summaries. 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode This element is included in summaries. C 1..1 string Postcode of city, town or suburb
Constraints: inv-add-3
Example General: 9132
Address.country This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.state Base required Australian States and Territories 📦4.0.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AustralianAddress

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Address.id 0..0 Unique id for inter-element referencing
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:noFixedAddress 0..0 No fixed address indicator
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.use 0..0 home | work | temp | old | billing - purpose of this address
Address.line 0..* string Street name, number, direction & P.O. Box etc.
Address.city 1..1 string Name of city, town or suburb
Address.district 0..0 District name (aka county)
Address.state 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode 1..1 string Postcode of city, town or suburb
Address.country 1..1 string Australia as a 2 digit ISO 3166 code
Address.period 0..0 Time period when address was/is in use

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.state Base required Australian States and Territories 📦4.0.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.id 0..1 string Unique id for inter-element referencing
Address.Slices for extension.extension:identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Address.Slices for extension.extension:identifier.url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x] 1..1 Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, DeliveryPointIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUGNAFIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.type This element is included in summaries. 1..1 code Type of address (only 'physical' is supported)
Binding: AddressType (required): The type of an address (physical / postal).
Fixed Value: physical (no extensions allowed)
Address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Address.line This element is included in summaries. 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
Address.city This element is included in summaries. 1..1 string Name of city, town or suburb
Example General: Erewhon
Address.state This element is included in summaries. 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode This element is included in summaries. C 1..1 string Postcode of city, town or suburb
Constraints: inv-add-3
Example General: 9132
Address.country This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.state Base required Australian States and Territories 📦4.0.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AustralianAddress

Summary

Mandatory: 7 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 5 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x] 1..1 Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, DeliveryPointIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUGNAFIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.type This element is included in summaries. 1..1 code Type of address (only 'physical' is supported)
Binding: AddressType (required): The type of an address (physical / postal).
Fixed Value: physical (no extensions allowed)
Address.line This element is included in summaries. 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
Address.city This element is included in summaries. 1..1 string Name of city, town or suburb
Example General: Erewhon
Address.state This element is included in summaries. 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode This element is included in summaries. C 1..1 string Postcode of city, town or suburb
Constraints: inv-add-3
Example General: 9132
Address.country This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.state Base required Australian States and Territories 📦4.0.1 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from AustralianAddress

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Address.id 0..0 Unique id for inter-element referencing
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:noFixedAddress 0..0 No fixed address indicator
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.use 0..0 home | work | temp | old | billing - purpose of this address
Address.type 1..1 code Type of address (only 'physical' is supported)
Fixed Value: physical (no extensions allowed)
Address.line 0..* string Street name, number, direction & P.O. Box etc.
Address.city 1..1 string Name of city, town or suburb
Address.district 0..0 District name (aka county)
Address.state 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode 1..1 string Postcode of city, town or suburb
Address.country 1..1 string Australia as a 2 digit ISO 3166 code
Address.period 0..0 Time period when address was/is in use

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.state Base required Australian States and Territories 📦4.0.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* AustralianAddress An address in Australia for use within an Australian healthcare context.
Constraints: inv-add-0, inv-add-1, inv-add-2
Address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.Slices for extension.extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
Address.Slices for extension.extension:identifier.id 0..1 string Unique id for inter-element referencing
Address.Slices for extension.extension:identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Address.Slices for extension.extension:identifier.url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
Address.Slices for extension.extension:identifier.value[x] 1..1 Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, DeliveryPointIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUGNAFIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Address.Slices for extension.extension:addressLine This element must be supported. 1..1 (Complex) Please use address line extension to populate individual address lines
URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
Address.type This element is included in summaries. 1..1 code Type of address (only 'physical' is supported)
Binding: AddressType (required): The type of an address (physical / postal).
Fixed Value: physical (no extensions allowed)
Address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Address.line This element is included in summaries. 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
Address.city This element is included in summaries. 1..1 string Name of city, town or suburb
Example General: Erewhon
Address.state This element is included in summaries. 1..1 string Australian state or territory
Binding: Australian States and Territories (required)
Address.postalCode This element is included in summaries. C 1..1 string Postcode of city, town or suburb
Constraints: inv-add-3
Example General: 9132
Address.country This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.state Base required Australian States and Territories 📦4.0.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AustralianAddress

Summary

Mandatory: 7 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 5 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

NHSD Address is not applicable in the search context.