HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - 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.1.0 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Condition resource for use in NZ

This profile adds the Long-Term Condition extension to the base Condition resource

Coverage resource for use in NZ (Trial use)

Coverage resource for use in NZ (Trial use)

HealthcareService resource for use in NZ

HealthcareService resource for use in NZ

Location resource for use in NZ

Location resource for use in NZ

Medication Dispense resource for use in NZ

Medication Dispense resource for use in NZ

Medication resource for use in NZ

Medication resource for use in NZ

MedicationRequest resource for use in NZ

MedicationRequest resource for use in NZ

MedicationStatement resource for use in NZ

MedicationStatement resource for use in NZ

NZ Patient

The base New Zealand Patient profile

NZ RelatedPerson

The base New Zealand RelatedPerson profile

Organization resource for use in NZ

Organization resource for use in NZ

Practitioner resource for use in NZ

Practitioner resource for use in NZ

PractitionerRole resource for use in NZ

PractitionerRole resource for use in NZ

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

Common NZ Address datatype

Adds building name, suburb, domicile code and geocode to the Address datatype

Common NZ ContactPoint datatype

This profile adds the Contact Point Purpose and EDI address extensions to the standard data type

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

A specific purpose for which this ContactPoint dataType would be used

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.

AccPatientOccupation

Codes to describe a patient’s occupation, using ACC’s patient occupation codeset.

Note that the current ValueSet binding contains codes from NZSC099. ACC are planning to update this ValueSet to base the codes on ANZSCO at the request of Stats NZ (Timing TBC), so the binding strength has been left as ‘example’.

AdditionalAuthorisation

Additional authorisations that a practitioner is authorised to perform in addition to their registration and scope of practice. Examples include:

  • Prescribing authorisation for a nurse practitioner
  • Authorisation to administer immunisations
AliasType

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

Building Name

The name of a building cited in an address.

ConditionOnPractice

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

Country Name

The display name for a country in an address.

Date of death

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

District Health Board linked to a NZ Healthcare Service, Location or Patient

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

EDI Address

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. Note that a new extension ‘messaging address’ is preferred.

EducationalQualification

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

Established

The period over which the location or Organization is open

Funded Healthcare Programme

Funded NZ Healthcare Programmes

GenderOriginalText

Text provided by the person with the choice of ‘Another gender’ (The FHIR AdministrativeGender CodeSystem codes this as ‘other’).

Information Source

The official source of information held about a patient.

Long Term Condition Indicator

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.

MaoriDescent

Code indicating whether the person is of Māori descent

Messaging Address

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

NZ Citizenship

New Zealand citizenship

NZ Domicile Code

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

NZ Ethnicity

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.

NZ Geocode

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

NZ Suburb

Suburb element of a NZ Address.

NZResidency

NZ Residency status

NZePS Long Term Medication Indicator

NZePS Long Term Medication Indicator

NZePS Supply Period Reason

The reason for a non-standard Supply Period.

NZePS Unusual Dose Quantity Indicator

NZePS Unusual Dose Quantity Indicator

Nz_iwi

Persons Iwi affiliation

Nzf_atc

Anatomical Therapeutic Chemical (ATC) Classification - see https://www.who.int/tools/atc-ddd-toolkit/atc-classification

Nzf_nzmt_type

The NZ Medicines Terminology (NZMT) Data Class – MP (Medicinal Product), MPUU (Medicinal Product Unit of Use), MPP (Medicinal Product Pack), TP (Trade Product), TPUU (Trade Product Unit of Use), TPP (Trade Product Pack) or CTPP (Containered Trade Product Pack) – that the Medication is a member of.

PractitionerRoleCreator

The organisation and person that created this role

PractitionerRoleStatusReason

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

Primary Healthcare Organisation

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

RegistrationInitialDate

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

RegistrationStatusCode

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

ScopeOfPractice

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

Sex At Birth

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

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ACC Patient Occupation

ValueSet of codes for classifying patient occupations, drawn from the ACC codeset

Additional Practitioner authorisations

A coded type for additional authorisations

Alias types

The complete set of alias types that apply to Locations and Organizations

ContactPoint purpose

The purpose of a ContactPoint - what it is used for.

Coverage Category

New Zealand codes for Coverage category types

Coverage Type

New Zealand codes for Coverage Types

Datum code

Datum codes used

Death date Information Source

The source from where the date of death was sourced

District Health Board Identifer

District Health Board Identifer. Assigned by the HPI.

Domicile Code

Domicile Code

Ethnicity of a person (L4)

Codes to record a person’s ethnicity, drawn from Level 4 of the Ethnicity code system

Ethnicity of a person (full)

Ethnicity New Zealand Standard Classification 2005. Ethnicity is the ethnic group or groups that people identify with or feel they belong to.

Funded Programme

Codes to describe NZ-specific types of funded programmes.

Information Source

The source from where the value of this item was sourced

Iwi

New Zealand iwi codes. The 2 digit codes are abstract codes and provided in the expansion for navigational purposes. A user should not select an abstract code directly as a proper value.

Māori Descent

A code indicating whether a person is of Māori descent

NZ Citizenship status

Citizenship status

NZ Residency status

Is the person a NZ resident

PHO

Primary Healthcare Organization

PractitionerRole status reason

The reason for the change in status of PractitionerRole

Registration Status of Practitioners

The code list represents the current practicing status of the Provider Person as per their registration with an RA.

Scope of practice

A coded type for professional scope of practice.

Valid use values for NHI

NHI Use codes

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

ACC Patient Occupation CodeSystem

Codes for classifying patient occupations, drawn from the ACC codeset

Additional Authorisation

Additional authorisations that a practitioner is authorised to practice or prescribe.

ContactPoint purpose

The purpose of a ContactPoint - what it is used for.

Coverage category

New Zealand codes for Coverage category types

Coverage type

New Zealand codes for Coverage Types

Datum codes

Possible datum codes

Domicile Code

Domicile Code

Funded Programme

Codes to describe NZ-specific types of funded programmes.

Information Source

All possible sources of information

Level 4 ethnicity codes

Codes to record a person’s ethnicity, drawn from Level 4 of the Ethnicity code system described here

Māori Descent

Codes for classifying Māori descent. Defined by Stats NZ - Māori descent v1.0.0

NZ Citizenship status

Is this person a NZ Citizen

NZ DHB

NZ District Health Board (HPI-ORG) Codes

NZ Iwi

NZ Iwi Statistical Standard

NZ Residency status

NZ Residency status

NZ ethnic group codes

Ethnicity New Zealand Standard Classification 2005. Ethnicity is the ethnic group or groups that people identify with or feel they belong to.

PHO

Primary Healthcare Organization

PractitionerRole status reason

The reason for the change in status of PractitionerRole

Registration Status of Practitioners

The code list represents the current practicing status of the Provider Person as per their registration with an RA.

Scope of practice

A classification of the type or range of health services that a practitioner is authorised to provide, as determined by the Responsible Authority or other statutory authority (e.g. PHARMAC), that is, what the practitioner can or cannot do. It includes Scope of Practice as defined by the Health Practitioners Competence Assurance Act 2003, any special authorisations granted, and any conditions or limitations imposed by the Responsible Authority.

Type of Alias

Used in Organization and Location to indicate what is the type of Alias

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

hpiFacility

HPI facilities

hpiOrganization

HPI organizations

hpiProvider

HPI providers

hpipractitionerrole

HPI PractitionerRole id

nhi

NHI number

nzACC45

ACC 45 number

nzbn

New Zealand Business Number

nzchrir

Chiropractic Board Register number

nzdental

Dental Council Register Number

nzdiet

Dietitians Board Register Number

nzmc

Medical Council of New Zealand Register Number

nzmwife

Midwifery Council Register Number

nznc

Nursing Council of New Zealand Register Number

nzocc

Occupational Therapy Board Register Number

nzopt

Optometrists & Dispensing Opticians Board Register Number

nzost

Osteopathic Council Register Number

nzparamed

Paramedic Council Register Number

nzpharm

Pharmacy Council of New Zealand Register Number

nzphysio

Physiotherapy Board Register Number

nzpod

Podiatrists Board Register Number

nzpsycho

Psychotherapists Board register Number

nzpsyhc

Psychologists Board Register Number

nzrad

Medical Radiation Technologists Board Register Number

nzscience

Medical Sciences Council Register Number

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

CoverageCSC

CSC Coverage example

CoverageGMS

GMS Coverage example

CoverageHUHC

HUHC Coverage example

condition-long-term-condition

Example of long term condition

location-alias-type

A location with an alias type against the alias.

location-established

A location with the date established

medicationrequest-nzeps-long-term-medication

Example of long term medication

medicationrequest-nzeps-supply-period-reason

Example of supply period reason

medicationrequest-nzeps-unusual-dose-quantity

Example of sunusual does quantity

organization-edi-address

Example of edi address extension

organization-funded-programme

Example of Funded programme

organization-moh

Ministrt Of Health

patient-address-building-name

Patient with building name in the address

patient-address-suburb

Patient with building name and suburb in the address

patient-building-name

Example of building name extension

patient-deceased-information-source

Example of information source

patient-dhb

Patient1

patient-domicile-code

Example of Domicile code

patient-information-source

Example of information source

patient-messaging-address

Patient1

patient-nhi

Example of PHO

patient-nz-citizenship

Example of citizenship

patient-nz-ethnicity

Example of ethnicity

patient-nz-geocode

Example of geocode

patient-nz-residency

Example of citizenship

patient-pho

Example of PHO

patient-sex-at-birth

Example of a Patient with the sex at birth extension

patient-suburb

Example of suburb

practitioner-additional-authorisation

Additional authorisation example - to give immunizations in 2021

practitioner-condition-on-practice

Example of Condition on practice

practitioner-death-date

Example of Practitioner with detah date

practitioner-edi-address

Example of Condition on practice

practitioner-educational-qualification

Example of educational qualification

practitioner-registration-initial-date

Example of Initial date of registration

practitioner-registration-status-code

Example of registration status

practitioner-scope-of-practice

Example of scope of practice

practitionerRole-creator

The creator of a practitioner role. Uses a contained resource.

practitionerRole-messaging-address

Example of status reason

practitionerRole-status-reason

Example of status reason