New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org.nz/fhir/StructureDefinition/hpi-nz-address |
Version: | 0.9.0 |
Name: | NzAddress |
Title: | Common NZ Address datatype |
Status: | Active as of 12/3/21, 2:22 AM |
Definition: | Adds building name, suburb, domicile code and geocode to the Address datatype |
Publisher: | Ministry of Health |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/StructureDefinition/hpi-nz-address
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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: domicileCode (preferred) | |
esam-id | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
district | 0..0 | |||
state | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | 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: domicileCode (preferred) | |
esam-id | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
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) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
Documentation for this format |
This structure is derived from Address
Differential View
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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: domicileCode (preferred) | |
esam-id | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
district | 0..0 | |||
state | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | 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: domicileCode (preferred) | |
esam-id | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
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) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Address.use | required | AddressUse |
Address.type | required | AddressType |