<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="SDHRHNZDomainParticipateOperation"/>
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition SDHRHNZDomainParticipateOperation</b></p><a name="SDHRHNZDomainParticipateOperation"> </a><a name="hcSDHRHNZDomainParticipateOperation"> </a><p>URL: [base]/$hnz-domain-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>NHI Patient reference in the form https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA. Updates this patient's Consent only.</p>
</div></td></tr><tr><td>IN</td><td>domains</td><td/><td>1..1</td><td/><td/><td><div><p>One or both named boolean parts must be supplied. Omitted domains are unchanged. Duplicate domain names are invalid.</p>
</div></td></tr><tr><td>IN</td><td>domains.SDHRMedications</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>True permits and false denies MedicationRequest and MedicationDispense access, subject to linked-group and global denials.</p>
</div></td></tr><tr><td>IN</td><td>domains.SDHRImmunisations</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>True permits and false denies Immunization access, subject to linked-group and global denials.</p>
</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>OperationOutcome indicating success or the reason the request was rejected.</p>
</div></td></tr></table></div>
  </text>
  <url value="https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZDomainParticipateOperation"/>
  <version value="1.1.6"/>
  <name value="HNZDomainParticipate"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2026-10-20T03:14:47+00:00"/>
  <publisher value="Health New Zealand"/>
  <contact>
    <name value="Health New Zealand"/>
    <telecom>
      <system value="url"/>
      <value value="https://github.com/tewhatuora"/>
    </telecom>
  </contact>
  <contact>
    <name value="HNZ Integration Team"/>
    <telecom>
      <system value="email"/>
      <value value="integration@tewhatuora.govt.nz"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description value="Records independent domain participation choices for one patient through authorised Health NZ channels.&#xA;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.&#xA;&#xA;`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.&#xA;&#xA;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.&#xA;&#xA;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.&#xA;&#xA;The operation is idempotent and returns an OperationOutcome. See [one-domain update](./Parameters-ParametersHNZDomainOptOff.html) and [multiple-domain update](./Parameters-ParametersHNZDomainChoices.html)."/>
  <code value="hnz-domain-participate"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="NHI Patient reference in the form https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA. Updates this patient's Consent only."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="domains"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="One or both named boolean parts must be supplied. Omitted domains are unchanged. Duplicate domain names are invalid."/>
    <part>
      <name value="SDHRMedications"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="True permits and false denies MedicationRequest and MedicationDispense access, subject to linked-group and global denials."/>
      <type value="boolean"/>
    </part>
    <part>
      <name value="SDHRImmunisations"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="True permits and false denies Immunization access, subject to linked-group and global denials."/>
      <type value="boolean"/>
    </part>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="OperationOutcome indicating success or the reason the request was rejected."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>