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

Extensions


Extensions defined in this guide

IdUrlContext of UseDescriptionPurpose
esam-id http://hl7.org.nz/fhir/StructureDefinition/esam-id
Location

The id from eSam

Extensions used but defined elsewhere

PathUrlDescriptionIG where defined
Location http://hl7.org.nz/fhir/StructureDefinition/established

The period over which the location or Organization is open

Location http://hl7.org.nz/fhir/StructureDefinition/dhb

District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

Location.alias http://hl7.org.nz/fhir/StructureDefinition/alias-type

Used to indicate what sort of alias is being used in a Location or Organization - eg that it is a legal name.

Location.telecom http://hl7.org.nz/fhir/StructureDefinition/edi-address

Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element.

Organization http://hl7.org.nz/fhir/StructureDefinition/established

The period over which the location or Organization is open

Organization.alias http://hl7.org.nz/fhir/StructureDefinition/alias-type

Used to indicate what sort of alias is being used in a Location or Organization - eg that it is a legal name.

Practitioner http://hl7.org.nz/fhir/StructureDefinition/death-date

The date of death of the individual, plus the source of that information

Practitioner http://hl7.org.nz/fhir/StructureDefinition/educational-qualification

Educational qualifications a practitioner has. These may or may not be related to registration information.

Practitioner http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity

The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

The Stats New Zealand standard can be found here.

Practitioner.qualification http://hl7.org.nz/fhir/StructureDefinition/registration-status-code

An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

Practitioner.qualification http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation

Additional authorisations that a practitioner is authorised to perform

Practitioner.qualification http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice

The type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body.

Practitioner.qualification http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice

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

Practitioner.qualification http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date

The date the practitioner first became registered with the Responsible Authority or professional body

PractitionerRole http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason

The reason for the status. Generally only used for inactive resources.

PractitionerRole http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator

The organisation and person that created this role

PractitionerRole.telecom http://hl7.org.nz/fhir/StructureDefinition/edi-address

Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element.

Address http://hl7.org.nz/fhir/StructureDefinition/nz-geocode

New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

Address http://hl7.org.nz/fhir/StructureDefinition/suburb

Suburb element of a NZ Address.

Address http://hl7.org.nz/fhir/StructureDefinition/building-name

The name of a building cited in an address.

Address http://hl7.org.nz/fhir/StructureDefinition/domicile-code

NZ Domicile Code. Derived from a patient's primary physical, home address.