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

Extensions

IdUrlContext of UseDescriptionPurpose Status
additional-authorisation http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification

Additional authorisations that a practitioner is authorised to perform

active
alias-type http://hl7.org.nz/fhir/StructureDefinition/alias-type
Location.alias
Organization.alias

Used to indicate what sort of alias is being used in a Location or Organization - eg that it is a legal name.

active
building-name http://hl7.org.nz/fhir/StructureDefinition/building-name
Address

The name of a building cited in an address.

active
condition-on-practice http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification

A full description of the conditions the health practitioner is subject to in relation to their scope of practice.

active
contactpoint-purpose http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
ContactPoint

A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.

active
death-date http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner

The date of death of the individual, plus the source of that information

active
dhb http://hl7.org.nz/fhir/StructureDefinition/dhb
HealthcareService
Location
Patient

District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related District Health Board.

active
domicile-code http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient
Address

NZ Domicile Code. Derived from a patient's primary physical, home address.

active
edi-address http://hl7.org.nz/fhir/StructureDefinition/edi-address
ContactPoint.system

Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element.

active
educational-qualification http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.qualification
Practitioner

Educational qualifications a practitioner has. These may or may not be related to registration information.

active
established http://hl7.org.nz/fhir/StructureDefinition/established
Location
Organization

The period over which the location or Organization is open

active
funded-programme http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location
Organization
HealthcareService

Funded NZ Healthcare Programmes

Details of a NZ Healthcare Funded Programme relevant to its implementation status at an individual organisation, facility or service.

active
information-source http://hl7.org.nz/fhir/StructureDefinition/information-source
Patient.name
Patient.birthDate
Patient.deceased.ofType(dateTime)

The official source of information held about a patient.

active
long-term-condition http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition

Long Term Condition Indicator. A long term condition can be defined as any ongoing, long term or recurring conditions that can have a significant impact on people’s lives.

Long term condition indicator (see https://www.health.govt.nz/our-work/diseases-and-conditions/long-term-conditions).

active
messaging-address http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient
Location
Organization
HealthcareService
PractitionerRole

The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address

active
nz-citizenship http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient

New Zealand citizenship

active
nz-ethnicity http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient
Practitioner
RelatedPerson

The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

The Stats New Zealand standard can be found here.

active
nz-geocode http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Address

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

active
nz-iwi http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Patient
Practitioner
RelatedPerson

Persons Iwi affiliation

active
nz-residency-status http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
Patient

NZ Residency status

active
nzeps-long-term-medication http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
MedicationRequest
MedicationStatement

NZePS Long Term Medication Indicator

This has specific uses in NZ Pharmacy and GP systems for funding and clinical purposes. It is also part of the HISO 10041.1 standard for Medication Lists.

active
nzeps-supply-period-reason http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
MedicationRequest

The reason for a non-standard Supply Period.

The reason for a non-standard supply period, e.g. the patient going abroad.

active
nzeps-unusual-dose-quantity http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
MedicationRequest

NZePS Unusual Dose Quantity Indicator

Indicates if an unusual dose quantity has been prescribed deliberately.

active
pho http://hl7.org.nz/fhir/StructureDefinition/pho
HealthcareService
Location
Patient

Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related Primary Healthcare Organisation.

active
practitionerRole-creator http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
PractitionerRole

The organisation and person that created this role

active
practitionerRole-status-reason http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason
PractitionerRole

The reason for the status. Generally only used for inactive resources.

active
registration-initial-date http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification

The date the practitioner first became registered with the Responsible Authority or professional body

active
registration-status-code http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification

An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

active
scope-of-practice http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification

The type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body.

active
sex-at-birth http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Patient

A person’s sex at the time of their birth (considered to be immutable).

active
suburb http://hl7.org.nz/fhir/StructureDefinition/suburb
Address

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).

active