New Zealand HPI Implementation Guide
0.9.0 - CI Build

New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.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 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: 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 DHB

Returns resources - eg Location - that are in the catchment of the specified DHB

Search on birthdate

Search the Practitioner by birthdate

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.

Electronic connection point

Describes the capabilities for electronic interaction

A facility involved in healthcare

An actual physical location. Represented by a Location model in FHIR

An Organization involved in healthcare

An Organization involved in healthcare

Healthcare provider

A person who delivers care

Provider role

The role of a provider in a care delivery setting

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

Structures: Extension Definitions

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

Esam_id

The id from eSam

Terminology: Value Sets

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

District Health Board Code

A coded type for a DHB.

Use values for a ContactPoint

Use values for a ContactPoint

Use values for a HumanName

Use values for a HumanName

IdentifierUse

Use values for an Identifier

HPI Additional Authorisation

A coded type for additional authorisations.

ISO 3166-1:2013 (2-alpha country code)

2-alpha country codes

Ethnicity New Zealand Standard Classification 2005 (level 4)

Level 4 ethnicity codes

ISO 639-3:2007 (3-alpha language code)

3-alpha language codes

Address Use for Location

Location address use

HPI Alias Type (Location)

A coded type for an alias name for facilities.

HPI Location Type

A coded type for types of facilities.

HPI Name Prefix

A coded type for name prefixes.

Organisation Type

Organisation type

HPI Alias Type (Organization)

A coded type for an alias name for organisation.

PractitonerRole code

The role a practitioner holds.

PractitonerRole status reason

The reason for the current status of PractitionerRole.

HPI Registration Status

A coded type for professional registration status.

HPI Registration Type

A coded type for professional registrations.

HPI 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

District Health Board Code

District Health Board code table.

Ethnicity New Zealand Standard Classification 2005 (level 4)

Ethnicity is a key social factor used with other topics in describing the New Zealand population. Information collected on ethnicity is used to inform, plan, and evaluate services and policies by a wide range of organisations, local authorities and government agencies.

HPI Additional Authorisation

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

HPI Alias Type

A coded type for an alias name.

HPI Country Code

Supplementary country codes to extend ISO3166-1.

Location Type

A coded value for location type.

Organisation Type

A coded value for organisation type.

HPI PractitionerRole status reason

The reason for the current status of PractitionerRole.

HPI Registration Status

The code list represents the current practicing status of the Provider Person as per their registration with an RA or a health worker source.

HPI Registration Type

A code to identify the type of professional registration the healthcare provider person has been assigned.

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

ISO3166-1 two character country code

The purpose of ISO 3166 is to define internationally recognized codes of letters and/or numbers that we can use when we refer to countries and their subdivisions. However, it does not define the names of countries – this information comes from United Nations sources (Terminology Bulletin Country Names and the Country and Region Codes for Statistical Use maintained by the United Nations Statistics Divisions).

ISO 639-3:2007 (3-alpha language code)

ISO 639-3 is a set of codes that defines three-letter identifiers for all known human languages.

Name Prefix

A coded type for name prefixes.

Example: Example Instances

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

practitioner1

Example of practitioner