New Zealand NHI IG
1.5.4 - Release

New Zealand NHI IG - Local Development build (v1.5.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: NHI Address

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NhiAddress Version: 1.5.4
Active as of 2024-06-26 Computable Name: NhiAddress

Adds additional, NHI specific extensions

Usage:

Formal Views of Profile Content

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

This structure is derived from NzAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address NzAddress
... Slices for extension Content/Rules for all slices
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
... type 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
... state 0..0
... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
... period 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... 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
.... 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)
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
Example General: home
... type Σ 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
Example General: both

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* NzAddress 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
.... 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
.... 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)
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
Example General: home
... 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
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

This structure is derived from NzAddress

Cannot invoke "Object.hashCode()" because "key" is null

Differential View

This structure is derived from NzAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address NzAddress
... Slices for extension Content/Rules for all slices
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
... type 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
... state 0..0
... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
... period 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... 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
.... 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)
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
Example General: home
... type Σ 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
Example General: both

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* NzAddress 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
.... 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
.... 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)
.... notValidatedAddressReason 0..1 CodeableConcept The reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated Reason (preferred)
.... nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
.... nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
Example General: home
... 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
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

This structure is derived from NzAddress

Cannot invoke "Object.hashCode()" because "key" is null

 

Other representations of profile: CSV, Excel, Schematron