New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Home

Official URL: https://fhir-ig.digital.health.nz/ImplementationGuide/tewhatuora.hpi Version: 1.5.0
Active as of 2024-09-06 Computable Name: NewZealandHPIIG

This is the Implementation Guide for the HL7® FHIR© interface to the New Zealand HPI - Health Provider Index. It brings together all the artifacts that are necessary to understand and use the FHIR API. It is based on FHIR R4 and NZBase IG 2.0-rc1

The HPI (Health Provider Index) is a national registry service that holds information about the providers of healthcare in New Zealand, including the organizations where they work and the facilities that they work from.

The key entities that are supported are:

The Person - described by the FHIR HPIPractitioner resource.

Facilities where healthcare is provided from. These are represented by HPILocation resource.

Organizations such as DHB’s, PHO,s and primary care organizations. These are represented by the HPIOrganization resource.

In addition, there is support for registering where a Practitioner works, and in what role - the HPIPractitionerRole resource.

The HPI serves 2 primary purposes:

  • A unique identifier for each individual or entity
  • An authoritative source for the key information about that entity.

Description of tabs

  • Business view: Business context of the HPI
  • Use Cases: Expected Use Cases that the HPI supports
  • General notes: Common notes about how the API and contents are organized
  • API: The specific API features supported by the HPI.
  • Profiles: A list of the profiles that are defined by the guide.
  • Extensions: A list of the extensions defined by the guide, and extensions that are defined elsewhere.
  • Terminology: List of the FHIR terminology artifacts defined within this implementation guide For other FHIR terminology see the HL7® FHIR® New Zealand Base Implementation Guide. Links can be found from each of the artifacts in the patient and address profiles).
  • FAQ: Frequently Asked Questions
  • Artifact Index: A page with all artifacts (Logical Models, Profiles, Extensions, Terminology and others) defined in this guide. This page largely duplicates information in the Profiles and Extensions tab.
  • Support Links to the FHIR spec and downloads.

Identifiers

This IG makes extensive use of identifiers - such as the HPI Person ID (CPN). These are defined in the New Zealand Base IG on the identifiers tab there.

Note that these identifiers are correct as at the time of publishing the Base IG. When new identifiers are added, they will be present in the build version of NZBase (that has not yet been approved for release)

### Source

​ This IG was built from github branch: commit id: 9b09bc4ff144b7036aa8e1f77902879a3150e181