Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

Extension: NZ Residency (Central Region Edition)

Official URL: https://standards.digital.health.nz/ns/central-region/nz-residency Version: 1.0.12-rc1
Active as of 2024-09-17 Computable Name: NZCentralRegionResidency

NZ Residency status, permits multiple codings from different CodeSystems

Context of Use

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

  • Element ID Patient

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

Complex Extension: NZ Residency status, permits multiple codings from different CodeSystems

  • status: CodeableConcept: Residency Status
  • source: CodeableConcept: The source of information concerning the residency

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Residency (Central Region Edition)
... 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 Central Region - Combined NZ Residency Value Set (required)
.... 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 "https://standards.digital.health.nz/ns/central-region/nz-residency"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Residency (Central Region Edition)
... 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 Central Region - Combined NZ Residency Value Set (required)
.... 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 "https://standards.digital.health.nz/ns/central-region/nz-residency"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: NZ Residency status, permits multiple codings from different CodeSystems

  • status: CodeableConcept: Residency Status
  • source: CodeableConcept: The source of information concerning the residency

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Residency (Central Region Edition)
... 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 Central Region - Combined NZ Residency Value Set (required)
.... 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 "https://standards.digital.health.nz/ns/central-region/nz-residency"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NZ Residency (Central Region Edition)
... 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 Central Region - Combined NZ Residency Value Set (required)
.... 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 "https://standards.digital.health.nz/ns/central-region/nz-residency"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:status.value[x]requiredNZCentralRegionCombinedResidencyValueSet
https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency
from this IG
Extension.extension:source.value[x]preferredInformationSource
https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code

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()