Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: HNZ Person Telecom Invalid Indicator

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id Version: 0.4.1
Active as of 2025-08-31 Computable Name: TelecomPhoneInvalidIndicatorExtension

Records the validity of the telecom generally based on most recent contact attempt.

Context of Use

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 HNZ Person Telecom Invalid Indicator
... Slices for extension Content/Rules for all slices
.... extension:invalid 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "invalid"
..... value[x] 0..1 boolean Value of extension
.... extension:invalidFlaggedBy 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "invalidFlaggedBy"
..... value[x] 0..1 Coding Value of extension
Binding: Information source when using the telecom information source extension (required)
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HNZ Person Telecom Invalid Indicator
... 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:invalid 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "invalid"
..... value[x] 0..1 boolean Value of extension
.... extension:invalidFlaggedBy 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "invalidFlaggedBy"
..... value[x] 0..1 Coding Value of extension
Binding: Information source when using the telecom information source extension (required)
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Records the validity of the telecom generally based on most recent contact attempt.

  • invalid: boolean: An Extension
  • invalidFlaggedBy: Coding: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HNZ Person Telecom Invalid Indicator
... Slices for extension Content/Rules for all slices
.... extension:invalid 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "invalid"
..... value[x] 0..1 boolean Value of extension
.... extension:invalidFlaggedBy 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "invalidFlaggedBy"
..... value[x] 0..1 Coding Value of extension
Binding: Information source when using the telecom information source extension (required)
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HNZ Person Telecom Invalid Indicator
... 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:invalid 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "invalid"
..... value[x] 0..1 boolean Value of extension
.... extension:invalidFlaggedBy 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "invalidFlaggedBy"
..... value[x] 0..1 Coding Value of extension
Binding: Information source when using the telecom information source extension (required)
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Records the validity of the telecom generally based on most recent contact attempt.

  • invalid: boolean: An Extension
  • invalidFlaggedBy: Coding: An Extension

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:invalidFlaggedBy.value[x]requiredTelecomInfoSource(a valid code from Codes for Telecom Source Systems)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-information-source-valueset
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()