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

Usages:

You can also check for usages in the FHIR IG Statistics

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 & Constraints    Filter: Filtersdoco
.. 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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension 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
..... url 1..1 uri "status"
..... value[x] 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
..... 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"

doco Documentation for this format

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension 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
..... url 1..1 uri "status"
..... value[x] 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
..... 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"

doco Documentation for this format

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

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()