NZ Shared Digital Health Record API
1.0.0 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

## Extension: Facility Participation

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension | Version: 1.0.0
Active as of 2025-11-18 | Computable Name: FacilityParticipationExtension

Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.

Context of Use

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

- Element ID: `Element`

Usage info

Usages:

- Use this Extension: SDHRConsent
- Examples for this Extension: Consent/ConsentExampleRecordsWithheld, Consent/ConsentFacilityDenyExample and Consent/ConsentMultiFacilityExample

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 | Facility Participation
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Open by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in Binding: ValueSet for SDHR Participation Reason (required)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Facility Participation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in Binding: ValueSet for SDHR Participation Reason (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Facility Participation
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Open by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in Binding: ValueSet for SDHR Participation Reason (required)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Facility Participation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension"
Slices for value[x] |  | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept |  | 1..1 | CodeableConcept | Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in Binding: ValueSet for SDHR Participation Reason (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x]:valueCodeableConcept | Base | required | ValueSet for SDHR Participation Reason | 📦1.0.0 | This IG

#### Constraints

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()`