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: SDHRHNZDomainParticipateOperation

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

Records independent domain participation choices for one patient through authorised Health NZ channels. POST a FHIR Parameters resource to https://api.sdhr.digital.health.nz/s2s/$hnz-domain-participate with exactly one patient parameter and exactly one domains parameter. The domains parameter contains one or more named boolean parts: SDHRMedications and/or SDHRImmunisations. Each domain may occur only once. A single-domain update uses the same structure with one part.

true records an explicit permit and false records a deny. Omitted domains retain their existing choices; a domain without a recorded choice defaults to In. MedicationRequest and MedicationDispense share the Medications choice. Immunisations are controlled independently.

Only the requested patient's Consent is updated. Consents for linked NHIs remain unchanged. For access, a deny on any linked NHI denies that domain for the entire linked group. Opting one patient back in cannot override another linked patient's deny. A global opt-out continues to take precedence over domain permits.

This operation does not change global or facility participation, archive or restore resources, trigger a historic load, or update participation in an upstream national system. Global participation remains managed through $hnz-participate. Global participation indicators, facility parameters, repeated patients, the singular domain parameter and repeated domainParticipation groups are not accepted by this operation.

The operation is idempotent and returns an OperationOutcome. See one-domain update and multiple-domain update.