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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.3) 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.3
Active as of 2025-11-25 | Computable Name: TelecomPhoneInvalidIndicatorExtension

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

Context of Use

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

- Element ID: `ContactPoint`
- Element ID: `Person.telecom`

Usage info

Usages:

- Use this Extension: CommunicationPerson
- Examples for this Extension: Person/WhaihuaCommunicationPersonExample

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.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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"
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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"
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

Path | Conformance | ValueSet | URI
Extension.extension:invalidFlaggedBy.value[x] | required | TelecomInfoSource(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

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |