HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint | Version: 1.0.0 | |||
| Active as of 2025-09-08 | Computable Name: NzContactPoint | |||
This profile adds the Contact Point Purpose and EDI address extensions to the standard data type
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..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
  Slices for extension |
Content/Rules for all slices | |||
   extension:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
  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 | Conformance | ValueSet | URI |
| ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 ContactPoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
 Slices for extension |
Content/Rules for all slices | |||
 extension:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | ContactPoint | 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:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
| 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 | Conformance | ValueSet | URI |
| ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 ContactPoint
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
| 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 | Conformance | ValueSet | URI |
| ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 ContactPoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ContactPoint |
C | 0..* | ContactPoint | 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:cp-purpose |
0..1 | CodeableConcept | The business reason this ContactPoint is being used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred) | |
| 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 | Conformance | ValueSet | URI |
| ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 ContactPoint
Other representations of profile: CSV, Excel, Schematron