NZ Shared Digital Health Record API
0.7.1 - ballot

NZ Shared Digital Health Record API - Local Development build (v0.7.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: SDHRHNZParticipateOperation

Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipateOperation Version: 0.7.1
Active as of 2025-09-25 Computable Name: HNZParticipate

This operation allows a patient to choose to participate in the Shared Digital Health Record service via HNZ assisted channels. This operation should only be used by HNZ channels.

Scenarios where this operation might be used include:

  • A patient has opted in to the Shared Digital Health Record service by contacting Health NZ via appropriate digital or assisted channels.
  • A patient chooses not to participate in the Shared Digital Health Record service and informs Health NZ of this choice via appropriate digital or assisted channels.

For example payloads that might be used with 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-participate).

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 Health NZ channel system on behalf of the patient, and the patient must be identified by their NHI. The operation will return an OperationOutcome resource indicating the result of the operation.

URL: [base]/$$hnz-participate

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient1..1Reference

Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA

INhnzParticipationIndicator1..1boolean

Indicates global participation in the Shared Digital Health Record service (true/false) If false, the patient does not wish to participate in the service and their resources will not be shared.

INfacilityId1..1Reference

The HPI Facility ID of the healthcare provider that is withholding the resource. This parameter is mandatory and must be provided to indicate the healthcare provider that is withholding the resource from the Shared Digital Health Record service. The HPI Facility ID must be a valid HPI Facility ID in the format https://api.hip.digital.health.nz/fhir/hpi/v1/{Location}or{Organization}/{hpi-facility-id}or{hpi-org-id}.

INreasonCode0..1CodingValueSet for SDHR Participation Reason (Required)

The reason code for participation. Valid codes include:

  • sdhr-hnz-opt-out: Patient has opted out of participation entirely with Health NZ. This means that no records will be shared from any facility.
  • sdhr-hnz-opt-in: Patient has opted in to participation with Health NZ.
OUTreturn1..1OperationOutcome

The result of the operation. This parameter will contain an OperationOutcome resource indicating the success or failure of the operation. If the operation is successful, the OperationOutcome will contain a success message. If the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure. The OperationOutcome resource will be returned in the response body of the operation request. See the following examples for possible OperationOutcome responses: - OperationOutcome for invalid patient reference - OperationOutcome for missing reason code - OperationOutcome for successful participation