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

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

Extension: NZ Citizenship

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship Version: 1.1.0
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):

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

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Citizenship
... Slices for extension Content/Rules for all slices
.... extension:status 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: NZ Citizenship status (preferred)
.... extension:source 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "source"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Information Source (preferred)
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
... value[x] 0..0

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:status.value[x]preferredCitizenshipStatus (a valid code from NZ Citizenship status)
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
from this IG
Extension.extension:source.value[x]preferredInformationSource (a valid code from Information Source)
https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
from this IG