New Zealand HPI IG
0.2.0 - CI Build

New Zealand HPI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). 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 complying with the implementation guide are expected to declare conformance to one or more of the following capability statements.

CapabilityStatement

Represents API exposed by HPI

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search on birthdate

Search the Practitioner by birthdate

Search on Registration Authority identifier

Search the Registration Authority identifier

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

HpiEndpointLM

The enpoint resource used by the HPI

HpiLocationLM

The Location resource used by the HPI service

HpiOrganizationLM

The Organization resource used by the HPI application.

HpiPractitionerLM

The Practitioner exposed by the HPI

Use cases:

  • What is a person’s CPN when I know the persons registration number i.e. Get using registration number
  • What is a person’s CPN when the person doesn’t have a registration i.e. search by name, gender
  • What is a person’s CPN when I don’t know the person’s registration number or CPN i.e. search by name, gender scope of practice
  • What are a practitioner’s details (eg practicing certificate dates) when I have a CPN. ie. Get using CPN
HpiPractitionerRoleLM

HpiPractitionerRole

Structures: Resource Profiles

These define constraints on FHIR resources that need to be complied with by conformant implementations

NZ Location

NZ common Location profile. Adds slicing for HPI Facility code and uses nzAddress

NZ Organization

base NZ Organization profile. Slices on identifier for HPI and uses nzAddress

NZ Practitioner

The New Zealand base practitioner. Slices on identifier for CPN, makes name mandatory and uses NZ address.

HPI Endpoint
HPI Location

Locations used by the HPI. These are also called Facilities.

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 care - regardless of qualification.

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 multple organizations.

Structures: Extension Definitions

These define constraints on FHIR data types that need to be complied with by conformant implementations

AdditionalAuthorization

Additional authorizations that a practitioner is authorized to perform

AliasType

Indicates the type of alias name. VS Binding is done by the profile.

ConditionOnPractice

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

DeathDate

The date the person died.

Dhb

The District Health Board the patient resides in and a Location is associated with. It is derived from the patient’s primary residential address (not updated directly).

EducationalQualification

Educational qualifications.

LocationEstablished

The period over which the location is open

OrganizationEstablished

The period over which the Organization is active

PractitionerRoleCreator

The organisation and person that created this role

PractitionerRoleStatus

The status of the role - active,ended

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 authorized to perform, as determined by the Responsible Authority or professional body.

Terminology: Value Sets

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

Use values for an Address

Use values for an Address

Use values for a ContactPoint

Use values for a ContactPoint

District Health Board HPI Organisation Identifer

District Health Board HPI Organisation Identifer

Type of Payload in an Endpoint

Type of Payload in an Endpoint

Use values for a HumanName

Use values for a HumanName

Use values for an identifier

Use values for an identifier

Location alias types

The set of alias types that apply to Locations

Status of Location - is it still in use

Status of Location - is it still in use

Type of location

Type of Location

Organization alias types

The set of alias types that apply to Organizations

Additional Authorisation for functions that a Practitioner can 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.

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

PractitonerRole status reason

The reason for the current status of PractitionerRole

Scope of practice

A coded type for professional scope of practice.

Professional registration the healthcare provider has

Professional registration the healthcare provider has

Terminology: Code Systems

These define new code systems used by systems conforming with 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

District Health Board Code

District Health Board Code

Type of Payload in an Endpoint

Type of Payload in an Endpoint

Type of Location

Type of Location

Professional registration the healthcare provider has

Professional registration the healthcare provider has

Registration Status of Practitioners

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

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

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

Terminology: Naming Systems

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

hpiFacility

HPI facilities

hpiOrganization

HPI organizations

hpiProvider

HPI providers

hpipractitionerrole

HPI PractitionerRole id

nzbn

New Zealand Business Number

nzchrir

Chiropractic Board Register number

nzdental

Dental Council Register Number

nzdiet

Dietitians Board Register Number

nzlab

Medical Laboratory Science 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

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

Example: Example Instances

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

cmdhb

Counties Manakau DHB

commonOrg1
drmulti
drwelby

An example of practitioner. Used as a target by some of the other examples

ep1
location1

Fully equipped General Practice

organization1
practitioner3
practitionerX
practitionerY
practitionerrole1
scen1-ghc
scen1-pharm1
scen1-pr1
scen1-pr2
scen1-prac1