HL7® FHIR® New Zealand Base Implementation Guide
1.2.0 - CI Build

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This is not an authorized publication; it is the continuous build for version 1.2.0). 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 Geocode

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode Version: 1.2.0
Active as of 2020-07-20 Realm: New Zealand flag Computable Name: Nz_geocode

Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

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

Context of Use

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

  • Address

Example of extension

<extension url = http://hl7.org.nz/fhir/StructureDefinition/nz-geocode>
     <extension url= "latitude">
      <valueDecimal value="-35.99">
    </extension>
    <extension url= "longitude">
      <valueDecimal value="174.47">
    </extension>
    <extension url="datumCode">
      <valueCodeableConcept>
        <coding>
          <system value="https://standards.digital.health.nz/ns/nz-datum-code"/>
          <code value="NZGD2000"/>
          <display value="Nz official datum, used by MoH address service"/>
        </coding>
      </valueCodeableConcept>
    </extension>
</extension>

Example instances

Patient with geocoded address

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 2 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNZ Geocode
... extension 2..*ExtensionExtension
... extension:latitude 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"latitude"
.... value[x] 0..1decimalValue of extension
... extension:longitude 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"longitude"
.... value[x] 0..1decimalValue of extension
.... extension 0..0
.... url 1..1uri"datumCode"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Datum code (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNZ Geocode
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:latitude 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"latitude"
.... value[x] 0..1decimalValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"longitude"
.... value[x] 0..1decimalValue of extension
... extension:datumCode 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"datumCode"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Datum code (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNZ Geocode
... extension 2..*ExtensionExtension
... extension:latitude 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"latitude"
.... value[x] 0..1decimalValue of extension
... extension:longitude 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"longitude"
.... value[x] 0..1decimalValue of extension
.... extension 0..0
.... url 1..1uri"datumCode"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Datum code (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNZ Geocode
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:latitude 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"latitude"
.... value[x] 0..1decimalValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"longitude"
.... value[x] 0..1decimalValue of extension
... extension:datumCode 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"datumCode"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Datum code (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:datumCode.value[x]:valueCodeableConceptpreferredDatumCode