NZ Shared Digital Health Record API
1.0.0 - release
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
| Official URL: https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset | Version: 1.0.0 | |||
| Active as of 2026-03-01 | Computable Name: SDHRParticipationReasonValueSet | |||
A ValueSet containing all codes from the SDHR Participation Reason system.
References
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason version 📦1.0.0
Expansion performed internally based on codesystem SDHR Participation Reason Codes v1.0.0 (CodeSystem)
This value set contains 6 concepts
| System | Code | Display (en) | Definition | JSON | XML |
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-record-withheld | Record withheld | Record withheld from the service for privacy or confidentiality reasons. | ||
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-record-released | Record released | Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient. | ||
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-facility-opt-out | Facility opt out | Patient has opted out of participation entirely at the facility. This means that no records will be shared from that facility. | ||
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-facility-opt-in | Facility opt in | Patient has opted in to participation at the facility. This means that records will be shared from that facility. | ||
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-hnz-opt-out | HNZ opt out | Patient has opted out of participation entirely with Health NZ. This means that no records will be shared from any facility. | ||
https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason | sdhr-hnz-opt-in | HNZ opt in | Patient has opted in to participation with Health NZ. This means that records will be shared from all facilities. |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |