NZ Shared Digital Health Record API
1.1.4 - release
NZ Shared Digital Health Record API
1.1.4 - release
NZ Shared Digital Health Record API - Local Development build (v1.1.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipationStatusOperation | Version: 1.1.4 | |||
| Active as of 2026-09-21 | Computable Name: HNZParticipationStatus | |||
This internal use operation retrieves a patient's Shared Digital Health Record participation status and returns whether the patient is participating in the service, whether enrolment information was found, whether the patient has active, archived, or any records available in the service, and the opt-out reason when the patient is globally opted out.
For example response payloads for this operation see:
To make a request to this operation the API Consumer must POST a Parameters payload to the operation URL (e.g. POST https://api.sdhr.digital.health.nz/s2s/$hnz-participation-status).
The operation will return a Parameters resource containing the patient reference, participation status indicators, and the global opt-out reason when the patient is globally opted out.
URL: [base]/$hnz-participation-status
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | patient | 1..1 | Reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA | ||
| OUT | patient | 1..1 | Reference | The patient reference resolved for the participation status lookup. | ||
| OUT | consentFound | 1..1 | boolean | Indicates whether a consent record was found for the patient in the Shared Digital Health Record service. | ||
| OUT | hnzParticipationIndicator | 1..1 | boolean | Indicates whether the patient is currently participating in the Shared Digital Health Record service. | ||
| OUT | hnzOptOutReasonCode | 0..1 | code | ValueSet for HNZ Global Opt Out Reason (Required) | The global opt-out reason when hnzParticipationIndicator is false. Allowed values: patient-choice, patient-deceased, imported-external-consent. | |
| OUT | hasActiveRecords | 1..1 | boolean | Indicates whether the patient has active records available in the service. | ||
| OUT | hasArchivedRecords | 1..1 | boolean | Indicates whether the patient has archived records in the service. | ||
| OUT | hasAnyRecords | 1..1 | boolean | Indicates whether the patient has any records, active or archived, in the service. | ||
| OUT | enrolmentInformationFound | 1..1 | boolean | Indicates whether enrolment information was found for the patient. | ||
| OUT | enrolmentOrgId | 0..1 | string | The enrolment organisation identifier, when enrolment information is available for the patient. | ||
| OUT | enrolmentFacilityId | 0..1 | string | The enrolment facility identifier, when enrolment information is available for the patient. | ||
| OUT | enrolmentNHI | 0..1 | string | The enrolment NHI value, when enrolment information is available for the patient. | ||
| OUT | enrolmentFacilityParticipation | 0..* | The facility-level participation status for facilities associated with the patient's enrolment. Only present when enrolment information is found. | |||
| OUT | enrolmentFacilityParticipation.facilityId | 1..1 | Reference | The HPI Location reference for the enrolled facility. | ||
| OUT | enrolmentFacilityParticipation.participationIndicator | 1..1 | boolean | Whether the patient is participating at this enrolled facility. | ||
| OUT | facilityParticipation | 0..* | The facility-level participation status for all facilities where the patient has an explicit participation record. | |||
| OUT | facilityParticipation.facilityId | 1..1 | Reference | The HPI Location reference for the facility. | ||
| OUT | facilityParticipation.participationIndicator | 1..1 | boolean | Whether the patient is participating at this facility. |