NZ Shared Digital Health Record API
1.1.6 - 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.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

: SDHRHNZDomainParticipateOperation - TTL Representation

Active as of 2026-10-20

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/SDHRHNZDomainParticipateOperation> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "SDHRHNZDomainParticipateOperation"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<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>\n</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>\n</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>\n</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>\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>OperationOutcome indicating success or the reason the request was rejected.</p>\n</div></td></tr></table></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZDomainParticipateOperation"] ;
  fhir:OperationDefinition.version [ fhir:value "1.1.6"] ;
  fhir:OperationDefinition.name [ fhir:value "HNZDomainParticipate"] ;
  fhir:OperationDefinition.status [ fhir:value "active"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-10-20T03:14:47+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "Health New Zealand"] ;
  fhir:OperationDefinition.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "Health New Zealand" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://github.com/tewhatuora" ]
     ]
  ], [
     fhir:index 1 ;
     fhir:ContactDetail.name [ fhir:value "HNZ Integration Team" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "email" ] ;
       fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir:value "Records independent domain participation choices for one patient through authorised Health NZ channels.\nPOST 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.\n\n`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.\n\nOnly 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.\n\nThis 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.\n\nThe operation is idempotent and returns an OperationOutcome. See [one-domain update](./Parameters-ParametersHNZDomainOptOff.html) and [multiple-domain update](./Parameters-ParametersHNZDomainChoices.html)."] ;
  fhir:OperationDefinition.code [ fhir:value "hnz-domain-participate"] ;
  fhir:OperationDefinition.system [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir: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." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "domains" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "One or both named boolean parts must be supplied. Omitted domains are unchanged. Duplicate domain names are invalid." ] ;
     fhir:OperationDefinition.parameter.part [
       fhir:index 0 ;
       fhir:OperationDefinition.parameter.name [ fhir:value "SDHRMedications" ] ;
       fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
       fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
       fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
       fhir:OperationDefinition.parameter.documentation [ fhir:value "True permits and false denies MedicationRequest and MedicationDispense access, subject to linked-group and global denials." ] ;
       fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
     ], [
       fhir:index 1 ;
       fhir:OperationDefinition.parameter.name [ fhir:value "SDHRImmunisations" ] ;
       fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
       fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
       fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
       fhir:OperationDefinition.parameter.documentation [ fhir:value "True permits and false denies Immunization access, subject to linked-group and global denials." ] ;
       fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
     ]
  ], [
     fhir:index 2 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "OperationOutcome indicating success or the reason the request was rejected." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "OperationOutcome" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/SDHRHNZDomainParticipateOperation.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/SDHRHNZDomainParticipateOperation.ttl> .