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

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

## Extension: HNZ Patient Contact Role

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id | Version: 0.4.4
Active as of 2025-12-11 | Computable Name: PatientContactRole

The nature of the functional role between the patient and the contact person.

Context of Use

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

- Element ID: `Patient.contact`

Usage info

Usages:

- Use this Extension: Dunedin Hospital Outpatient Get Patient Profile
- Examples for this Extension: Patient/DHO-outpatient-instance, Patient/DHO-sipics-alex-morgan, Patient/DHO-sipics-curious-george and Patient/DHO-sipics-emily-white

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 Patient Contact Role
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: ValueSet for Patient Contact Role (required)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HNZ Patient Contact Role
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: ValueSet for Patient Contact Role (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The nature of the functional role between the patient and the contact person.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HNZ Patient Contact Role
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: ValueSet for Patient Contact Role (required)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HNZ Patient Contact Role
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: ValueSet for Patient Contact Role (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The nature of the functional role between the patient and the contact person.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Extension.value[x] | required | VSPatientContactRole(a valid code from CodeSystem for Patient Contact Role) `https://fhir-ig.digital.health.nz/shared-care/ValueSet/vs-patient-contact-role` 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() |