NZ Shared Digital Health Record API - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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.0.1
Active as of 2026-06-08				Computable Name: ParticipationStatus

This operation retrieves a patient's Shared Digital Health Record participation status. This operation should be used by data providers in the Shared Digital Health Record ecosystem such as Patient Management Systems (PMS) or Electronic Health Record (EHR) systems. It returns whether the patient is participating in the service, whether enrollment information was found, and whether the patient has active, archived, or any records available in the service. The scope of the status returned is the API consumer, for example an HPI Facility where patient data is held.

For an example response payload for this operation see:

• Parameters resource for participation status response : This example shows the Parameters resource returned by the operation when participation status information is found for a patient.
• Parameters resource for participation status response with enrollment details : This example shows the Parameters resource returned by the operation when enrollment details are known for a patient.

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

The operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request. 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. The operation will return a Parameters resource containing the patient reference and participation status indicators.