{
  "resourceType" : "OperationDefinition",
  "id" : "SDHRParticipationStatusOperation",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SDHRParticipationStatusOperation</b></p><a name=\"SDHRParticipationStatusOperation\"> </a><a name=\"hcSDHRParticipationStatusOperation\"> </a><p>URL: [base]/$participation-status</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>OUT</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. Returns true when no global participation preference has been recorded.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation",
  "version" : "1.1.6",
  "name" : "ParticipationStatus",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-10-20T03:14:47+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 Shared Electronic Health Record (SEHR) systems to retrieve a patient's Shared Digital Health Record participation status.\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/$participation-status`).\n\nFor an example request payload, see:\n- [Parameters resource for participation status request](./Parameters-ParametersParticipationStatusRequest.html) : This example shows the `Parameters` resource to POST to this operation.\n\nFor example response payloads for this operation see:\n- [Parameters resource for participation status response - not participating](./Parameters-ParametersParticipationStatusNotParticipatingResponse.html) : This example shows the `Parameters` resource returned when the patient is not participating in the Shared Digital Health Record service.\n- [Parameters resource for participation status response - participating](./Parameters-ParametersParticipationStatusParticipatingResponse.html) : This example shows the `Parameters` resource returned when the patient is participating in the Shared Digital Health Record service.\n- [OperationOutcome for invalid patient reference](./OperationOutcome-OperationOutcomeParticipationStatusInvalidPatient.html) : This example shows the `OperationOutcome` returned when the `patient` reference does not match the required NHI Patient URL format.\n\nThe operation is expected to be called by a healthcare provider on behalf of the patient, and the patient must be identified by their NHI.\nThis operation requires the SMART on FHIR scope `https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation`.\nThe operation returns a `Parameters` resource containing only `hnzParticipationIndicator`. A patient with no recorded global participation preference is considered to be participating and returns `true`.\nIf the `patient` reference is invalid, the operation returns a `400` response with an `OperationOutcome` carrying the `sdhr-invalid-patient` outcome code.",
  "code" : "participation-status",
  "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" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "Indicates global participation. Returns true when no global participation preference has been recorded.",
    "type" : "boolean"
  }]
}