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-point | Version: 1.6.5 | |||
| Active as of 2026-02-09 | Computable Name: NhiContactPoint | |||
Additional attributes for managing patient contact information
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ContactPoint |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
  Slices for extension |
Content/Rules for all slices | |||
   extension:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
 extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
  use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ContactPoint.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | ContactPoint | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
This structure is derived from NzContactPoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
NzContactPoint | |||
 Slices for extension |
Content/Rules for all slices | |||
 extension:cp-purpose |
0..0 | A specific purpose for which this ContactPoint dataType would be used | ||
| extension:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
| extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
 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:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
| extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
 period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ContactPoint.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| ContactPoint.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | ContactPoint | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
This structure is derived from NzContactPoint
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
| extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ContactPoint.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | ContactPoint | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
Differential View
This structure is derived from NzContactPoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
NzContactPoint | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:cp-purpose |
0..0 | A specific purpose for which this ContactPoint dataType would be used | ||
| extension:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
| extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
| 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:isVerified |
0..1 | boolean | isVerified URL: http://hl7.org.nz/fhir/StructureDefinition/isVerified | |
| extension:isShared |
0..1 | boolean | isShared URL: http://hl7.org.nz/fhir/StructureDefinition/isShared | |
| extension:isPrivate |
0..1 | boolean | isPrivate URL: http://hl7.org.nz/fhir/StructureDefinition/isPrivate | |
| extension:context |
0..1 | string | context URL: http://hl7.org.nz/fhir/StructureDefinition/context | |
| extension:lastUpdatedDate |
0..1 | date | LastUpdatedDate URL: http://hl7.org.nz/fhir/StructureDefinition/lastUpdatedDate | |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 0..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ContactPoint.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| ContactPoint.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | ContactPoint | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
This structure is derived from NzContactPoint
Other representations of profile: CSV, Excel, Schematron