NZ Shared Digital Health Record API
0.6.0 - ballot
NZ Shared Digital Health Record API
0.6.0 - ballot
NZ Shared Digital Health Record API - Local Development build (v0.6.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-07-28 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="SDHRParticipateOperation"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition SDHRParticipateOperation</b></p><a name="SDHRParticipateOperation"> </a><a name="hcSDHRParticipateOperation"> </a><p>URL: [base]/$$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>
</div></td></tr><tr><td>IN</td><td>globalParticipationIndicator</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)
If false, the patient does not wish to participate in the service and their resources will not be shared.
This parameter is mandatory when indicating global participation but is not required when indicating partial participation with withheld records (see <code>resourceType</code> and <code>localResourceId</code> parameters).
If an API consumer attempts to POST a record for a patient that has not opted in, the API will return an OperationOutcome with an error message indicating that the patient has not indicated their participation preferences.</p>
</div></td></tr><tr><td>IN</td><td>resourceType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The resource type that is being withheld. Must be a valid FHIR resource type supported by the SDHR service, such as <code>Condition</code>, <code>Encounter</code> <code>Observation</code> etc. Note that <code>AllergyIntolerance</code> resources MUST NOT be withheld.
This parameter is optional and should only be used to specify the type of resource that is withheld from the Shared Digital Health Record service.
When this paramter is used the request MUST contain a <code>reasonCode</code> parameter and a <code>localResourceId</code> parameter.</p>
</div></td></tr><tr><td>IN</td><td>facilityId</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>The HPI Facility ID of the healthcare provider that is withholding the resource.
This parameter is mandatory and must be provided to indicate the healthcare provider that is withholding the resource from the Shared Digital Health Record service.
The HPI Facility ID must be a valid HPI Facility ID in the format <code>https://api.hip.digital.health.nz/fhir/hpi/v1/Location/{hpi-facility-id}</code>.</p>
</div></td></tr><tr><td>IN</td><td>localResourceId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The local resource ID that is withheld from the Shared Digital Health Record service.
This parameter is optional and should only be used to specify the local ID of the resource that is withheld.
When this paramter is used the request MUST contain a <code>reasonCode</code> parameter and a <code>resourceType</code> parameter.</p>
</div></td></tr><tr><td>IN</td><td>reasonCode</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td><a href="ValueSet-sdhr-participation-reason-valueset.html">ValueSet for SDHR Participation Reason</a> (Required)</td><td><div><p>The reason code for participation. This <strong>MUST</strong> be provided when the intent is to indicate a withheld record or when releasing a record.
Valid codes include:</p>
<ul>
<li><code>sdhr-record-withheld</code>: Records withheld from the patient for privacy or confidentiality reasons.</li>
<li><code>sdhr-record-released</code>: Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient.</li>
</ul>
</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.
This parameter will contain an OperationOutcome resource indicating the success or failure of the operation.
If the operation is successful, the OperationOutcome will contain a success message.
If the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.
The OperationOutcome resource will be returned in the response body of the operation request.
See the following examples for possible OperationOutcome responses:</p>
<ul>
<li><a href="./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html">OperationOutcome for invalid patient reference</a></li>
<li><a href="./OperationOutcome-OperationOutcomeParticipateMissingReason.html">OperationOutcome for missing reason code</a></li>
<li><a href="./OperationOutcome-OperationOutcomeParticipateSuccess.html">OperationOutcome for successful participation</a>
Note that the following <code>OperationOutcome</code> would be returned when an API Consumer attempts to POST a record for a patient that has not provided their participation preferences:</li>
<li><a href="./OperationOutcome-OperationOutcomeParticipatePreferencesNotKnown.html">OperationOutcome for participation preferences not known</a></li>
</ul>
</div></td></tr></table></div>
</text>
<url
value="https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation"/>
<version value="0.6.0"/>
<name value="Participate"/>
<status value="active"/>
<kind value="operation"/>
<date value="2025-07-28T01:39:50+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="This operation allows a patient to choose to participate in the Shared Digital Health Record service.
It can be used to indicate whether the patient wishes to participate, whether any resources are withheld, and the reason for participation.
Examples where this operation might be used include:
- A patient who chooses not to participate in the Shared Digital Health Record service and informs their healthcare provider of this choice.
- A patient who has one or more confidential records, held at their healthcare provider, that are withheld from the service.
For example payloads that might be used with this operation see:
- [Parameters resource for total non-participation](./Parameters-ParametersDoNotParticipate.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).
- [Parameters resource for participation](./Parameters-ParametersParticipate.html) : This example shows how to indicate that a patient wishes to participate in the Shared Digital Health Record service, where previously opted out (opt-in).
- [Parameters resource for partial participation with withheld records](./Parameters-ParametersParticipateRecordWithheld.html) : This example shows how to indicate that a patient has some confidential records that are withheld from the Shared Digital Health Record service.
- [Parameters resource for releasing withheld records](./Parameters-ParametersParticipateRecordReleased.html) : This example shows how to indicate that a patient has previously withheld records but has now released them to the Shared Digital Health Record service.
To 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/$participate`).
The operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request.
The operation is expected to be called by a healthcare provider on behalf of the patient, and the patient must be identified by their NHI.
The operation will return an OperationOutcome resource indicating the result of the operation."/>
<code value="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="Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA"/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="globalParticipationIndicator"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Indicates global participation in the Shared Digital Health Record service (true/false)
If false, the patient does not wish to participate in the service and their resources will not be shared.
This parameter is mandatory when indicating global participation but is not required when indicating partial participation with withheld records (see `resourceType` and `localResourceId` parameters).
If an API consumer attempts to POST a record for a patient that has not opted in, the API will return an OperationOutcome with an error message indicating that the patient has not indicated their participation preferences."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="resourceType"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The resource type that is being withheld. Must be a valid FHIR resource type supported by the SDHR service, such as `Condition`, `Encounter` `Observation` etc. Note that `AllergyIntolerance` resources MUST NOT be withheld.
This parameter is optional and should only be used to specify the type of resource that is withheld from the Shared Digital Health Record service.
When this paramter is used the request MUST contain a `reasonCode` parameter and a `localResourceId` parameter."/>
<type value="string"/>
</parameter>
<parameter>
<name value="facilityId"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The HPI Facility ID of the healthcare provider that is withholding the resource.
This parameter is mandatory and must be provided to indicate the healthcare provider that is withholding the resource from the Shared Digital Health Record service.
The HPI Facility ID must be a valid HPI Facility ID in the format `https://api.hip.digital.health.nz/fhir/hpi/v1/Location/{hpi-facility-id}`."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="localResourceId"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The local resource ID that is withheld from the Shared Digital Health Record service.
This parameter is optional and should only be used to specify the local ID of the resource that is withheld.
When this paramter is used the request MUST contain a `reasonCode` parameter and a `resourceType` parameter."/>
<type value="string"/>
</parameter>
<parameter>
<name value="reasonCode"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The reason code for participation. This **MUST** be provided when the intent is to indicate a withheld record or when releasing a record.
Valid codes include:
- `sdhr-record-withheld`: Records withheld from the patient for privacy or confidentiality reasons.
- `sdhr-record-released`: Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient."/>
<type value="Coding"/>
<binding>
<strength value="required"/>
<valueSet
value="https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset"/>
</binding>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The result of the operation.
This parameter will contain an OperationOutcome resource indicating the success or failure of the operation.
If the operation is successful, the OperationOutcome will contain a success message.
If the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.
The OperationOutcome resource will be returned in the response body of the operation request.
See the following examples for possible OperationOutcome responses:
- [OperationOutcome for invalid patient reference](./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html)
- [OperationOutcome for missing reason code](./OperationOutcome-OperationOutcomeParticipateMissingReason.html)
- [OperationOutcome for successful participation](./OperationOutcome-OperationOutcomeParticipateSuccess.html)
Note that the following `OperationOutcome` would be returned when an API Consumer attempts to POST a record for a patient that has not provided their participation preferences:
- [OperationOutcome for participation preferences not known](./OperationOutcome-OperationOutcomeParticipatePreferencesNotKnown.html)"/>
<type value="OperationOutcome"/>
</parameter>
</OperationDefinition>