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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: nhsd-address

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

Usages:

• Use this DataType Profile: NHSD Location

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, DeliveryPointIdentifier, AUGNAFIdentifier	An identifier intended for computation
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
type	Σ	1..1	code	Type of address (only 'physical' is supported) Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical
line	Σ	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
city	Σ	1..1	string	Name of city, town or suburb Example General: Erewhon
state	Σ	1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode	ΣC	1..1	string	Postcode of city, town or suburb Constraints: inv-add-3 Example General: 9132
country	Σ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.type	required	Fixed Value: physical http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-add-0	error	Address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-add-3	error	Address.postalCode	Postal code shall be 4 digits : matches('^[0-9]{4}$')

This structure is derived from AustralianAddress

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AustralianAddress	An address in Australia for use within an Australian healthcare context.
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:noFixedAddress		0..0
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
use		0..0
type		1..1	code	Type of address (only 'physical' is supported) Fixed Value: physical
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		1..1	string	Name of city, town or suburb
district		0..0
state		1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode		1..1	string	Postcode of city, town or suburb
country		1..1	string	Australia as a 2 digit ISO 3166 code
period		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, DeliveryPointIdentifier, AUGNAFIdentifier	An identifier intended for computation
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
type	Σ	1..1	code	Type of address (only 'physical' is supported) Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	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
city	Σ	1..1	string	Name of city, town or suburb Example General: Erewhon
state	Σ	1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode	ΣC	1..1	string	Postcode of city, town or suburb Constraints: inv-add-3 Example General: 9132
country	Σ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.type	required	Fixed Value: physical http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-add-0	error	Address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-add-3	error	Address.postalCode	Postal code shall be 4 digits : matches('^[0-9]{4}$')

This structure is derived from AustralianAddress

Summary

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

Extensions

This structure refers to these extensions:

• http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, DeliveryPointIdentifier, AUGNAFIdentifier	An identifier intended for computation
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
type	Σ	1..1	code	Type of address (only 'physical' is supported) Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical
line	Σ	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
city	Σ	1..1	string	Name of city, town or suburb Example General: Erewhon
state	Σ	1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode	ΣC	1..1	string	Postcode of city, town or suburb Constraints: inv-add-3 Example General: 9132
country	Σ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.type	required	Fixed Value: physical http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-add-0	error	Address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-add-3	error	Address.postalCode	Postal code shall be 4 digits : matches('^[0-9]{4}$')

Differential View

This structure is derived from AustralianAddress

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AustralianAddress	An address in Australia for use within an Australian healthcare context.
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:noFixedAddress		0..0
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
use		0..0
type		1..1	code	Type of address (only 'physical' is supported) Fixed Value: physical
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		1..1	string	Name of city, town or suburb
district		0..0
state		1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode		1..1	string	Postcode of city, town or suburb
country		1..1	string	Australia as a 2 digit ISO 3166 code
period		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	(Complex)	Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
value[x]		1..1	Identifier, DeliveryPointIdentifier, AUGNAFIdentifier	An identifier intended for computation
extension:addressLine	S	1..1	(Complex)	Please use address line extension to populate individual address lines URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line
type	Σ	1..1	code	Type of address (only 'physical' is supported) Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	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
city	Σ	1..1	string	Name of city, town or suburb Example General: Erewhon
state	Σ	1..1	string	Australian state or territory Binding: Australian States and Territories (extensible)
postalCode	ΣC	1..1	string	Postcode of city, town or suburb Constraints: inv-add-3 Example General: 9132
country	Σ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.type	required	Fixed Value: physical http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Address.state	extensible	Australian States and Territories(a valid code from Standard List of the Australian States and Territories.) http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-states-territories From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-add-0	error	Address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
inv-add-3	error	Address.postalCode	Postal code shall be 4 digits : matches('^[0-9]{4}$')

This structure is derived from AustralianAddress

Summary

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

Extensions

This structure refers to these extensions:

• http://fhir.nhsd.com.au/StructureDefinition/nhsd-address-line

Other representations of profile: CSV, Excel, Schematron

Notes: