New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHI Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NhiPatient | Version: 1.6.5
Active as of 2026-02-09 | Computable Name: NhiPatient

The Patient resource exposed by the NHI.

Describe the Patient resource exposed by the NHI

### Core NHI Profile attributes

The NHI Patient resource represents the nationally held identity data for a patient.

This includes the core NHI Profile attributes:

- name (including alternative names such as maiden names)
- NHI number (live and any dormants)
- address
- date of birth
- gender
- New Zealand citizenship status
- place of birth
- ethnicity
- date of death

The core NHI Profile attributes are returned to all users that have read and/or $match access to the NHI

### Key differences from HL7 FHIR Patient specification

- Ethnicity extension
- NZ Citizenship extension
- Dhb extension
- Birthplace extension
- Name
  - information source extension
  - preferred extension
  - nhi-name-use-extra extension
- Gender original text extension
- Birthdate information source extension
- Deceased date information source extension
- Address
  - nz-geocode extension
  - suburb extension
  - building-name extension
  - domicile-code extension
  - notValidatedAddressReason extension
  - nz-address-id extension
  - nz-address-derived extension

### New NHI Number Format and check digit calculation

For more information click here for website links or click here for the consumer health identity standard, that includes the check digit calculation.

### Patient's General Practice

The details for a patient’s General Practice (GP) are returned in the NHI Patient Profile to users who have permission to access a patient’s National Enrolment Service (NES) information.

This is an additional permission required on your NHI FHIR account.

The NES details are maintained in real time in the NES database, which holds the relationship of a Patient (NHI number), to their GP Practice (hpi-organisation-id), GP clinic (hpi-facility-id) and where available the patient's usual doctor (hpi-person-id / CPN).

Changes to the NES in October 2023 allows a patient’s GP Practice details to be recorded for both patients that are funded and also patients who are registered with a practice but not eligible for PHO funding. This change allows the Get Patient response to return the GP Practice details for both types of patients.

The expiry date for a registered patient is set to 01/01/2100 whereas the expiry date for an enrolled patient is never more than 3 years in the future.

For more information on what is available in the NES FHIR API please see NES UAT Implementation guide.

In the NHI the patient's GP is only returned with a read on the resource. It is not returned in the $match response – even if a user has the correct permissions.

The patient version-id does not change when the GP changes. This is because the patient's GP is not held in the NHI but is retrieved from the National Enrolment Service and returned along with the NHI details in the NHI Patient profile. The patient version-id only reflects changes to details held on the NHI.

For information on enrolment history, re-enrolment dates, enrolment status, or the last visit date (qualified encounter date) please subscribe to the NES.

A subset of the NES enrolment information is returned in the NHI FHIR GET response.

Enrolment information is returned in two places in the NHI patient profile:

- the "generalPractitioner" attribute: This is the NES enrolment id.
- the "contained" PractitionerRole resource: This holds the NES enrolment information as described below.

#### NES to FHIR mapping

FHIR attribute (PractitionerRole Resource) | NES Enrolment Information | Description
--- | --- | ---
id | The NES enrolment id | Unique identifier of the patient's enrolment record. This will change when a patient transfers to a new practice, but will not reflect minor changes within an enrolment.
Period.start | enrolment.startDate | The date on which the Enrolment starts
Period.end | enrolment.expiryDate | The future date on which the Enrolment will expire.
Practitioner (reference / display) | Practitioner identifier (CPN) and name | The hpi-person-id (CPN) and name of the Practitioner who primarily provides the service to the person.
Organization (reference / display) | enrolling organisation ID and name | The hpi-organisation-id and name of the Organisation who the person enrols with for the Heath Service.
Location (reference / display) | Facility ID and name | The hpi-facility-id and name of the Facility where the person primarily receives the service.

#### Example of contained resource

    "contained": [
            {
                "resourceType": "PractitionerRole",
                "id": "525599",
                "period": {
                    "start": "2023-01-26T00:00:00+13:00",
                    "end": "2026-01-26T00:00:00+13:00"
                },
                "practitioner": {
                    "reference": "Practitioner/25ADNX",
                    "display": "Dr Nick"
                },
                "organization": {
                    "reference": "Organization/GAAAAA-0"
                    "display": "Riviera Health Care"
                },
                "location": [
                    {
                        "reference": "Location/FZZ862-H",
                        "display": "Dr Nick's Guaranteed Health Clinic"
                    }
                ]
            }
        ]

### Patient's Contact details

The patient’s contact details are returned in the Patient.telecom attribute to users who have permission to access Patient Preferences. This is an additional permission required on your NHI FHIR account.

The contact details are only returned with a read on the resource. They are not returned in the $match response – even if a user has the correct permissions.

The patient version-id does not change when the patient's contact details change. This is because the patient's contact details are not held in the NHI but are retrieved from the National Enrolment Service and returned along with the NHI details in the NHI Patient profile. The Patient Version-id only reflects changes to details held on the NHI.

The information returned may include:

- 1x email address,
- 1x home phone number,
- 1x mobile phone number

#### Example of Patient contact details

        "telecom": [
        {
          "id": "17",
          "system": "email",
          "value": "test.contact@testContact.com",
          "use": "home",
          "extension": [
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isVerified",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isPrivate",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isShared",
              "valueBoolean": false
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/context",
              "valueString": "any time"
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate",
              "valueDate": "2024-07-21"
            }
          ]
        },
        {
          "id": "18",
          "system": "phone",
          "value": "027 123 4567",
          "use": "mobile",
          "extension": [
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isVerified",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isPrivate",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isShared",
              "valueBoolean": false
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/context",
              "valueString": "between 9am and 6pm only"
            }
          ]
        },
        {
          "id": "19",
          "system": "phone",
          "value": "045882334",
          "use": "home",
          "extension": [
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isVerified",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isPrivate",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/isShared",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/context",
              "valueString": "between 9am and 6pm only"
            },
            {
              "url": "http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate",
              "valueDate": "2025-01-17"
            }
          ]
        }
      ]

Usages:

- Derived from this Profile: Create NHI Patient
- Examples for this Profile: Patient/ZAA0792, Patient/ZAT2348, Patient/ZAT2496, Patient/ZJM9397 and Patient/ZKC4633
- CapabilityStatements using this Profile: CapabilityStatement[http://hl7.org.nz/fhir/ig/nhi/CapabilityStatement/NhiCapabilityStatement|1.6.5]

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1, nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension |  |  |  | Content/Rules for all slices
extension:status |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred)
extension:source |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
extension: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
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
telecom | C | 0..3 | NhiContactPoint | The Paient's contact details Constraints: cpt-2
Slices for extension |  |  |  | Content/Rules for all slices
extension:isVerified |  | 0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified
extension:isShared |  | 0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared
extension:isPrivate |  | 0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate
extension:context |  | 0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context
extension:lastUpdatedDate |  | 0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate
system | Σ C | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:status.value[x]:valueCodeableConcept | Base | preferred | NZ Citizenship status | 📦1.1.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:NHI.​use | Base | required | Valid use values for NHI | 📦2.0.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | Patient.telecom | A system is required if a value is provided. | `value.empty() or system.exists()`
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`
nz-pat-1 | error | Patient | only a single official NHI | `Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2`

This structure is derived from NzPatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..6 | Nz_ethnicity | NZ Ethnicity
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | Nz_citizenship | This field indicates New Zealand citizenship status of the patient
Slices for extension |  |  |  | Content/Rules for all slices
extension:source |  | 0..1 | Extension | Extension
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
extension:domicile-code |  | 0..0 |  | NZ Domicile Code
extension:pho |  | 0..0 |  | Primary Healthcare Organisation
extension:sex-at-birth |  | 0..0 |  | Sex At Birth
extension:iwi |  | 0..0 |  | Extension
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
Slices for identifier |  | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
type |  | 0..0 |  | Description of identifier
period |  | 0..0 |  | Time period when id is/was valid for use
identifier:NHI |  | 0..* | Identifier | An identifier for this patient
type |  | 0..0 |  | Description of identifier
period |  | 0..0 |  | Time period when id is/was valid for use
active |  | 0..0 |  | Whether this patient's record is in active use
name |  |  |  |
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required)
extension:preferred |  | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
extension:nhi-name-use-extra |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required)
use |  | 0..1 | code | temp | nickname | maiden
text |  | 0..0 |  | Text representation of the full name
given |  | 0..2 | string | Given name and other given name(s)
prefix |  | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required)
suffix |  | 0..0 |  | Parts that come after the name
period |  | 0..0 |  | Time period when name was/is in use
telecom |  | 0..3 | NhiContactPoint | The Paient's contact details
system |  | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
use |  | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
rank |  | 0..0 |  | Specify preferred order of use (1 = highest)
period |  | 0..0 |  | Time period when the contact point was/is in use
gender |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:originalText |  | 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
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required)
deceased[x] |  | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line |  | 1..* | string | Street name, number, direction & P.O. Box etc.
maritalStatus |  | 0..0 |  | Marital (civil) status of a patient
multipleBirth[x] |  | 0..0 |  | Whether patient is part of a multiple birth
photo |  | 0..0 |  | Image of the patient
contact |  | 0..0 |  | A contact party (e.g. guardian, partner, friend) for the patient
communication |  | 0..0 |  | A language which may be used to communicate with the patient about his or her health
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
managingOrganization |  | 0..0 |  | Organization that is the custodian of the patient record
link |  | 0..0 |  | Link to another patient resource that concerns the same actual person
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.name.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Name Information Source | 📦1.3 | HIP FHIR Common Terminology Guide v1.9
Patient.name.prefix | Base | required | Name Prefix Codes | 📦2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.birthDate.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Birth Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9

#### Constraints

Id | Grade | Path(s) | Description | Expression
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1, nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ethnicity |  | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:status |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred)
extension:source |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
extension: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
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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
value | Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
name | Σ | 0..* | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required)
extension:preferred |  | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
extension:nhi-name-use-extra |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required)
use | ?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..2 | string | Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | C | 0..3 | NhiContactPoint | The Paient's contact details Constraints: cpt-2
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:isVerified |  | 0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified
extension:isShared |  | 0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared
extension:isPrivate |  | 0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate
extension:context |  | 0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context
extension:lastUpdatedDate |  | 0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate
system | Σ C | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:originalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value |  | 0..1 | string | Primitive value for code
birthDate | Σ | 0..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required)
value |  | 0..1 | date | Primitive value for date
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
value |  | 0..1 | dateTime | Primitive value for dateTime
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:status.value[x]:valueCodeableConcept | Base | preferred | NZ Citizenship status | 📦1.1.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:NHI.​use | Base | required | Valid use values for NHI | 📦2.0.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.name.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Name Information Source | 📦1.3 | HIP FHIR Common Terminology Guide v1.9
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name.prefix | Base | required | Name Prefix Codes | 📦2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.birthDate.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Birth Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | Patient.telecom | A system is required if a value is provided. | `value.empty() or system.exists()`
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`
nz-pat-1 | error | Patient | only a single official NHI | `Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2`

This structure is derived from NzPatient

Summary

Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 21 elements

Structures

This structure refers to these other structures:

- NHI ContactPoint (http://hl7.org.nz/fhir/StructureDefinition/nhi-contact-point)
- NHI Address (http://hl7.org.nz/fhir/StructureDefinition/NhiAddress)

Extensions

This structure refers to these extensions:

- http://hl7.org.nz/fhir/StructureDefinition/birth-place
- http://hl7.org.nz/fhir/StructureDefinition/information-source
- http://hl7.org/fhir/StructureDefinition/iso21090-preferred
- http://hl7.org.nz/fhir/StructureDefinition/name-use-extra
- http://hl7.org.nz/fhir/StructureDefinition/gender-original-text

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.contained (Closed)
- The element 1 is sliced based on the value of Patient.identifier (Closed)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1, nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension |  |  |  | Content/Rules for all slices
extension:status |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred)
extension:source |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
extension: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
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
telecom | C | 0..3 | NhiContactPoint | The Paient's contact details Constraints: cpt-2
Slices for extension |  |  |  | Content/Rules for all slices
extension:isVerified |  | 0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified
extension:isShared |  | 0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared
extension:isPrivate |  | 0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate
extension:context |  | 0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context
extension:lastUpdatedDate |  | 0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate
system | Σ C | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:status.value[x]:valueCodeableConcept | Base | preferred | NZ Citizenship status | 📦1.1.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:NHI.​use | Base | required | Valid use values for NHI | 📦2.0.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | Patient.telecom | A system is required if a value is provided. | `value.empty() or system.exists()`
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`
nz-pat-1 | error | Patient | only a single official NHI | `Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2`

Differential View

This structure is derived from NzPatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..6 | Nz_ethnicity | NZ Ethnicity
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | Nz_citizenship | This field indicates New Zealand citizenship status of the patient
Slices for extension |  |  |  | Content/Rules for all slices
extension:source |  | 0..1 | Extension | Extension
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
extension:domicile-code |  | 0..0 |  | NZ Domicile Code
extension:pho |  | 0..0 |  | Primary Healthcare Organisation
extension:sex-at-birth |  | 0..0 |  | Sex At Birth
extension:iwi |  | 0..0 |  | Extension
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
Slices for identifier |  | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
type |  | 0..0 |  | Description of identifier
period |  | 0..0 |  | Time period when id is/was valid for use
identifier:NHI |  | 0..* | Identifier | An identifier for this patient
type |  | 0..0 |  | Description of identifier
period |  | 0..0 |  | Time period when id is/was valid for use
active |  | 0..0 |  | Whether this patient's record is in active use
name |  |  |  |
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required)
extension:preferred |  | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
extension:nhi-name-use-extra |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required)
use |  | 0..1 | code | temp | nickname | maiden
text |  | 0..0 |  | Text representation of the full name
given |  | 0..2 | string | Given name and other given name(s)
prefix |  | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required)
suffix |  | 0..0 |  | Parts that come after the name
period |  | 0..0 |  | Time period when name was/is in use
telecom |  | 0..3 | NhiContactPoint | The Paient's contact details
system |  | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
use |  | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
rank |  | 0..0 |  | Specify preferred order of use (1 = highest)
period |  | 0..0 |  | Time period when the contact point was/is in use
gender |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:originalText |  | 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
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required)
deceased[x] |  | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Slices for value[x] |  |  |  | Content/Rules for all slices
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line |  | 1..* | string | Street name, number, direction & P.O. Box etc.
maritalStatus |  | 0..0 |  | Marital (civil) status of a patient
multipleBirth[x] |  | 0..0 |  | Whether patient is part of a multiple birth
photo |  | 0..0 |  | Image of the patient
contact |  | 0..0 |  | A contact party (e.g. guardian, partner, friend) for the patient
communication |  | 0..0 |  | A language which may be used to communicate with the patient about his or her health
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
managingOrganization |  | 0..0 |  | Organization that is the custodian of the patient record
link |  | 0..0 |  | Link to another patient resource that concerns the same actual person
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.name.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Name Information Source | 📦1.3 | HIP FHIR Common Terminology Guide v1.9
Patient.name.prefix | Base | required | Name Prefix Codes | 📦2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.birthDate.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Birth Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9

#### Constraints

Id | Grade | Path(s) | Description | Expression
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1, nhi-nz-pat-1, nhi-nz-pat-2, nhi-nz-pat-3, nhi-nz-pat-4, nhi-nz-pat-5, nhi-nz-pat-6
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained |  | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP |  | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ethnicity |  | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required)
extension:nzCitizen |  | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:status |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred)
extension:source |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
extension: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
extension:birthPlace |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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
value | Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
name | Σ | 0..* | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required)
extension:preferred |  | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
extension:nhi-name-use-extra |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required)
use | ?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..2 | string | Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | C | 0..3 | NhiContactPoint | The Paient's contact details Constraints: cpt-2
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:isVerified |  | 0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified
extension:isShared |  | 0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared
extension:isPrivate |  | 0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate
extension:context |  | 0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context
extension:lastUpdatedDate |  | 0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate
system | Σ C | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required)
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required)
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:originalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value |  | 0..1 | string | Primitive value for code
birthDate | Σ | 0..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required)
value |  | 0..1 | date | Primitive value for date
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source"
Slices for value[x] |  | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required)
value |  | 0..1 | dateTime | Primitive value for dateTime
address |  | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
generalPractitioner |  | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.extension:ethnicity.​value[x]:valueCodeableConcept | Base | required | HPI 4 digit ethnicity codes | 📍2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.extension:nzCitizen.​extension:status.value[x]:valueCodeableConcept | Base | preferred | NZ Citizenship status | 📦1.1.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.extension:nzCitizen.​extension:source.value[x]:valueCodeableConcept | Base | required | NZ Citizenship Information Source | 📦1.1 | HIP FHIR Common Terminology Guide v1.9
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier:NHI.​use | Base | required | Valid use values for NHI | 📦2.0.0 | HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.name.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Name Information Source | 📦1.3 | HIP FHIR Common Terminology Guide v1.9
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.name.prefix | Base | required | Name Prefix Codes | 📦2.0 | HIP FHIR Common Terminology Guide v1.9
Patient.telecom.system | Base | required | NHI ContactPoint System Codes | 📦1.6.5 | This IG
Patient.telecom.use | Base | required | NHI ContactPoint Use Codes | 📦1.6.5 | This IG
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.birthDate.extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Birth Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.deceased[x].​extension:information-source.​value[x]:valueCodeableConcept | Base | required | Date of Death Information Source | 📦1.2 | HIP FHIR Common Terminology Guide v1.9
Patient.address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Patient.address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | Patient.telecom | A system is required if a value is provided. | `value.empty() or system.exists()`
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
nhi-nz-pat-1 | error | Patient | only allows certain name name use values | `Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )`
nhi-nz-pat-2 | error | Patient | home phone 0..1 | `Patient.telecom.where(use='home' and system = 'phone').count() < 2`
nhi-nz-pat-3 | error | Patient | mobile phone 0..1 | `Patient.telecom.where(use='mobile' and system = 'phone').count() < 2`
nhi-nz-pat-4 | error | Patient | email 0..1 | `Patient.telecom.where(system = 'email').count() < 2`
nhi-nz-pat-5 | error | Patient | character restrictions for contact context | `Patient.telecom.extension[context].valueString.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$'))`
nhi-nz-pat-6 | error | Patient | Contact context must be less than 256 characters | `Patient.telecom.extension[context].256.all(length()<256)`
nz-pat-1 | error | Patient | only a single official NHI | `Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2`

This structure is derived from NzPatient

Summary

Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 21 elements

Structures

This structure refers to these other structures:

- NHI ContactPoint (http://hl7.org.nz/fhir/StructureDefinition/nhi-contact-point)
- NHI Address (http://hl7.org.nz/fhir/StructureDefinition/NhiAddress)

Extensions

This structure refers to these extensions:

- http://hl7.org.nz/fhir/StructureDefinition/birth-place
- http://hl7.org.nz/fhir/StructureDefinition/information-source
- http://hl7.org/fhir/StructureDefinition/iso21090-preferred
- http://hl7.org.nz/fhir/StructureDefinition/name-use-extra
- http://hl7.org.nz/fhir/StructureDefinition/gender-original-text

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.contained (Closed)
- The element 1 is sliced based on the value of Patient.identifier (Closed)

Other representations of profile: CSV, Excel, Schematron