HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

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

Resource Profile: NZ Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPatient Version: 1.0.0
Active as of 2024-11-18 Computable Name: NzPatient

The base New Zealand Patient profile

Describe the Base New Zealand Patient resource profileI

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
nz-pat-1: only a single official NHI
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..* CodeableConcept NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
.... nzCitizen 0..1 (Complex) Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
.... dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs

.... domicile-code 0..1 CodeableConcept NZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

.... sex-at-birth 0..1 CodeableConcept Sex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
.... iwi 0..* CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
.... acc-patient-occupation 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation
Binding: ACC Patient Occupation (example)
.... messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
.... nz-residency 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
.... interpreter-required 0..1 boolean Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NHI 0..* Identifier An identifier for this patient
..... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
... name
.... Slices for extension Content/Rules for all slices
..... information-source 0..1 CodeableConcept Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: Information Source (preferred)
... gender
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... genderOriginalText 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
... birthDate
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... information-source 0..1 CodeableConcept Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: Information Source (preferred)
... Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedDateTime 0..1 dateTime Indicates if the individual is deceased or not
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... information-source 0..1 CodeableConcept Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: Information Source (preferred)
... address 0..* NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
nz-pat-1errorPatientonly a single official NHI
: Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

 

Other representations of profile: CSV, Excel, Schematron