New Zealand HPI Implementation Guide
0.2.0 - CI Build

New Zealand HPI Implementation Guide, 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 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 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.

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

Use values for an Address

Use values for an Address

Use values for a ContactPoint

Use values for a ContactPoint

Use values for a HumanName

Use values for a HumanName

Use values for an identifier

Use values for an identifier

Status of Location - is it still in use

Status of Location - is it still in use

Type of location

Type of Location

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

PractitionerRole status reason

The reason for the current status of PractitionerRole

Professional registration the healthcare provider has

Professional registration the healthcare provider has

Terminology: Code Systems

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

Type of Location

Type of Location

Professional registration the healthcare provider has

Professional registration the healthcare provider has

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

PractitionerRole status reason

The reason for the current status of PractitionerRole

Example: Example Instances

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

hltest

Patient1