HL7® FHIR® New Zealand Base Implementation Guide
2.1-rc2 - CI Build

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This is not an authorized publication; it is the continuous build for version 2.1-rc2). This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

Extension: Pho - Detailed Descriptions

Active as of 2020-11-06 Maturity Level: 1

Definitions for the pho extension.

1. Extension

Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

Control0..* This element is affected by the following invariants: ele-1
2. Extension.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

3. Extension.extension

An Extension

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url

Source of the definition for the extension code - a logical name or a URL.


The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/pho
5. Extension.value[x]

NZ Primary Healthcare Organisations as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.

BindingThe codes SHALL be taken from PHO; other codes may be used where these codes are not suitable NZ HPI-ORG Values for PHO
[x] NoteSee Choice of Data Types for further information about how to use [x]

The Nzpho ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 30 Primary Healthcare Organisations.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.

Procare Networks Ltd:<valueCodeableConcept xmlns="http://hl7.org/fhir">
    <system value="https://standards.digital.health.nz/ns/pho-code"/>
    <version value="1.0"/>
    <code value="G05533-K"/>
    <display value="Procare Networks Limited"/>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))