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

Artifacts Summary

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

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

CapabilityStatement

Represents API exposed by HPI

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Updates a health provider's name, birthdate and death-date.

A custom operation which updates a health provider's name, birthdate and death-date.

Structures: Resource Profiles

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

HPI Location

A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility.

HPI Organization

An entity that provides services of interest to, or is involved in, the business of health care service provision.

HPI Practitioner

The practitioner exposed by the HPI. This is the person who delivers healthcare or healthcare related services.

HPI Practitioner role

The practitioner role exposed by the HPI. Used to connect Practitioners with Organizations and Locations, indicating the role they have. A single Practitioner can have roles with multiple organizations.

Structures: Extension Definitions

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

Esam_id

The id from eSam

Example: Example Instances

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

90ZZLP

Example HPI Practitioner with No Registration 'NR' with confidentiality R

91ZABY

Example HPI Practitioner with one registration

92ZZRE

Example HPI Practitioner with No Registration 'NR'

98ZZQJ

Example HPI Practitioner with two registrations

FZZ941-D

Example HPI Location Inactive (disestablished)

FZZ958-K

Example HPI Location with Managing Org

FZZ999-B

Example HPI Location with messaging address

GZZ956-B

Example HPI Organization

GZZ991-D

Example HPI Organization 'partof'

R00000012-G

Example HPI PractitionerRole Medical Receptionist

R00000015-C

Example HPI PractitionerRole with confidentiality R

R00000029-P

Example HPI PractitionerRole with messagin address