NZ Shared Digital Health Record API
1.0.1 - release

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

## : SDHRHNZParticipateOperation - JSON Representation

Active as of 2026-06-05

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "SDHRHNZParticipateOperation",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SDHRHNZParticipateOperation</b></p><a name=\"SDHRHNZParticipateOperation\"> </a><a name=\"hcSDHRHNZParticipateOperation\"> </a><p>URL: [base]/$hnz-participate</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA</p>\n</div></td></tr><tr><td>IN</td><td>hnzParticipationIndicator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates global participation in the Shared Digital Health Record service (true/false)\nIf false, the patient does not wish to participate in the service and their resources will not be shared.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>The result of the operation.\nThis parameter will contain an OperationOutcome resource indicating the success or failure of the operation.\nIf the operation is successful, the OperationOutcome will contain a success message.\nIf the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.\nThe OperationOutcome resource will be returned in the response body of the operation request.\nSee the following examples for possible OperationOutcome responses:\n- <a href=\"./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html\">OperationOutcome for invalid patient reference</a>\n- <a href=\"./OperationOutcome-OperationOutcomeParticipateSuccess.html\">OperationOutcome for successful participation</a></p>\n</div></td></tr></table></div>"
      },
      "url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipateOperation",
      "version" : "1.0.1",
      "name" : "HNZParticipate",
      "status" : "active",
      "kind" : "operation",
      "date" : "2026-06-05T02:07:34+00:00",
      "publisher" : "Health New Zealand",
      "contact" : [
        {
          "name" : "Health New Zealand",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://github.com/tewhatuora"
            }
          ]
        },
        {
          "name" : "HNZ Integration Team",
          "telecom" : [
            {
              "system" : "email",
              "value" : "integration@tewhatuora.govt.nz",
              "use" : "work"
            }
          ]
        }
      ],
      "description" : "This operation allows a patient to choose to participate in the Shared Digital Health Record service via HNZ assisted channels.\nThis operation should only be used by HNZ channels.\n\nScenarios where this operation might be used include:\n- A patient has opted in to the Shared Digital Health Record service by contacting Health NZ via appropriate digital or assisted channels.\n- 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.\n\nFor example payloads that might be used with this operation see:\n- [Parameters resource for total non-participation](./Parameters-ParametersHNZParticipateOptOut.html) : This example shows how to indicate that a patient does not wish to participate in the Shared Digital Health Record service (has opted out).\n- [Parameters resource for participation](./Parameters-ParametersHNZParticipateOptIn.html) : This example shows how to indicate that a patient wishes to participate in the Shared Digital Health Record service.\n\nTo 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`).\n\nThe operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request.\nThe 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.\nThe operation will return an OperationOutcome resource indicating the result of the operation.",
      "code" : "hnz-participate",
      "system" : true,
      "type" : false,
      "instance" : false,
      "parameter" : [
        {
          "name" : "patient",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA",
          "type" : "Reference"
        },
        {
          "name" : "hnzParticipationIndicator",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Indicates global participation in the Shared Digital Health Record service (true/false)\nIf false, the patient does not wish to participate in the service and their resources will not be shared.",
          "type" : "boolean"
        },
        {
          "name" : "return",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The result of the operation.\n    This parameter will contain an OperationOutcome resource indicating the success or failure of the operation.\n    If the operation is successful, the OperationOutcome will contain a success message.\n    If the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.\n    The OperationOutcome resource will be returned in the response body of the operation request.\n    See the following examples for possible OperationOutcome responses:\n    - [OperationOutcome for invalid patient reference](./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html)\n    - [OperationOutcome for successful participation](./OperationOutcome-OperationOutcomeParticipateSuccess.html)",
          "type" : "OperationOutcome"
        }
      ]
    }