HL7® FHIR® New Zealand Base Implementation Guide
1.0.0 - Release

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.0.0). 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: Extension Definitions

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

AdditionalAuthorisation

Additional authorisations that a practitioner is authorised to perform

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.

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

NZ Domicile Code

NZ Domicile Code. Derived from a patient’s 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.

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

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.

NZ Citizenship

New Zealand citizenship

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.

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

Primary Healthcare Organisation linked to a NZ Healthcare Service, Location or Patient

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

PractitionerRoleCreator

The organisation and person that created this role

PractitionerRoleStatusReason

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

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

NZ Suburb

Suburb element of a NZ Address.

Terminology: Value Sets

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

All the possible alias types

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

NZ Citizenship status

Citizenship status

District Health Board Identifer

District Health Board Identifer. Assigned by the HPI.

Death date Information Source

The source from where the date of death was sourced

domicileCode

Domicile Code

Ethnicity of a person

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

Funded Programme

Some sort of funded programme

Information Source

The source from where the value of this item was sourced

NZ Residency status

Is the person a NZ resident

PHO

Primary Healthcare Organization

Additional activities that a Practitioner is authorised to perform

A coded type for additional authorisations

Registration Status of Practitioners

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

PractitionerRole status reason

The reason for the current status of PractitionerRole

Scope of practice

A coded type for professional scope of practice.

Terminology: Code Systems

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

Additional Authorisation

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

Type of Alias

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

NZ Citizenship status

Is this person a NZ Citizen

domicileCode

Domicile Code

Level 4 ethnicity codes

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

Funded Programme

Some sort of funded programme

Information Source

All possible sources of information

NZ Residency status

NZ Residency status

PHO

Primary Healthcare Organization

Registration Status of Practitioners

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

PractitionerRole status reason

The reason for the current status of PractitionerRole

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.

Dhb-code

District Health Board code table.

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

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

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

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-dhb

Patient1

patient-domicile-code

Example of Domicile code

patient-information-source

Example of information source

patient-nz-citizenship

Example of citizenship

patient-nz-ethnicity

Example of ethnicity

patient-nz-geocode

Example of geocode

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-status-reason

Example of status reason