HL7® FHIR® New Zealand Base Implementation Guide
1.2.0 - CI Build

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

Extension: NZResidencyStatus

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status Version: 1.2.0
Active as of 2022-08-11 Realm: New Zealand flag Computable Name: NZResidencyStatus

NZ Residency status

Context of Use

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

  • Patient

NZ Residency status indicates that a person holds a New Zealand residence class visa. A residence class visa’ includes both a resident visa and a permanent resident visa.

‘Residence class visa’ is the wording used in Section B3(1) of the Eligibility Direction

“A person who holds a residence class visa is eligible to receive services funded under the Act”.

Example of extension

  ...
  <extension url="http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status">
    <extension url="status">
      <valueCodeableConcept>
        <coding>
          <system value="https://standards.digital.health.nz/ns/nz-residency-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-residency 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

Summary

Fixed Value: 3 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension:status 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NZ Residency status (preferred)
... extension:source 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"source"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Information Source (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:status 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NZ Residency status (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"source"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Information Source (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status"

doco Documentation for this format

This structure is derived from Extension

Summary

Fixed Value: 3 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension:status 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NZ Residency status (preferred)
... extension:source 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"source"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Information Source (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:status 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NZ Residency status (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"source"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Information Source (preferred)
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:status.value[x]:valueCodeableConceptpreferredNZResidencyStatus
Extension.extension:source.value[x]:valueCodeableConceptpreferredInformationSource