NZ Citizenship - HL7® FHIR® New Zealand Base Implementation Guide v3.2.0-ci-build

HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - 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.2.0-ci-build 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

Extension: NZ Citizenship

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship	Version: 1.1.0	Highlight text changes?
Active as of 2020-07-20		Computable Name: Nz_citizenship
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

New Zealand citizenship

Context of Use

This extension may be used on the following element(s)

Element ID: Patient

Example of extension

  ...
  <extension url="http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship">
    <extension url="status">
      <valueCodeableConcept>
        <coding>
          <system value="https://standards.digital.health.nz/ns/nz-citizenship-status-code"/>
          <code value="yes"/>
          <display value="Yes"/>
        </coding>
      </valueCodeableConcept>
    </extension>
    <extension url="source">
      <valueCodeableConcept>
        <coding>
          <system value="https://standards.digital.health.nz/ns/information-source-code"/>
          <code value="BREG"/>
          <display value="Birth Register"/>
        </coding>
      </valueCodeableConcept>
    </extension>
  </extension>
  ...

Example instances

Patient with nz-citizenship indicated

Usage info

Usages:

Use this Extension: NZ Patient
Examples for this Extension: Patient/patient-nz-citizenship

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from Extension

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	NZ Citizenship
Extension.Slices for extension			Content/Rules for all slices
Extension.Slices for extension.extension:status	0..1	Extension	Extension
Extension.Slices for extension.extension:status.extension	0..0		Extension
Extension.Slices for extension.extension:status.url	1..1	uri	"status"
Extension.Slices for extension.extension:status.value[x]	0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Extension.Slices for extension.extension:source	0..1	Extension	Extension
Extension.Slices for extension.extension:source.extension	0..0		Extension
Extension.Slices for extension.extension:source.url	1..1	uri	"source"
Extension.Slices for extension.extension:source.value[x]	0..1	CodeableConcept	Value of extension Binding: Information Source (preferred)
Extension.url	1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Extension.value[x]	0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	This IG
Extension.extension:source.value[x]	Base	preferred	Information Source	📦1.0.0	This IG

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	NZ Citizenship
Extension.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:status	0..1	Extension	Extension
Extension.Slices for extension.extension:status.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:status.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:status.url	1..1	uri	"status"
Extension.Slices for extension.extension:status.value[x]	0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Extension.Slices for extension.extension:source	0..1	Extension	Extension
Extension.Slices for extension.extension:source.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:source.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:source.url	1..1	uri	"source"
Extension.Slices for extension.extension:source.value[x]	0..1	CodeableConcept	Value of extension Binding: Information Source (preferred)
Extension.url	1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	This IG
Extension.extension:source.value[x]	Base	preferred	Information Source	📦1.0.0	This IG

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Extension

Summary

Complex Extension: New Zealand citizenship

status: CodeableConcept: No description
source: CodeableConcept: No description

Differential View

This structure is derived from Extension

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	NZ Citizenship
Extension.Slices for extension			Content/Rules for all slices
Extension.Slices for extension.extension:status	0..1	Extension	Extension
Extension.Slices for extension.extension:status.extension	0..0		Extension
Extension.Slices for extension.extension:status.url	1..1	uri	"status"
Extension.Slices for extension.extension:status.value[x]	0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Extension.Slices for extension.extension:source	0..1	Extension	Extension
Extension.Slices for extension.extension:source.extension	0..0		Extension
Extension.Slices for extension.extension:source.url	1..1	uri	"source"
Extension.Slices for extension.extension:source.value[x]	0..1	CodeableConcept	Value of extension Binding: Information Source (preferred)
Extension.url	1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Extension.value[x]	0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	This IG
Extension.extension:source.value[x]	Base	preferred	Information Source	📦1.0.0	This IG

Snapshot View

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	NZ Citizenship
Extension.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:status	0..1	Extension	Extension
Extension.Slices for extension.extension:status.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:status.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:status.url	1..1	uri	"status"
Extension.Slices for extension.extension:status.value[x]	0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Extension.Slices for extension.extension:source	0..1	Extension	Extension
Extension.Slices for extension.extension:source.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:source.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:source.url	1..1	uri	"source"
Extension.Slices for extension.extension:source.value[x]	0..1	CodeableConcept	Value of extension Binding: Information Source (preferred)
Extension.url	1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	This IG
Extension.extension:source.value[x]	Base	preferred	Information Source	📦1.0.0	This IG

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Extension

Summary

Complex Extension: New Zealand citizenship

status: CodeableConcept: No description
source: CodeableConcept: No description

Other representations of profile: CSV, Excel, Schematron

IG © 2021+ HL7 New Zealand. Package fhir.org.nz.ig.base#3.2.0-ci-build based on FHIR 4.0.1. Generated 2026-10-15
Links: Table of Contents | QA Report | Version History | HL7 New Zealand