NZ Shared Digital Health Record API
1.1.6 - release
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
| Active as of 2026-10-20 |
{
"resourceType" : "OperationDefinition",
"id" : "SDHRHNZDomainParticipateOperation",
"text" : {
"status" : "generated",
"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/><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>"
},
"url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZDomainParticipateOperation",
"version" : "1.1.6",
"name" : "HNZDomainParticipate",
"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" : "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).",
"code" : "hnz-domain-participate",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "patient",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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" : "Reference"
},
{
"name" : "domains",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "One or both named boolean parts must be supplied. Omitted domains are unchanged. Duplicate domain names are invalid.",
"part" : [
{
"name" : "SDHRMedications",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "True permits and false denies MedicationRequest and MedicationDispense access, subject to linked-group and global denials.",
"type" : "boolean"
},
{
"name" : "SDHRImmunisations",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "True permits and false denies Immunization access, subject to linked-group and global denials.",
"type" : "boolean"
}
]
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "OperationOutcome indicating success or the reason the request was rejected.",
"type" : "OperationOutcome"
}
]
}