New Zealand NHI IG
1.6.5 - Release
New Zealand NHI IG
1.6.5 - Release
New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-contact | Version: 1.6.5 | |||
| Active as of 2025-10-06 | Computable Name: NhiContact | |||
Additional attributes for managing patient contact information
Context of Use
This extension may be used on the following element(s)
Telecom
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | NHI Contact | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:isValidFormat |
0..1 | Extension | The format of the email address or phone number is valid (true or false) | |
   extension |
0..0 | |||
| url |
1..1 | uri | "isValidFormat" | |
  value[x] |
0..1 | boolean | Value of extension | |
| extension:isValidDomain |
0..1 | Extension | The domain of the email address is valid (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidDomain" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isVerified |
0..1 | Extension | Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isVerified" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isShared |
0..1 | Extension | The email address or phone number is shared with other people (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isShared" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isPrivate |
0..1 | Extension | The email address or phone number may be used to communicate private health information about the individual identified by the NHI | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isPrivate" | |
| value[x] |
0..1 | boolean | Value of extension | |
 extension:context |
0..1 | Extension | Additional information about the context of use of this contact | |
 extension |
0..0 | |||
| url |
1..1 | uri | "context" | |
| value[x] |
0..1 | string | Value of extension | |
 url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nhi-contact" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NHI Contact | |
| 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:isValidFormat |
0..1 | Extension | The format of the email address or phone number is valid (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidFormat" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isValidDomain |
0..1 | Extension | The domain of the email address is valid (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidDomain" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isVerified |
0..1 | Extension | Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isVerified" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isShared |
0..1 | Extension | The email address or phone number is shared with other people (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isShared" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isPrivate |
0..1 | Extension | The email address or phone number may be used to communicate private health information about the individual identified by the NHI | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isPrivate" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:context |
0..1 | Extension | Additional information about the context of use of this contact | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "context" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nhi-contact" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NHI Contact | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:isValidFormat |
0..1 | Extension | The format of the email address or phone number is valid (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidFormat" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isValidDomain |
0..1 | Extension | The domain of the email address is valid (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidDomain" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isVerified |
0..1 | Extension | Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isVerified" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isShared |
0..1 | Extension | The email address or phone number is shared with other people (true or false) | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isShared" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isPrivate |
0..1 | Extension | The email address or phone number may be used to communicate private health information about the individual identified by the NHI | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isPrivate" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:context |
0..1 | Extension | Additional information about the context of use of this contact | |
| extension |
0..0 | |||
| url |
1..1 | uri | "context" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nhi-contact" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NHI Contact | |
| 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:isValidFormat |
0..1 | Extension | The format of the email address or phone number is valid (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidFormat" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isValidDomain |
0..1 | Extension | The domain of the email address is valid (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isValidDomain" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isVerified |
0..1 | Extension | Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isVerified" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isShared |
0..1 | Extension | The email address or phone number is shared with other people (true or false) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isShared" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:isPrivate |
0..1 | Extension | The email address or phone number may be used to communicate private health information about the individual identified by the NHI | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "isPrivate" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:context |
0..1 | Extension | Additional information about the context of use of this contact | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "context" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nhi-contact" | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Description | Expression |
| 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()
|