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: NzAddress - Detailed Descriptions

Active as of 2024-11-18

Definitions for the NzAddress data type profile.

Guidance on how to interpret the contents of this table can be found here

0. Address
2. Address.extension:nz-geocode
Slice Namenz-geocode
ShortA geocode using the NZ specific datum (reference point)
Control0..1
TypeExtension(NZ Geocode) (Complex Extension)
4. Address.extension:suburb
Slice Namesuburb
ShortThe suburb part of the address
Control0..1
TypeExtension(NZ Suburb) (Extension Type: string)
6. Address.extension:building-name
Slice Namebuilding-name
ShortThe name of the building
Control0..1
TypeExtension(Building Name) (Extension Type: string)
8. Address.extension:domicile-code
Slice Namedomicile-code
ShortThe domicile code associated with this address
Control0..1
TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
10. Address.extension:country-name
Slice Namecountry-name
ShortThe name of the country. The ISO code should be in the country property
Control0..1
TypeExtension(Country Name) (Extension Type: string)
12. Address.country
ShortShould be the ISO 3166 code

Guidance on how to interpret the contents of this table can be found here

0. Address
Definition

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.extension:nz-geocode
Slice Namenz-geocode
Definition

New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

ShortA geocode using the NZ specific datum (reference point)
Control0..1
TypeExtension(NZ Geocode) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Address.extension:suburb
Slice Namesuburb
Definition

Suburb element of a NZ Address.

ShortThe suburb part of the address
Control0..1
TypeExtension(NZ Suburb) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Address.extension:building-name
Slice Namebuilding-name
Definition

The name of a building cited in an address.

ShortThe name of the building
Control0..1
TypeExtension(Building Name) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Address.extension:domicile-code
Slice Namedomicile-code
Definition

NZ Domicile Code. Derived from a patient's primary physical, home address.

ShortThe domicile code associated with this address
Control0..1
TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Address.extension:country-name
Slice Namecountry-name
Definition

The display name for a country in an address.

ShortThe name of the country. The ISO code should be in the country property
Control0..1
TypeExtension(Country Name) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortShould be the ISO 3166 codeCountry (e.g. can be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Address
Definition

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Address.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Address.extension:nz-geocode
    Slice Namenz-geocode
    Definition

    New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

    ShortA geocode using the NZ specific datum (reference point)
    Control0..1
    TypeExtension(NZ Geocode) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Address.extension:suburb
    Slice Namesuburb
    Definition

    Suburb element of a NZ Address.

    ShortThe suburb part of the address
    Control0..1
    TypeExtension(NZ Suburb) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Address.extension:building-name
    Slice Namebuilding-name
    Definition

    The name of a building cited in an address.

    ShortThe name of the building
    Control0..1
    TypeExtension(Building Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Address.extension:domicile-code
    Slice Namedomicile-code
    Definition

    NZ Domicile Code. Derived from a patient's primary physical, home address.

    ShortThe domicile code associated with this address
    Control0..1
    TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Address.extension:country-name
    Slice Namecountry-name
    Definition

    The display name for a country in an address.

    ShortThe name of the country. The ISO code should be in the country property
    Control0..1
    TypeExtension(Country Name) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Address.use
    Definition

    The purpose of this address.

    Shorthome | work | temp | old | billing - purpose of this address
    Comments

    Applications can assume that an address is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from AddressUse
    (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

    The use of an address.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows an appropriate address to be chosen from a list of many.

    Example<br/><b>General</b>:home
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. 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.

    Shortpostal | physical | both
    Comments

    The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

    Control0..1
    BindingThe codes SHALL be taken from AddressType
    (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

    The type of an address (physical / postal).

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Example<br/><b>General</b>:both
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Address.text
    Definition

    Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

    ShortText representation of the address
    Comments

    Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    A renderable, unencoded form.

    Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. 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.

    ShortStreet name, number, direction & P.O. Box etc.
    Control0..*
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Example<br/><b>General</b>:137 Nowhere Street
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Address.city
    Definition

    The name of the city, town, suburb, village or other community or delivery center.

    ShortName of city, town etc.
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate NamesMunicpality
    Example<br/><b>General</b>:Erewhon
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Address.district
    Definition

    The name of the administrative area (county).

    ShortDistrict name (aka 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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate NamesCounty
    Example<br/><b>General</b>:Madison
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. 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 (e.g. US 2 letter state codes).

    ShortSub-unit of country (abbreviations ok)
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate NamesProvince, Territory
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Address.postalCode
    Definition

    A postal code designating a region defined by the postal service.

    ShortPostal code for area
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate NamesZip
    Example<br/><b>General</b>:9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Address.country
    Definition

    Country - a nation as commonly understood or generally accepted.

    ShortShould be the ISO 3166 code
    Comments

    ISO 3166 3 letter codes can be used in place of a human readable country name.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Address.period
    Definition

    Time period when address was/is in use.

    ShortTime period when address was/is in use
    Control0..1
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows addresses to be placed in historical context.

    Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))