NZ Shared Digital Health Record API
0.5.0 - ballot
NZ Shared Digital Health Record API - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2025-07-21 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "SDHRParticipateOperation"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<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>\n</div></td></tr><tr><td>IN</td><td>participationIndicator</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 participation in the Shared Digital Health Record service (true/false)\nIf false, the patient does not wish to participate in the service and their resources will not be shared.\nOR\nThe patient has some confidential records that are withheld from the service.\nThe <code>reasonCode</code> parameter must be used to indicate the reason for withholding records or not participating.</p>\n</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>AllergyIntolerance</code>, <code>Condition</code>, etc.\nThis parameter is optional and should only be used to specify the type of resource that is withheld from the Shared Digital Health Record service.\nThis parameter MUST be used when the <code>reasonCode</code> is <code>sdhr-record-withheld</code> to indicate which resources are withheld.</p>\n</div></td></tr><tr><td>IN</td><td>facilityId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The HPI Facility ID of the healthcare provider that is withholding the resource.\nThis parameter is mandatory and must be provided to indicate the healthcare provider that is withholding the resource from the Shared Digital Health Record service.\nThe 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>\n</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.\nThis parameter is optional and should only be used to specify the local ID of the resource that is withheld.\nThis parameter MUST be used when the <code>reasonCode</code> is <code>sdhr-record-withheld</code> to indicate which specific resource is withheld.</p>\n</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 <code>participation-indicator</code> is false.\nIt indicates the reason for withholding records or not participating in the Shared Digital Health Record service.\nValid codes include:</p>\n<ul>\n<li><code>sdhr-record-withheld</code>: Records withheld from the patient for privacy or confidentiality reasons.</li>\n<li><code>sdhr-participation</code>: Patient participation preference for the Shared Digital Health Record service. In conjunction with <code>participationIndicator</code> set to false, this indicates that the patient does not wish to participate in the service. If the <code>participationIndicator</code> is true, this code indicates that the patient is participating in the service.</li>\n<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>\n</ul>\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>The result of the operation.\nThis parameter will contain an OperationOutcome resource indicating the success or failure of the operation.\nIf the operation is successful, the OperationOutcome will contain a success message.\nIf the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.\nThe OperationOutcome resource will be returned in the response body of the operation request.\nSee the following examples for possible OperationOutcome responses:</p>\n<ul>\n<li><a href=\"./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html\">OperationOutcome for invalid patient reference</a></li>\n<li><a href=\"./OperationOutcome-OperationOutcomeParticipateMissingReason.html\">OperationOutcome for missing reason code</a></li>\n<li><a href=\"./OperationOutcome-OperationOutcomeParticipateSuccess.html\">OperationOutcome for successful participation</a></li>\n</ul>\n</div></td></tr></table></div>"^^rdf:XMLLiteral
] ; #
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation"^^xsd:anyURI] ; #
fhir:version [ fhir:v "0.5.0"] ; #
fhir:name [ fhir:v "Participate"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2025-07-21T23:38:05+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "Health New Zealand"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Health New Zealand" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://github.com/tewhatuora" ] ] )
] [
fhir:name [ fhir:v "HNZ Integration Team" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "integration@tewhatuora.govt.nz" ] ;
fhir:use [ fhir:v "work" ] ] )
] ) ; #
fhir:description [ fhir:v "This operation allows a patient to choose to participate in the Shared Digital Health Record service.\nIt can be used to indicate whether the patient wishes to participate, whether any resources are withheld, and the reason for participation.\n\nExamples where this operation might be used include:\n- A patient who chooses not to participate in the Shared Digital Health Record service and informs their healthcare provider of this choice.\n- A patient who has some confidential records, held at their healthcare provider, that are withheld from the service.\n\nFor example payloads that might be used with this operation see:\n- [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).\n- [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).\n- [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.\n- [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.\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/$participate`).\n\nThe operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request.\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.\nThe operation will return an OperationOutcome resource indicating the result of the operation."] ; #
fhir:code [ fhir:v "participate"] ; #
fhir:system [ fhir:v true] ; #
fhir:type [ fhir:v false] ; #
fhir:instance [ fhir:v false] ; #
fhir:parameter ( [
fhir:name [ fhir:v "patient" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA" ] ;
fhir:type [ fhir:v "Reference" ]
] [
fhir:name [ fhir:v "participationIndicator" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Indicates participation in the Shared Digital Health Record service (true/false)\nIf false, the patient does not wish to participate in the service and their resources will not be shared.\nOR\nThe patient has some confidential records that are withheld from the service.\nThe `reasonCode` parameter must be used to indicate the reason for withholding records or not participating." ] ;
fhir:type [ fhir:v "boolean" ]
] [
fhir:name [ fhir:v "resourceType" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The resource type that is being withheld. Must be a valid FHIR resource type supported by the SDHR service, such as `AllergyIntolerance`, `Condition`, etc.\n 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.\n This parameter MUST be used when the `reasonCode` is `sdhr-record-withheld` to indicate which resources are withheld." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "facilityId" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The HPI Facility ID of the healthcare provider that is withholding the resource.\n 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.\n 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}`." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "localResourceId" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The local resource ID that is withheld from the Shared Digital Health Record service.\n This parameter is optional and should only be used to specify the local ID of the resource that is withheld.\n This parameter MUST be used when the `reasonCode` is `sdhr-record-withheld` to indicate which specific resource is withheld." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "reasonCode" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The reason code for participation. This **MUST** be provided when the `participation-indicator` is false.\nIt indicates the reason for withholding records or not participating in the Shared Digital Health Record service.\nValid codes include:\n- `sdhr-record-withheld`: Records withheld from the patient for privacy or confidentiality reasons.\n- `sdhr-participation`: Patient participation preference for the Shared Digital Health Record service. In conjunction with `participationIndicator` set to false, this indicates that the patient does not wish to participate in the service. If the `participationIndicator` is true, this code indicates that the patient is participating in the service.\n- `sdhr-record-released`: Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient." ] ;
fhir:type [ fhir:v "Coding" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset"^^xsd:anyURI ;
fhir:link <https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset> ] ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The result of the operation. \nThis parameter will contain an OperationOutcome resource indicating the success or failure of the operation.\nIf the operation is successful, the OperationOutcome will contain a success message.\nIf the operation fails, the OperationOutcome will contain an error message indicating the reason for the failure.\nThe OperationOutcome resource will be returned in the response body of the operation request.\nSee the following examples for possible OperationOutcome responses:\n- [OperationOutcome for invalid patient reference](./OperationOutcome-OperationOutcomeParticipateInvalidPatient.html)\n- [OperationOutcome for missing reason code](./OperationOutcome-OperationOutcomeParticipateMissingReason.html)\n- [OperationOutcome for successful participation](./OperationOutcome-OperationOutcomeParticipateSuccess.html)" ] ;
fhir:type [ fhir:v "OperationOutcome" ]
] ) . #
IG © 2025+ Health New Zealand. Package tewhatuora.fhir.nz-shared-digital-health-record#0.5.0 based on FHIR 4.0.1. Generated 2025-07-21
Links: Table of Contents |
QA Report