NZ Shared Digital Health Record API
0.5.0 - ballot
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
| Draft as of 2024-04-15 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="SDHRCapabliityStatement"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement SDHRCapabliityStatement</b></p><a name="SDHRCapabliityStatement"> </a><a name="hcSDHRCapabliityStatement"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="file:///home/runner/work/fhir-ig-builder/fhir-ig-builder/hnz-digital-tooling/output/StructureDefinition-hnz-capability-statement.html">Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter</a></p></div><h2 id="title">NZ Shared Digital Health Record API</h2><ul><li>Implementation Guide Version: 0.5.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-15 01:15:23+0000 </li><li>Published by: Health New Zealand </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><h3>Request-Context custom header</h3>
<p>All FHIR API requests MUST include the HNZ request context <em>custom header</em> which supplies identifiers for the health user
and organisation, or system behind the API request.</p>
<p>This context is supplied using the 'Request-Context' custom HTTP header in the form of a base64-encoded JSON object.
The value of the header has differing forms based on the type of request being made, namely whether it is in a user context (e.g. a clinical user searching for patient records), or a system context (e.g. a system submitting data to the API in a bulk load scenario).</p>
<h4>Requests with user context</h4>
<table class="grid">
<thead>
<tr>
<th align="left"><strong>Context property</strong></th>
<th align="left"><strong>Mandatory</strong></th>
<th align="left"><strong>Value</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>userIdentifier</code></td>
<td align="left">Yes</td>
<td align="left">The userid of the user as authenticated by the PMS/health application</td>
</tr>
<tr>
<td align="left"><code>secondaryIdentifier</code></td>
<td align="left">Yes</td>
<td align="left">The secondary identifier for the user - this <strong>MUST</strong> be the end users Common Person Number (aka HPI Practitioner identifier) of the practitioner using the application where available. Otherwise, any secondary identifier that is held for the user</td>
</tr>
<tr>
<td align="left"><code>purposeOfUse</code></td>
<td align="left">Yes</td>
<td align="left">One of [ "PATRQT", "POPHLTH", "TREAT", "ETREAT", "PUBHLTH", "SYSDEV" ]. For descriptions of the values, see <a href="https://fhir-ig.digital.health.nz/auditevents/ValueSet-purposeofuse.html">Audit Events</a></td>
</tr>
<tr>
<td align="left"><code>userFullName</code></td>
<td align="left">Yes</td>
<td align="left">Full name of the user of the PMS/health application.</td>
</tr>
<tr>
<td align="left"><code>userRole</code></td>
<td align="left">Yes</td>
<td align="left">Role of the user of the PMS/health application. Set to <code>"PROV"</code> (Provider) or <code>"PAT"</code> (Patient)</td>
</tr>
<tr>
<td align="left"><code>orgIdentifier</code></td>
<td align="left">No (preferred)</td>
<td align="left">The HPI Organisation Number (aka HPI Organisation identifier) for the organisation in which the API consumer application is deployed</td>
</tr>
<tr>
<td align="left"><code>facilityIdentifier</code></td>
<td align="left">No (preferred)</td>
<td align="left">HPI identifier for the facility where the user is located</td>
</tr>
</tbody>
</table>
<h4>Requests with system context</h4>
<table class="grid">
<thead>
<tr>
<th align="left"><strong>Context property</strong></th>
<th align="left"><strong>Mandatory</strong></th>
<th align="left"><strong>Value</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>userIdentifier</code></td>
<td align="left">Yes</td>
<td align="left">The oAuth clientId of the system submitting data to the API</td>
</tr>
<tr>
<td align="left"><code>purposeOfUse</code></td>
<td align="left">Yes</td>
<td align="left">[ "SYSDEV" ]. For descriptions of the values, see <a href="https://fhir-ig.digital.health.nz/auditevents/ValueSet-purposeofuse.html">Audit Events</a></td>
</tr>
<tr>
<td align="left"><code>userFullName</code></td>
<td align="left">Yes</td>
<td align="left">Name of the PMS/health application.</td>
</tr>
<tr>
<td align="left"><code>userRole</code></td>
<td align="left">Yes</td>
<td align="left">Role of the PMS/health application. Set to <code>"110150"</code> (Application)</td>
</tr>
</tbody>
</table>
<p>A schema definition and examples for <code>Request-Context</code> can be <a href="https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context.json">found here</a></p>
<h4>Example Request-Context Header Payload for a clinical user searching for a patient's Conditions</h4>
<p><strong>Base64 Encoded</strong></p>
<pre><code>ewogICJ1c2VySWRlbnRpZmllciI6ICJwbXMtaWQtMTIzIiwKICAidXNlclJvbGUiOiAiUFJPViIsCiAgInNlY29uZGFyeUlkZW50aWZpZXIiOiB7CiAgICAidXNlIjogIm9mZmljaWFsIiwKICAgICJzeXN0ZW0iOiAiaHR0cHM6Ly9zdGFuZGFyZHMuZGlnaXRhbC5oZWFsdGgubnovbnMvaHBpLXBlcnNvbi1pZCIsCiAgICAidmFsdWUiOiAiOTlaWlpTIgogIH0sCiAgInB1cnBvc2VPZlVzZSI6IFsKICAgICJQT1BITFRIIgogIF0sCiAgInVzZXJGdWxsTmFtZSI6ICJCZXZlcmx5IENydXNoZXIiLAogICJvcmdJZGVudGlmaWVyIjogIkcwMDAwMS1HIiwKICAiZmFjaWxpdHlJZGVudGlmaWVyIjogIkZaWjk5OS1CIgp9
</code></pre>
<p><strong>Decoded JSON</strong></p>
<pre><code class="language-json">{
"userIdentifier": "pms-id-123",
"userRole": "PROV",
"secondaryIdentifier": {
"use": "official",
"system": "https://standards.digital.health.nz/ns/hpi-person-id",
"value": "99ZZZS"
},
"purposeOfUse": [
"POPHLTH"
],
"userFullName": "Beverly Crusher",
"orgIdentifier": "G00001-G",
"facilityIdentifier": "FZZ999-B"
}
</code></pre>
<h4>Example Request-Context Header Payload for a system submitting data to the API, where there is no end user</h4>
<p><strong>Base64 Encoded</strong></p>
<pre><code>ICB7CiAgICAidXNlcklkZW50aWZpZXIiOiAiMWI4MjAwZDctM2E4Yy00ZmI2LThlNWMtY2VjNDU0MDk5OWQ1IiwKICAgICJ1c2VyUm9sZSI6ICIxMTAxNTAiLAogICAgInB1cnBvc2VPZlVzZSI6IFsKICAgICAgIlNZU0RFViIKICAgIF0sCiAgICAidXNlckZ1bGxOYW1lIjogIlNhbXBsZSBQTVMgSW50ZWdyYXRpb24gQXBwbGljYXRpb24iCiAgfQ==
</code></pre>
<p><strong>Decoded JSON</strong></p>
<pre><code class="language-json">{
"userIdentifier": "1b8200d7-3a8c-4fb6-8e5c-cec4540999d5",
"userRole": "110150",
"purposeOfUse": [
"SYSDEV"
],
"userFullName": "Sample PMS Integration Application"
}
</code></pre>
<h3>Mandatory search parameters</h3>
<p>All FHIR API search requests must include the HNZ mandatory search parameters. These are listed in the Combined Search Parameters section of each resource below.</p>
<h3>Error status codes</h3>
<h4>Read (GET) Operation Statuses</h4>
<table class="grid">
<thead>
<tr>
<th align="center"><strong>Code</strong></th>
<th align="left"><strong>Meaning</strong></th>
<th align="left"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">200</td>
<td align="left">OK</td>
<td align="left">The request was successful, and the response body contains the representation requested</td>
</tr>
<tr>
<td align="center">302</td>
<td align="left">FOUND</td>
<td align="left">A common redirect response; you can GET the representation at the URI in the Location response header</td>
</tr>
<tr>
<td align="center">304</td>
<td align="left">NOT MODIFIED</td>
<td align="left">Your client's cached version of the representation is still up to date</td>
</tr>
<tr>
<td align="center">400</td>
<td align="left">BAD REQUEST</td>
<td align="left">Missing or bad <code>Request-Context</code> custom header; FHIR request payload does not validate against Implementation Guide</td>
</tr>
<tr>
<td align="center">401</td>
<td align="left">UNAUTHORIZED</td>
<td align="left">The supplied credentials, if any, are not sufficient to access the resource</td>
</tr>
<tr>
<td align="center">403</td>
<td align="left">FORBIDDEN</td>
<td align="left">Insufficient privilege to access the requested FHIR resource/operation</td>
</tr>
<tr>
<td align="center">404</td>
<td align="left">NOT FOUND</td>
<td align="left">The requested representation was not found. Retrying this request is unlikely to be successful</td>
</tr>
<tr>
<td align="center">429</td>
<td align="left">TOO MANY REQUESTS</td>
<td align="left">Your application is sending too many simultaneous requests</td>
</tr>
<tr>
<td align="center">500</td>
<td align="left">SERVER ERROR</td>
<td align="left">An internal server error prevented return of the representation response</td>
</tr>
<tr>
<td align="center">503</td>
<td align="left">SERVICE UNAVAILABLE</td>
<td align="left">We are temporarily unable to return the representation. Please wait and try again later</td>
</tr>
</tbody>
</table>
<h4>Search (GET) Operation Statuses</h4>
<table class="grid">
<thead>
<tr>
<th align="center"><strong>Code</strong></th>
<th align="left"><strong>Meaning</strong></th>
<th align="left"><strong>OperationOutcome</strong> in response?</th>
<th align="left"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">200</td>
<td align="left">OK</td>
<td align="left">Yes, When there are additional messages about a match result</td>
<td align="left">The request was successful, and the response body contains the representation requested</td>
</tr>
<tr>
<td align="center">302</td>
<td align="left">FOUND</td>
<td align="left">No</td>
<td align="left">A common redirect response; you can GET the representation at the URI in the Location response header</td>
</tr>
<tr>
<td align="center">400</td>
<td align="left">BAD REQUEST</td>
<td align="left">Yes</td>
<td align="left">Missing or bad <code>Request-Context</code> custom header;<br>FHIR request payload does not validate against Implementation Guide</td>
</tr>
<tr>
<td align="center">401</td>
<td align="left">UNAUTHORIZED</td>
<td align="left">Yes</td>
<td align="left">The supplied credentials, if any, are not sufficient to access the resource</td>
</tr>
<tr>
<td align="center">403</td>
<td align="left">FORBIDDEN</td>
<td align="left">Yes</td>
<td align="left">Insufficient privilege to access the requested FHIR resource/operation. See <a href="./OperationOutcome-APIError-Unauthorised.html">OperationOutcome-APIError-Unauthorised</a></td>
</tr>
<tr>
<td align="center">429</td>
<td align="left">TOO MANY REQUESTS</td>
<td align="left">No</td>
<td align="left">Your application is sending too many simultaneous requests</td>
</tr>
<tr>
<td align="center">500</td>
<td align="left">SERVER ERROR</td>
<td align="left">No</td>
<td align="left">An internal server error prevented return of the representation response</td>
</tr>
<tr>
<td align="center">503</td>
<td align="left">SERVICE UNAVAILABLE</td>
<td align="left">No</td>
<td align="left">The server is temporarily unable to return the representation. Please wait and try again later</td>
</tr>
</tbody>
</table>
<h3>Non existent API endpoints</h3>
<p>When a consumer attempts to call a non-existent API end point, respond
with a <strong>501 Not Implemented</strong> status code.</p>
</div><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: yes</div><div class="col-lg-6">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>OAuth 2.0 - Client Credential flow.</p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li><li>Supports the <code>transaction</code>interaction.</li><li>Supports the <code>batch</code>interaction.</li></ul></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#AllergyIntolerance1-1">AllergyIntolerance</a></td><td><a href="StructureDefinition-SDHRAllergyIntolerance.html">https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>patient, category, clinical-status, code, identifier, recorder, severity, _lastUpdated, patient</td><td/><td/><td/></tr><tr><td><a href="#Condition1-2">Condition</a></td><td><a href="StructureDefinition-SDHRCondition.html">https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>patient, category, code, encounter, identifier, onset-date, participant, severity, subject, _lastUpdated, patient</td><td><code>Condition:encounter</code></td><td/><td/></tr><tr><td><a href="#Consent1-3">Consent</a></td><td><a href="StructureDefinition-SDHRConsent.html">https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRConsent</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>patient</td><td/><td/><td/></tr><tr><td><a href="#Encounter1-4">Encounter</a></td><td><a href="StructureDefinition-SDHREncounter.html">https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>patient, identifier, location, participant, participant-actor, status, subject, _lastUpdated, patient</td><td/><td/><td/></tr><tr><td><a href="#Observation1-5">Observation</a></td><td><a href="StructureDefinition-SDHRObservation.html">https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>patient, category, code, date, encounter, identifier, performer, status, subject, value-concept, value-date, value-quantity, value-string, _lastUpdated, patient</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="AllergyIntolerance1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>AllergyIntolerance</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-SDHRAllergyIntolerance.html">SDHRAllergyIntolerance</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">patient</a></td><td><code>reference</code></td><td><div><p>MANDATORY
Who the sensitivity is for
<a href="http://hl7.org/fhir/R4/patient.html">Patient</a></p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">category</a></td><td><code>token</code></td><td><div><p>Must be one of</p>
<ul>
<li>food</li>
<li>medication</li>
<li>environment</li>
<li>biologic
<a href="http://hl7.org/fhir/ValueSet/allergy-intolerance-category">AllergyIntolerance Category ValueSet</a></li>
</ul>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">clinical-status</a></td><td><code>token</code></td><td><div><p>Must be one of</p>
<ul>
<li>active</li>
<li>inactive</li>
<li>resolved
<a href="http://hl7.org/fhir/R4/valueset-allergyintolerance-clinical.html">AllergyIntolerance Clinical Status ValueSet</a></li>
</ul>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">code</a></td><td><code>token</code></td><td><div><p>Code that identifies the allergy or intolerance
<a href="http://hl7.org/fhir/ValueSet/allergyintolerance-code">AllergyIntolerance Code ValueSet</a></p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">identifier</a></td><td><code>token</code></td><td><div><p>A unique identifier assigned to this resource.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">recorder</a></td><td><code>reference</code></td><td><div><p>Who recorded the sensitivity
<a href="http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.recorder">AllergyIntolerance.recorder</a></p>
</div></td></tr><tr><td><b>SHALL</b></td><td>severity</td><td><code>token</code></td><td><div><p>mild | moderate | severe (of event as a whole).</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">patient</a></td><td><code>reference</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Condition1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Condition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-SDHRCondition.html">SDHRCondition</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">patient</a></td><td><code>reference</code></td><td><div><p><strong>MANDATORY</strong>
Who has the condition?</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">category</a></td><td><code>token</code></td><td><div><p>The category of the condition</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">code</a></td><td><code>token</code></td><td><div><p>The code for the condition</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">encounter</a></td><td><code>reference</code></td><td><div><p>Encounter associated with the condition</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">identifier</a></td><td><code>token</code></td><td><div><p>A unique identifier assigned to this resource.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">onset-date</a></td><td><code>date</code></td><td><div><p>Date the condition started</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>participant</td><td><code>reference</code></td><td><div><p>Persons involved in the encounter other than the patient.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">severity</a></td><td><code>token</code></td><td><div><p>The severity of the condition</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">subject</a></td><td><code>reference</code></td><td><div><p>Who has the condition?</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed.</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">patient</a></td><td><code>reference</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Consent1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Consent</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-SDHRConsent.html">SDHRConsent</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/consent.html#search">patient</a></td><td><code>reference</code></td><td><div><p>Who does the consent relate to</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Encounter1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Encounter</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-SDHREncounter.html">SDHREncounter</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">patient</a></td><td><code>reference</code></td><td><div><p><strong>MANDATORY</strong>
The patient or group present at the encounter</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">identifier</a></td><td><code>token</code></td><td><div><p>A unique identifier assigned to this resource.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>reference</code></td><td><div><p>Location the encounter takes place.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">participant</a></td><td><code>reference</code></td><td><div><p>Persons involved in the encounter other than the patient.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>participant-actor</td><td><code>reference</code></td><td><div><p>Persons involved in the encounter other than the patient.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">status</a></td><td><code>token</code></td><td><div><p>planned | arrived | triaged | in-progress | onleave | finished | cancelled +</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">subject</a></td><td><code>reference</code></td><td><div><p>The patient or group present at the encounter</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed.</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/encounter.html#search">patient</a></td><td><code>reference</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Observation</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-SDHRObservation.html">SDHRObservation</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">patient</a></td><td><code>reference</code></td><td><div><p><strong>MANDATORY</strong>
Who the observation is for
<a href="http://hl7.org/fhir/R4/patient.html">Patient</a></p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">category</a></td><td><code>token</code></td><td><div><p>The classification of the type of observation</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">code</a></td><td><code>token</code></td><td><div><p>Describes what was observed. Sometimes this is called the observation 'name'</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">date</a></td><td><code>date</code></td><td><div><p>Observation.effective
Obtained date/time. If the obtained element is a period, a date that falls in the period</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">encounter</a></td><td><code>reference</code></td><td><div><p>The Encounter resource associated with the Observation.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">identifier</a></td><td><code>token</code></td><td><div><p>A unique identifier assigned to this resource.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">performer</a></td><td><code>reference</code></td><td><div><p>Who performed the observation</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">status</a></td><td><code>token</code></td><td><div><p>The status of the observation</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">subject</a></td><td><code>reference</code></td><td><div><p>The subject that the observation is about</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">value-concept</a></td><td><code>token</code></td><td><div><p>The value of the observation, if the value is a CodeableConcept</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">value-date</a></td><td><code>date</code></td><td><div><p>The value of the observation, if the value is a date or period of time</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">value-quantity</a></td><td><code>quantity</code></td><td><div><p>The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">value-string</a></td><td><code>string</code></td><td><div><p>The value of the observation, if the value is a string, and also searches in CodeableConcept.text</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed.</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">patient</a></td><td><code>reference</code></td></tr></tbody></table></div></div></div></div></div><h3 id="operationsCap1">Operations</h3><h4 id="operationsSummary1">Use</h4></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension">
<extension url="licenseURL">
<valueUri
value="https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx"/>
</extension>
<extension url="externalDocs">
<valueUri value="https://fhir-ig.digital.health.nz/sdhr"/>
</extension>
<extension url="licenseName">
<valueString
value="Health New Zealand Digital Services Hub API Access and Use Agreement"/>
</extension>
<extension url="globalHeaders">
<extension
url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension">
<extension url="key">
<valueString value="X-Correlation-Id"/>
</extension>
<extension url="value">
<valueUri
value="https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Correlation-Id.json"/>
</extension>
<extension url="required">
<valueBoolean value="false"/>
</extension>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension">
<extension url="key">
<valueString value="Request-Context"/>
</extension>
<extension url="value">
<valueUri
value="https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Request-Context.json"/>
</extension>
<extension url="required">
<valueBoolean value="true"/>
</extension>
</extension>
</extension>
</extension>
<url
value="https://fhir-ig.digital.health.nz/sdhr/CapabilityStatement/SDHRCapabliityStatement"/>
<version value="0.5.0"/>
<name value="SDHRCapabliityStatement"/>
<title value="NZ Shared Digital Health Record API"/>
<status value="draft"/>
<experimental value="false"/>
<date value="2024-04-15T01:15:23.3688326Z"/>
<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="NZ Shared Digital Health Record API Capability Statement"/>
<kind value="capability"/>
<software>
<name value="NZ Shared Digital Health Record API"/>
<version value="1.0.0"/>
</software>
<implementation>
<description
value="Health NZ | Te Whatu Ora NZ Shared Digital Health Record API"/>
<url value="https://api.uat.sdhr.digital.health.nz/s2s"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+json"/>
<rest>
<mode value="server"/>
<documentation
value="### Request-Context custom header
All FHIR API requests MUST include the HNZ request context *custom header* which supplies identifiers for the health user
and organisation, or system behind the API request.
This context is supplied using the 'Request-Context' custom HTTP header in the form of a base64-encoded JSON object.
The value of the header has differing forms based on the type of request being made, namely whether it is in a user context (e.g. a clinical user searching for patient records), or a system context (e.g. a system submitting data to the API in a bulk load scenario).
#### Requests with user context
| **Context property** | **Mandatory** | **Value** |
|:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|
| `userIdentifier` | Yes | The userid of the user as authenticated by the PMS/health application |
| `secondaryIdentifier` | Yes | The secondary identifier for the user - this **MUST** be the end users Common Person Number (aka HPI Practitioner identifier) of the practitioner using the application where available. Otherwise, any secondary identifier that is held for the user |
| `purposeOfUse` | Yes | One of [ "PATRQT", "POPHLTH", "TREAT", "ETREAT", "PUBHLTH", "SYSDEV" ]. For descriptions of the values, see [Audit Events](https://fhir-ig.digital.health.nz/auditevents/ValueSet-purposeofuse.html) |
| `userFullName` | Yes | Full name of the user of the PMS/health application. |
| `userRole` | Yes | Role of the user of the PMS/health application. Set to `"PROV"` (Provider) or `"PAT"` (Patient) |
| `orgIdentifier` | No (preferred) | The HPI Organisation Number (aka HPI Organisation identifier) for the organisation in which the API consumer application is deployed |
| `facilityIdentifier` | No (preferred) | HPI identifier for the facility where the user is located |
#### Requests with system context
| **Context property** | **Mandatory** | **Value** |
|:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|
| `userIdentifier` | Yes | The oAuth clientId of the system submitting data to the API |
| `purposeOfUse` | Yes | [ "SYSDEV" ]. For descriptions of the values, see [Audit Events](https://fhir-ig.digital.health.nz/auditevents/ValueSet-purposeofuse.html) |
| `userFullName` | Yes | Name of the PMS/health application. |
| `userRole` | Yes | Role of the PMS/health application. Set to `"110150"` (Application) |
A schema definition and examples for `Request-Context` can be [found here](https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context.json)
#### Example Request-Context Header Payload for a clinical user searching for a patient's Conditions
**Base64 Encoded**
```
ewogICJ1c2VySWRlbnRpZmllciI6ICJwbXMtaWQtMTIzIiwKICAidXNlclJvbGUiOiAiUFJPViIsCiAgInNlY29uZGFyeUlkZW50aWZpZXIiOiB7CiAgICAidXNlIjogIm9mZmljaWFsIiwKICAgICJzeXN0ZW0iOiAiaHR0cHM6Ly9zdGFuZGFyZHMuZGlnaXRhbC5oZWFsdGgubnovbnMvaHBpLXBlcnNvbi1pZCIsCiAgICAidmFsdWUiOiAiOTlaWlpTIgogIH0sCiAgInB1cnBvc2VPZlVzZSI6IFsKICAgICJQT1BITFRIIgogIF0sCiAgInVzZXJGdWxsTmFtZSI6ICJCZXZlcmx5IENydXNoZXIiLAogICJvcmdJZGVudGlmaWVyIjogIkcwMDAwMS1HIiwKICAiZmFjaWxpdHlJZGVudGlmaWVyIjogIkZaWjk5OS1CIgp9
```
**Decoded JSON**
```json
{
"userIdentifier": "pms-id-123",
"userRole": "PROV",
"secondaryIdentifier": {
"use": "official",
"system": "https://standards.digital.health.nz/ns/hpi-person-id",
"value": "99ZZZS"
},
"purposeOfUse": [
"POPHLTH"
],
"userFullName": "Beverly Crusher",
"orgIdentifier": "G00001-G",
"facilityIdentifier": "FZZ999-B"
}
```
#### Example Request-Context Header Payload for a system submitting data to the API, where there is no end user
**Base64 Encoded**
```
ICB7CiAgICAidXNlcklkZW50aWZpZXIiOiAiMWI4MjAwZDctM2E4Yy00ZmI2LThlNWMtY2VjNDU0MDk5OWQ1IiwKICAgICJ1c2VyUm9sZSI6ICIxMTAxNTAiLAogICAgInB1cnBvc2VPZlVzZSI6IFsKICAgICAgIlNZU0RFViIKICAgIF0sCiAgICAidXNlckZ1bGxOYW1lIjogIlNhbXBsZSBQTVMgSW50ZWdyYXRpb24gQXBwbGljYXRpb24iCiAgfQ==
```
**Decoded JSON**
```json
{
"userIdentifier": "1b8200d7-3a8c-4fb6-8e5c-cec4540999d5",
"userRole": "110150",
"purposeOfUse": [
"SYSDEV"
],
"userFullName": "Sample PMS Integration Application"
}
```
### Mandatory search parameters
All FHIR API search requests must include the HNZ mandatory search parameters. These are listed in the Combined Search Parameters section of each resource below.
### Error status codes
#### Read (GET) Operation Statuses
|**Code**|**Meaning**|**Description**|
|:--:|:-----------------|:--|
|200|OK |The request was successful, and the response body contains the representation requested|
|302|FOUND |A common redirect response; you can GET the representation at the URI in the Location response header|
|304|NOT MODIFIED |Your client's cached version of the representation is still up to date|
|400|BAD REQUEST |Missing or bad `Request-Context` custom header; FHIR request payload does not validate against Implementation Guide|
|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to access the resource|
|403|FORBIDDEN |Insufficient privilege to access the requested FHIR resource/operation|
|404|NOT FOUND |The requested representation was not found. Retrying this request is unlikely to be successful|
|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|
|500|SERVER ERROR |An internal server error prevented return of the representation response|
|503|SERVICE UNAVAILABLE|We are temporarily unable to return the representation. Please wait and try again later|
#### Search (GET) Operation Statuses
|**Code**|**Meaning** |**OperationOutcome** in response?|**Description**|
|:--:|:-----------------|:----------------------------------|:----------------------------------|
|200|OK |Yes, When there are additional messages about a match result|The request was successful, and the response body contains the representation requested|
|302|FOUND |No |A common redirect response; you can GET the representation at the URI in the Location response header|
|400|BAD REQUEST |Yes|Missing or bad `Request-Context` custom header;<br>FHIR request payload does not validate against Implementation Guide|
|401|UNAUTHORIZED |Yes|The supplied credentials, if any, are not sufficient to access the resource|
|403|FORBIDDEN |Yes|Insufficient privilege to access the requested FHIR resource/operation. See [OperationOutcome-APIError-Unauthorised](./OperationOutcome-APIError-Unauthorised.html)|
|429|TOO MANY REQUESTS |No |Your application is sending too many simultaneous requests|
|500|SERVER ERROR |No |An internal server error prevented return of the representation response|
|503|SERVICE UNAVAILABLE|No |The server is temporarily unable to return the representation. Please wait and try again later|
### Non existent API endpoints
When a consumer attempts to call a non-existent API end point, respond
with a **501 Not Implemented** status code."/>
<security>
<extension
url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris">
<extension url="token">
<valueUri
value="https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"/>
</extension>
<extension url="authorize">
<valueUri
value="https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/authorize"/>
</extension>
</extension>
<extension
url="http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities">
<valueCode value="client-confidential-symmetric"/>
</extension>
<cors value="true"/>
<service>
<coding>
<code value="SMART-on-FHIR"/>
</coding>
</service>
<description value="OAuth 2.0 - Client Credential flow."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<type value="AllergyIntolerance"/>
<profile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance"/>
<documentation
value="Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="MANDATORY
Who the sensitivity is for
[Patient](http://hl7.org/fhir/R4/patient.html)"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category"/>
<type value="token"/>
<documentation
value="Must be one of
* food
* medication
* environment
* biologic
[AllergyIntolerance Category ValueSet](http://hl7.org/fhir/ValueSet/allergy-intolerance-category)"/>
</searchParam>
<searchParam>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status"/>
<type value="token"/>
<documentation
value="Must be one of
* active
* inactive
* resolved
[AllergyIntolerance Clinical Status ValueSet](http://hl7.org/fhir/R4/valueset-allergyintolerance-clinical.html)"/>
</searchParam>
<searchParam>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Code that identifies the allergy or intolerance
[AllergyIntolerance Code ValueSet](http://hl7.org/fhir/ValueSet/allergyintolerance-code)"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="A unique identifier assigned to this resource."/>
</searchParam>
<searchParam>
<name value="recorder"/>
<definition
value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder"/>
<type value="reference"/>
<documentation
value="Who recorded the sensitivity
[AllergyIntolerance.recorder](http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.recorder)"/>
</searchParam>
<searchParam>
<name value="severity"/>
<definition value="http://hl7.org/fhir/SearchParameter/severity"/>
<type value="token"/>
<documentation
value="mild | moderate | severe (of event as a whole)."/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<type value="Condition"/>
<profile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition"/>
<documentation
value="Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<searchInclude value="Condition:encounter"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="**MANDATORY**
Who has the condition?"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-category"/>
<type value="token"/>
<documentation value="The category of the condition"/>
</searchParam>
<searchParam>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation value="The code for the condition"/>
</searchParam>
<searchParam>
<name value="encounter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-encounter"/>
<type value="reference"/>
<documentation value="Encounter associated with the condition"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="A unique identifier assigned to this resource."/>
</searchParam>
<searchParam>
<name value="onset-date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-onset-date"/>
<type value="date"/>
<documentation value="Date the condition started"/>
</searchParam>
<searchParam>
<name value="participant"/>
<definition
value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-participant"/>
<type value="reference"/>
<documentation
value="Persons involved in the encounter other than the patient."/>
</searchParam>
<searchParam>
<name value="severity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-severity"/>
<type value="token"/>
<documentation value="The severity of the condition"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-subject"/>
<type value="reference"/>
<documentation value="Who has the condition?"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed."/>
</searchParam>
</resource>
<resource>
<type value="Consent"/>
<profile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRConsent"/>
<documentation
value="Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="Who does the consent relate to"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<type value="Encounter"/>
<profile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter"/>
<documentation
value="Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="**MANDATORY**
The patient or group present at the encounter"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="A unique identifier assigned to this resource."/>
</searchParam>
<searchParam>
<name value="location"/>
<definition value="http://hl7.org/fhir/SearchParameter/location"/>
<type value="reference"/>
<documentation value="Location the encounter takes place."/>
</searchParam>
<searchParam>
<name value="participant"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Encounter-participant"/>
<type value="reference"/>
<documentation
value="Persons involved in the encounter other than the patient."/>
</searchParam>
<searchParam>
<name value="participant-actor"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-participant-actor"/>
<type value="reference"/>
<documentation
value="Persons involved in the encounter other than the patient."/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Encounter-status"/>
<type value="token"/>
<documentation
value="planned | arrived | triaged | in-progress | onleave | finished | cancelled +"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Encounter-subject"/>
<type value="reference"/>
<documentation value="The patient or group present at the encounter"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<type value="Observation"/>
<profile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation"/>
<documentation
value="Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="**MANDATORY**
Who the observation is for
[Patient](http://hl7.org/fhir/R4/patient.html)"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-category"/>
<type value="token"/>
<documentation value="The classification of the type of observation"/>
</searchParam>
<searchParam>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Describes what was observed. Sometimes this is called the observation 'name'"/>
</searchParam>
<searchParam>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
<type value="date"/>
<documentation
value="Observation.effective
Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
</searchParam>
<searchParam>
<name value="encounter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-encounter"/>
<type value="reference"/>
<documentation
value="The Encounter resource associated with the Observation."/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="A unique identifier assigned to this resource."/>
</searchParam>
<searchParam>
<name value="performer"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-performer"/>
<type value="reference"/>
<documentation value="Who performed the observation"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-status"/>
<type value="token"/>
<documentation value="The status of the observation"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-subject"/>
<type value="reference"/>
<documentation value="The subject that the observation is about"/>
</searchParam>
<searchParam>
<name value="value-concept"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-value-concept"/>
<type value="token"/>
<documentation
value="The value of the observation, if the value is a CodeableConcept"/>
</searchParam>
<searchParam>
<name value="value-date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-value-date"/>
<type value="date"/>
<documentation
value="The value of the observation, if the value is a date or period of time"/>
</searchParam>
<searchParam>
<name value="value-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-value-quantity"/>
<type value="quantity"/>
<documentation
value="The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"/>
</searchParam>
<searchParam>
<name value="value-string"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-value-string"/>
<type value="string"/>
<documentation
value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed."/>
</searchParam>
</resource>
<interaction>
<code value="search-system"/>
</interaction>
<interaction>
<code value="transaction"/>
</interaction>
<interaction>
<code value="batch"/>
</interaction>
<operation>
<name value="participate"/>
<definition
value="https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation"/>
<documentation
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 some 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."/>
</operation>
</rest>
</CapabilityStatement>