HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - 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.2.0-ci-build 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 Geocode

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode Version: 0.1.0
Active as of 2020-07-20 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)

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NZ Geocode
Extension.extension 2..* Extension Extension
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:latitude 1..1 Extension Extension
Extension.Slices for extension.extension:latitude.extension 0..0 Extension
Extension.Slices for extension.extension:latitude.url 1..1 uri "latitude"
Extension.Slices for extension.extension:latitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:longitude 1..1 Extension Extension
Extension.Slices for extension.extension:longitude.extension 0..0 Extension
Extension.Slices for extension.extension:longitude.url 1..1 uri "longitude"
Extension.Slices for extension.extension:longitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:datumCode 0..1 Extension Extension
Extension.Slices for extension.extension:datumCode.extension 0..0 Extension
Extension.Slices for extension.extension:datumCode.url 1..1 uri "datumCode"
Extension.Slices for extension.extension:datumCode.value[x] 0..1 CodeableConcept Value of extension
Binding: Datum code (preferred)
Extension.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:datumCode.​value[x] Base preferred Datum code 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NZ Geocode
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:latitude 1..1 Extension Extension
Extension.Slices for extension.extension:latitude.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:latitude.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:latitude.url 1..1 uri "latitude"
Extension.Slices for extension.extension:latitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:longitude 1..1 Extension Extension
Extension.Slices for extension.extension:longitude.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:longitude.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:longitude.url 1..1 uri "longitude"
Extension.Slices for extension.extension:longitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:datumCode 0..1 Extension Extension
Extension.Slices for extension.extension:datumCode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:datumCode.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:datumCode.url 1..1 uri "datumCode"
Extension.Slices for extension.extension:datumCode.value[x] 0..1 CodeableConcept Value of extension
Binding: Datum code (preferred)
Extension.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:datumCode.​value[x] Base preferred Datum code 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

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

  • latitude: decimal: The latitude of the geocode
  • longitude: decimal: The longitude of the geocode
  • datumCode: CodeableConcept: The datum used for the lat/long

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NZ Geocode
Extension.extension 2..* Extension Extension
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:latitude 1..1 Extension Extension
Extension.Slices for extension.extension:latitude.extension 0..0 Extension
Extension.Slices for extension.extension:latitude.url 1..1 uri "latitude"
Extension.Slices for extension.extension:latitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:longitude 1..1 Extension Extension
Extension.Slices for extension.extension:longitude.extension 0..0 Extension
Extension.Slices for extension.extension:longitude.url 1..1 uri "longitude"
Extension.Slices for extension.extension:longitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:datumCode 0..1 Extension Extension
Extension.Slices for extension.extension:datumCode.extension 0..0 Extension
Extension.Slices for extension.extension:datumCode.url 1..1 uri "datumCode"
Extension.Slices for extension.extension:datumCode.value[x] 0..1 CodeableConcept Value of extension
Binding: Datum code (preferred)
Extension.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:datumCode.​value[x] Base preferred Datum code 📦1.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NZ Geocode
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:latitude 1..1 Extension Extension
Extension.Slices for extension.extension:latitude.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:latitude.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:latitude.url 1..1 uri "latitude"
Extension.Slices for extension.extension:latitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:longitude 1..1 Extension Extension
Extension.Slices for extension.extension:longitude.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:longitude.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:longitude.url 1..1 uri "longitude"
Extension.Slices for extension.extension:longitude.value[x] 0..1 decimal Value of extension
Extension.Slices for extension.extension:datumCode 0..1 Extension Extension
Extension.Slices for extension.extension:datumCode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:datumCode.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:datumCode.url 1..1 uri "datumCode"
Extension.Slices for extension.extension:datumCode.value[x] 0..1 CodeableConcept Value of extension
Binding: Datum code (preferred)
Extension.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-geocode"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:datumCode.​value[x] Base preferred Datum code 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

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

  • latitude: decimal: The latitude of the geocode
  • longitude: decimal: The longitude of the geocode
  • datumCode: CodeableConcept: The datum used for the lat/long

 

Other representations of profile: CSV, Excel, Schematron