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.1.6 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

• Narrative Content
• XML
• JSON
• TTL

OperationDefinition: SDHRParticipationStatusOperation

Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation				Version: 1.1.6
Active as of 2026-10-20				Computable Name: ParticipationStatus

This operation allows Shared Electronic Health Record (SEHR) systems to retrieve a patient's Shared Digital Health Record participation status.

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/$participation-status).

For an example request payload, see:

• Parameters resource for participation status request : This example shows the Parameters resource to POST to this operation.

For example response payloads for this operation see:

• Parameters resource for participation status response - not participating : This example shows the Parameters resource returned when the patient is not participating in the Shared Digital Health Record service.
• Parameters resource for participation status response - participating : This example shows the Parameters resource returned when the patient is participating in the Shared Digital Health Record service.
• OperationOutcome for invalid patient reference : This example shows the OperationOutcome returned when the patient reference does not match the required NHI Patient URL format.

The operation is expected to be called by a healthcare provider on behalf of the patient, and the patient must be identified by their NHI. This operation requires the SMART on FHIR scope https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation. The operation returns a Parameters resource containing only hnzParticipationIndicator. A patient with no recorded global participation preference is considered to be participating and returns true. If the patient reference is invalid, the operation returns a 400 response with an OperationOutcome carrying the sdhr-invalid-patient outcome code.