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

## Extension: NZ Suburb

Official URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | Version: 1.0
Active as of 2020-07-20 | Maturity Level: 1 | Computable Name: Suburb
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

Suburb element of a NZ Address.

Required as FHIR Base Address Type does not contain an element for Suburb (only District or State which, in population terms, are both broader than City - whereas Suburb is narrower).

Context of Use

This extension may be used on the following element(s)

- Element ID: `Address`

Example of extension

      <address>
        <extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
          <valueString value="Cove"/>
        </extension>
        <line value="23 thule st"/>
        <city value="Waipu"/>
      </address>

Example instances

Patient with address suburb

Usage info

Usages:

- Use this Extension: Common NZ Address datatype
- Examples for this Extension: Patient/patient-address-suburb and Patient/patient-suburb

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

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

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Suburb
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x] |  | 0..1 | string | NZSuburb Example Rototuna: Rototuna
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Suburb
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x] |  | 0..1 | string | NZSuburb Example Rototuna: Rototuna
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Suburb element of a NZ Address.

Maturity: 1

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Suburb
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x] |  | 0..1 | string | NZSuburb Example Rototuna: Rototuna
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Suburb
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x] |  | 0..1 | string | NZSuburb Example Rototuna: Rototuna
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Suburb element of a NZ Address.

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

#### Constraints

Id | Grade | Path(s) | Description | Expression
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()`