HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

Data Type Profile: Common NZ Address datatype

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzAddress Version: 1.0.0
Active as of 2024-04-11 Realm: New Zealand flag Computable Name: NzAddress

Adds building name, suburb, domicile code and geocode to the Address datatype

Usage:

Formal Views of Profile Content

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

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... country 0..1 string Should be the ISO 3166 code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... country Σ 0..1 string Should be the ISO 3166 code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country Σ 0..1 string Should be the ISO 3166 code
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... country 0..1 string Should be the ISO 3166 code

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... country Σ 0..1 string Should be the ISO 3166 code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
... country-name 0..1 string The name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country Σ 0..1 string Should be the ISO 3166 code
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron