New Zealand Rheumatic Fever FHIR Implementation Guide
0.5.0 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide
0.5.0 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-06-14 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="RheumaticFeverCapabilityStatement"/>
<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 RheumaticFeverCapabilityStatement</b></p><a name="RheumaticFeverCapabilityStatement"> </a><a name="hcRheumaticFeverCapabilityStatement"> </a><a name="RheumaticFeverCapabilityStatement-en-US"> </a><h2 id="title">Rheumatic Fever FHIR API Capability Statement</h2><ul><li>Implementation Guide Version: 0.5.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-06-14 </li><li>Published by: Te Whatu Ora </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 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><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction described as follows:<div><h3>Request-Context custom header</h3>
<p>All HNZ FHIR API requests must include the health user and context of usage of the application making the API request.</p>
<p>This context is supplied using the 'Request-Context' custom header in the form of a base64-encoded JSON object.</p>
<p>Consumers of the Rheumatic Fever FHIR API must set the following properties in <code>Request-Context</code></p>
<table class="grid">
<thead>
<tr>
<th align="left"><strong>Required context property</strong></th>
<th align="left"><strong>Attribute value</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>userIdentifier</code></td>
<td align="left">The userid of the user as authenticated by RFCCS or the PMS/health application.</td>
</tr>
<tr>
<td align="left"><code>purposeOfUse</code></td>
<td align="left">Set to <code>"POPHEALTH"</code></td>
</tr>
<tr>
<td align="left"><code>userFullName</code></td>
<td align="left">Display name of the user of RFCCS or the PMS/health application.</td>
</tr>
<tr>
<td align="left"><code>hpiOrganisation</code></td>
<td align="left">The HPI Organisation identifier for the RF Secondary Prevention Service (aka Lead Provider) the user is affiliated with</td>
</tr>
<tr>
<td align="left"><code>hpiPractitioner</code></td>
<td align="left">If available, the HPI Practitioner identifier (Common Person Number) of the user</td>
</tr>
<tr>
<td align="left"><code>hpiFacility</code></td>
<td align="left">If available, the HPI Facility identifier of the health facility where the application is being used</td>
</tr>
</tbody>
</table>
<p>The schema for defining and validating these properties can be <a href="https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json">found here</a></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">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">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">Incorrect search parameters or malformed request - see diagnostics in OperationOutcome</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>
<td align="left"/>
</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>
<h4>Create (POST or PUT) 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 resource was updated. The response body contains the updated representation</td>
</tr>
<tr>
<td align="center">201</td>
<td align="left">CREATED</td>
<td align="left">The request was successful, a new resource was created, and the response body contains the representation</td>
</tr>
<tr>
<td align="center">204</td>
<td align="left">OK - NO CONTENT</td>
<td align="left">The request was successful, but no content is returned in the response. In reality this is seldom used for REST APIs and more typically for process APIs. Should include a <code>Location</code> header indicating the location of an associated relevant resource</td>
</tr>
<tr>
<td align="center">207</td>
<td align="left">MULTI STATUS</td>
<td align="left">The HTTP 207 Multi-Status response code indicates that there might be a mixture of responses.</td>
</tr>
<tr>
<td align="center">400</td>
<td align="left">BAD REQUEST</td>
<td align="left">The data given in the POST or PUT failed validation. Inspect the response body for details</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 create or update the resource</td>
</tr>
<tr>
<td align="center">404</td>
<td align="left">NOT FOUND</td>
<td align="left">The endpoint that the API Consumer is attempting to create or update does not exist. Retrying this request is unlikely to be successful</td>
</tr>
<tr>
<td align="center">405</td>
<td align="left">METHOD NOT ALLOWED</td>
<td align="left">You can't POST or PUT to the resource</td>
</tr>
<tr>
<td align="center">422</td>
<td align="left">UNPROCESSABLE CONTENT</td>
<td align="left">The server understands the requests content and syntax however it is unable to process the instruction. Retrying this request will not succeed - the request must be modified</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">We couldn't create or update the resource. Please try again later</td>
</tr>
</tbody>
</table>
<h4>Delete (DELETE) 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">204</td>
<td align="left">OK</td>
<td align="left">The request was successful; the resource was deleted</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 delete the resource</td>
</tr>
<tr>
<td align="center">404</td>
<td align="left">NOT FOUND</td>
<td align="left"/>
</tr>
<tr>
<td align="center">405</td>
<td align="left">METHOD NOT ALLOWED</td>
<td align="left">You can't DELETE the resource</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">We couldn't delete the resource. Please 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></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 past versions of resources (vread interaction)">V-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="#Bundle1-1">Bundle</a></td><td><a href="http://hl7.org/fhir/R4/bundle.html">http://hl7.org/fhir/StructureDefinition/Bundle</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 class="text-center">y</td><td>patient, actor, status, date</td><td><code>*</code></td><td/><td/></tr><tr><td><a href="#CarePlan1-2">CarePlan</a></td><td><a href="StructureDefinition-nz-rheumaticfever-careplan.html">https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careplan</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 class="text-center">y</td><td>patient, status, subject, _profile, _id, category</td><td><code>*</code>, <code>CarePlan:encounter</code></td><td/><td/></tr><tr><td><a href="#CareTeam1-3">CareTeam</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-nz-rheumaticfever-careteam.html">Rheumatic Fever Care Team</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 class="text-center">y</td><td>identifier, _profile, _id, category</td><td/><td/><td/></tr><tr><td><a href="#Condition1-4">Condition</a></td><td><a href="StructureDefinition-nz-rheumaticfever-condition.html">https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-condition</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 class="text-center">y</td><td>patient, subject, _profile, _id, category</td><td/><td/><td/></tr><tr><td><a href="#Consent1-5">Consent</a></td><td><a href="http://hl7.org/fhir/R4/consent.html">http://hl7.org/fhir/StructureDefinition/Consent</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 class="text-center">y</td><td>patient, data, source-reference, status, _id</td><td><code>*</code>, <code>Consent:source-reference</code></td><td/><td/></tr><tr><td><a href="#Encounter1-6">Encounter</a></td><td><a href="http://hl7.org/fhir/R4/encounter.html">http://hl7.org/fhir/StructureDefinition/Encounter</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 class="text-center">y</td><td>patient, status, subject, _id</td><td><code>*</code>, <code>Encounter:diagnosis</code></td><td/><td/></tr><tr><td><a href="#MedicationRequest1-7">MedicationRequest</a></td><td><a href="StructureDefinition-nz-rheumaticfever-medicationrequest.html">https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-medicationrequest</a><br/><em>Additional supported profiles:</em><br/> <a href="https://build.fhir.org/ig/HL7NZ/nzbase/StructureDefinition-NzMedicationRequest.html">MedicationRequest resource for use in NZ</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 class="text-center">y</td><td>patient, status, medication</td><td><code>*</code></td><td/><td/></tr><tr><td><a href="#MedicationStatement1-8">MedicationStatement</a></td><td><a href="http://hl7.org/fhir/R4/medicationstatement.html">http://hl7.org/fhir/StructureDefinition/MedicationStatement</a><br/><em>Additional supported profiles:</em><br/> <a href="https://build.fhir.org/ig/HL7NZ/nzbase/StructureDefinition-NzMedicationStatement.html">MedicationStatement resource for use in NZ</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 class="text-center">y</td><td>patient, status, medication</td><td><code>*</code></td><td/><td/></tr><tr><td><a href="#Observation1-9">Observation</a></td><td><a href="http://hl7.org/fhir/R4/observation.html">http://hl7.org/fhir/StructureDefinition/Observation</a><br/><em>Additional supported profiles:</em><br/> <a href="StructureDefinition-nz-rheumaticfever-diagnosisgroup.html">Rheumatic Fever Diagnosis Group</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 class="text-center">y</td><td>code, date, identifier, patient, based-on, encounter, category, derived-from, performer, status, subject, value-concept, value-date, value-quantity, value-string, _id, _lastUpdated</td><td><code>*</code>, <code>Observation:patient</code>, <code>Observation:encounter</code>, <code>Observation:based-on</code>, <code>Observation:derived-from</code>, <code>Observation:device</code>, <code>Observation:focus</code>, <code>Observation:has-member</code>, <code>Observation:part-of</code>, <code>Observation:performer</code>, <code>Observation:specimen</code>, <code>Observation:subject</code></td><td/><td/></tr><tr><td><a href="#Patient1-10">Patient</a></td><td><a href="StructureDefinition-nz-rheumaticfever-patient.html">https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-patient</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 class="text-center">y</td><td>identifier, _profile, _id</td><td/><td/><td/></tr><tr><td><a href="#Questionnaire1-11">Questionnaire</a></td><td> </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 class="text-center">y</td><td>identifier, name, status, title, url, _id</td><td/><td/><td/></tr><tr><td><a href="#QuestionnaireResponse1-12">QuestionnaireResponse</a></td><td> </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 class="text-center">y</td><td>patient, questionnaire, status, subject, _id</td><td><code>*</code>, <code>QuestionnaireResponse:based-on</code>, <code>QuestionnaireResponse:encounter</code></td><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Bundle1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Bundle</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="http://hl7.org/fhir/R4/bundle.html">Bundle</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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/bundle.html#search">patient</a></td><td><code>reference</code></td><td><div><p>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/bundle.html#search">actor</a></td><td><code>reference</code></td><td><div><p>Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/bundle.html#search">status</a></td><td><code>token</code></td><td><div><p>proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/bundle.html#search">date</a></td><td><code>date</code></td><td><div><p>Appointment date/time</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="CarePlan1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>CarePlan</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-nz-rheumaticfever-careplan.html">Rheumatic Fever CarePlan</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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/careplan.html#search">patient</a></td><td><code>reference</code></td><td><div><p>Who the care plan is for</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/careplan.html#search">status</a></td><td><code>token</code></td><td><div><p>draft | active | on-hold | revoked | completed | entered-in-error | unknown</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/careplan.html#search">subject</a></td><td><code>reference</code></td><td><div><p>Who the care plan is for</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>reference</code></td><td><div><p>Filter <strong>RheumaticFeverCarePlan instances</strong> using the applicable profile canonical Url from IG</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Care plan search by category code. All rheumatic fever care plans are categorised #rf-nz</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="CareTeam1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>CareTeam</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/careteam.html">CareTeam</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-nz-rheumaticfever-careteam.html">Rheumatic Fever Care Team</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This server supports one subtype of FHIR CareTeam - refer to Profiles</p>
<ol>
<li>RheumaticFeverCareTeam - simply requires use of particular Condition.category codes in rheumatic fever health applications</li>
</ol>
</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>identifier</td><td><code>token</code></td><td><div><p>The patient's official NHI identifier</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>reference</code></td><td><div><p>Filter <strong>RheumaticFeverCareTeam instances</strong> using the applicable profile canonical Url from IG</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Care team search by category code. All rheumatic fever care teams are categorised #rf-nz</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="Condition1-4" 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-nz-rheumaticfever-condition.html">Rheumatic Fever Condition</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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>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">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>_profile</td><td><code>reference</code></td><td><div><p>Filter <strong>RheumaticFeverCondition instances</strong> using the applicable profile canonical Url from IG</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Condition search by category code. All rheumatic fever condtion instances have two category values (#rf-nz, SNOMED #58718002)</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="Consent1-5" 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="http://hl7.org/fhir/R4/consent.html">Consent</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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 the consent applies to</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/consent.html#search">data</a></td><td><code>reference</code></td><td><div><p>The actual data reference</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/consent.html#search">source-reference</a></td><td><code>reference</code></td><td><div><p>Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/consent.html#search">status</a></td><td><code>token</code></td><td><div><p>draft | proposed | active | rejected | inactive | entered-in-error</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</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-6" 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="http://hl7.org/fhir/R4/encounter.html">Encounter</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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>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">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">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</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="MedicationRequest1-7" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>MedicationRequest</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-nz-rheumaticfever-medicationrequest.html">Rheumatic Fever Medication Request</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-6"><span class="lead">Supported Profiles</span><p><a href="https://build.fhir.org/ig/HL7NZ/nzbase/StructureDefinition-NzMedicationRequest.html">MedicationRequest resource for use in NZ</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This server profiles NzMedicationRequest AND supports the NZ Base IG profile NzMedicationRequest.</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/medicationrequest.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The rheumatic fever patient for whom this medication is prescribed</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">status</a></td><td><code>token</code></td><td><div><p>active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown +</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">medication</a></td><td><code>reference</code></td><td><div><p>Return all MedicationRequests that relate to this type of medication</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="MedicationStatement1-8" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>MedicationStatement</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="http://hl7.org/fhir/R4/medicationstatement.html">MedicationStatement</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-6"><span class="lead">Supported Profiles</span><p><a href="https://build.fhir.org/ig/HL7NZ/nzbase/StructureDefinition-NzMedicationStatement.html">MedicationStatement resource for use in NZ</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This server supports the NZ Base IG profiles NzMedicationStatement in addition to the base MedicationStatement FHIR resource.</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/medicationstatement.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The rheumatic fever patient to whom medication was administered</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationstatement.html#search">status</a></td><td><code>token</code></td><td><div><p>active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken +</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationstatement.html#search">medication</a></td><td><code>reference</code></td><td><div><p>Return all instances of administration of this medication</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="Observation1-9" 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="http://hl7.org/fhir/R4/observation.html">Observation</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-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-nz-rheumaticfever-diagnosisgroup.html">Rheumatic Fever Diagnosis Group</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><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">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">identifier</a></td><td><code>token</code></td><td><div><p>A unique identifier assigned to this observation.</p>
</div></td></tr><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>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">based-on</a></td><td><code>reference</code></td><td><div><p>Reference to the service request.</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">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">derived-from</a></td><td><code>reference</code></td><td><div><p>Related measurements the observation is made from</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">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</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"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-10" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Patient</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-nz-rheumaticfever-patient.html">Rheumatic Fever Patient</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>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This server supports one profile of FHIR Patient which is the rheumatic fever patient profile</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>identifier</td><td><code>token</code></td><td><div><p>The patient's official NHI identifier</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>reference</code></td><td><div><p>Filter <strong>RheumaticFeverPatient instances</strong> using the applicable profile canonical Url from IG</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</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="Questionnaire1-11" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Questionnaire</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><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/questionnaire.html#search">identifier</a></td><td><code>token</code></td><td><div><p>External identifier for the questionnaire</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">name</a></td><td><code>string</code></td><td><div><p>Computationally friendly name of the questionnaire</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">status</a></td><td><code>token</code></td><td><div><p>The current status of the questionnaire</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">title</a></td><td><code>string</code></td><td><div><p>The human-friendly name of the questionnaire</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">url</a></td><td><code>uri</code></td><td><div><p>The uri that identifies the questionnaire</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</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="QuestionnaireResponse1-12" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>QuestionnaireResponse</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><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/questionnaireresponse.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The patient that is the subject of the questionnaire response</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">questionnaire</a></td><td><code>reference</code></td><td><div><p>The questionnaire the answers are provided for</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">status</a></td><td><code>token</code></td><td><div><p>The status of the questionnaire response</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">subject</a></td><td><code>reference</code></td><td><div><p>The subject of the questionnaire response</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></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/rf"/>
</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="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="x-api-key"/>
</extension>
<extension url="value">
<valueUri
value="https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Api-Key.json"/>
</extension>
<extension url="required">
<valueBoolean value="true"/>
</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/openapi-definitions/Request-Context.json"/>
</extension>
<extension url="required">
<valueBoolean value="true"/>
</extension>
<extension url="documentation">
<valueString
value="A base64-encoded JSON object that defines the context of the current request.
See https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json for the schema this object must conform to."/>
</extension>
</extension>
</extension>
</extension>
<url
value="https://fhir-ig.digital.health.nz/rheumatic-fever/CapabilityStatement/RheumaticFeverCapabilityStatement"/>
<version value="0.5.0"/>
<name value="RheumaticFeverAPICapabilityStatement"/>
<title value="Rheumatic Fever FHIR API Capability Statement"/>
<status value="active"/>
<date value="2024-06-14"/>
<publisher value="Te Whatu Ora"/>
<contact>
<name value="Te Whatu Ora"/>
<telecom>
<system value="url"/>
<value value="https://www.tewhatuora.govt.nz/"/>
</telecom>
<telecom>
<system value="email"/>
<value value="integration@tewhatuora.govt.nz"/>
</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="New Zealand rheumatic fever FHIR API capability statement"/>
<kind value="instance"/>
<implementation>
<description value="NZ Rheumatic Fever FHIR API"/>
<url value="https://fhir.api.digital.health.nz/R4"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<rest>
<mode value="server"/>
<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>
<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>
</security>
<resource>
<type value="Bundle"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Who the sensitivity is for
[Patient](http://hl7.org/fhir/R4/patient.html)"/>
</searchParam>
<searchParam>
<name value="actor"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Appointment-actor"/>
<type value="reference"/>
<documentation
value="Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location)"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Appointment-status"/>
<type value="token"/>
<documentation
value="proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist"/>
</searchParam>
<searchParam>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
<type value="date"/>
<documentation value="Appointment date/time"/>
</searchParam>
</resource>
<resource>
<type value="CarePlan"/>
<profile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careplan"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchInclude value="CarePlan:encounter"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="Who the care plan is for"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CarePlan-status"/>
<type value="token"/>
<documentation
value="draft | active | on-hold | revoked | completed | entered-in-error | unknown"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CarePlan-subject"/>
<type value="reference"/>
<documentation value="Who the care plan is for"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Resource-profile"/>
<type value="reference"/>
<documentation
value="Filter **RheumaticFeverCarePlan instances** using the applicable profile canonical Url from IG"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#CarePlan-category"/>
<type value="token"/>
<documentation
value="Care plan search by category code. All rheumatic fever care plans are categorised #rf-nz"/>
</searchParam>
</resource>
<resource>
<type value="CareTeam"/>
<supportedProfile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careteam"/>
<documentation
value="
This server supports one subtype of FHIR CareTeam - refer to Profiles
1. RheumaticFeverCareTeam - simply requires use of particular Condition.category codes in rheumatic fever health applications
"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchParam>
<name value="identifier"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier"/>
<type value="token"/>
<documentation value="The patient's official NHI identifier"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Resource-profile"/>
<type value="reference"/>
<documentation
value="Filter **RheumaticFeverCareTeam instances** using the applicable profile canonical Url from IG"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#CareTeam-category"/>
<type value="token"/>
<documentation
value="Care team search by category code. All rheumatic fever care teams are categorised #rf-nz"/>
</searchParam>
</resource>
<resource>
<type value="Condition"/>
<profile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-condition"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="Who has 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="_profile"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Resource-profile"/>
<type value="reference"/>
<documentation
value="Filter **RheumaticFeverCondition instances** using the applicable profile canonical Url from IG"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
<searchParam>
<name value="category"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Condition-category"/>
<type value="token"/>
<documentation
value="Condition search by category code. All rheumatic fever condtion instances have two category values (#rf-nz, SNOMED #58718002)"/>
</searchParam>
</resource>
<resource>
<type value="Consent"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Consent"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchInclude value="Consent:source-reference"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="Who the consent applies to"/>
</searchParam>
<searchParam>
<name value="data"/>
<definition value="http://hl7.org/fhir/SearchParameter/Consent-data"/>
<type value="reference"/>
<documentation value="The actual data reference"/>
</searchParam>
<searchParam>
<name value="source-reference"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Consent-source-reference"/>
<type value="reference"/>
<documentation
value="Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Consent-status"/>
<type value="token"/>
<documentation
value="draft | proposed | active | rejected | inactive | entered-in-error"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
</resource>
<resource>
<type value="Encounter"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Encounter"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchInclude value="Encounter:diagnosis"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="The patient or group present at the encounter"/>
</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="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
</resource>
<resource>
<type value="MedicationRequest"/>
<profile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-medicationrequest"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest"/>
<documentation
value="
This server profiles NzMedicationRequest AND supports the NZ Base IG profile NzMedicationRequest.
"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The rheumatic fever patient for whom this medication is prescribed"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Medication-status"/>
<type value="token"/>
<documentation
value="active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown +"/>
</searchParam>
<searchParam>
<name value="medication"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-medication"/>
<type value="reference"/>
<documentation
value="Return all MedicationRequests that relate to this type of medication"/>
</searchParam>
</resource>
<resource>
<type value="MedicationStatement"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/MedicationStatement"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/NzMedicationStatement"/>
<documentation
value="
This server supports the NZ Base IG profiles NzMedicationStatement in addition to the base MedicationStatement FHIR resource.
"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The rheumatic fever patient to whom medication was administered"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Medication-status"/>
<type value="token"/>
<documentation
value="active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken +"/>
</searchParam>
<searchParam>
<name value="medication"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-medication"/>
<type value="reference"/>
<documentation
value="Return all instances of administration of this medication"/>
</searchParam>
</resource>
<resource>
<type value="Observation"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Observation"/>
<supportedProfile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-diagnosisgroup"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchInclude value="Observation:patient"/>
<searchInclude value="Observation:encounter"/>
<searchInclude value="Observation:based-on"/>
<searchInclude value="Observation:derived-from"/>
<searchInclude value="Observation:device"/>
<searchInclude value="Observation:focus"/>
<searchInclude value="Observation:has-member"/>
<searchInclude value="Observation:part-of"/>
<searchInclude value="Observation:performer"/>
<searchInclude value="Observation:specimen"/>
<searchInclude value="Observation:subject"/>
<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="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="A unique identifier assigned to this observation."/>
</searchParam>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Who the observation is for
[Patient](http://hl7.org/fhir/R4/patient.html)"/>
</searchParam>
<searchParam>
<name value="based-on"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-based-on"/>
<type value="reference"/>
<documentation value="Reference to the service request."/>
</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="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="derived-from"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-derived-from"/>
<type value="reference"/>
<documentation
value="Related measurements the observation is made from"/>
</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="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</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="Patient"/>
<profile
value="https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-patient"/>
<documentation
value="
This server supports one profile of FHIR Patient which is the rheumatic fever patient profile
"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchParam>
<name value="identifier"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier"/>
<type value="token"/>
<documentation value="The patient's official NHI identifier"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<definition
value="https://hl7.org/fhir/searchparameter-registry.html#Resource-profile"/>
<type value="reference"/>
<documentation
value="Filter **RheumaticFeverPatient instances** using the applicable profile canonical Url from IG"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
</resource>
<resource>
<type value="Questionnaire"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-identifier"/>
<type value="token"/>
<documentation value="External identifier for the questionnaire"/>
</searchParam>
<searchParam>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-name"/>
<type value="string"/>
<documentation
value="Computationally friendly name of the questionnaire"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-status"/>
<type value="token"/>
<documentation value="The current status of the questionnaire"/>
</searchParam>
<searchParam>
<name value="title"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-title"/>
<type value="string"/>
<documentation value="The human-friendly name of the questionnaire"/>
</searchParam>
<searchParam>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-url"/>
<type value="uri"/>
<documentation value="The uri that identifies the questionnaire"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
</resource>
<resource>
<type value="QuestionnaireResponse"/>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="*"/>
<searchInclude value="QuestionnaireResponse:based-on"/>
<searchInclude value="QuestionnaireResponse:encounter"/>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient"/>
<type value="reference"/>
<documentation
value="The patient that is the subject of the questionnaire response"/>
</searchParam>
<searchParam>
<name value="questionnaire"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire"/>
<type value="reference"/>
<documentation
value="The questionnaire the answers are provided for"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status"/>
<type value="token"/>
<documentation value="The status of the questionnaire response"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject"/>
<type value="reference"/>
<documentation value="The subject of the questionnaire response"/>
</searchParam>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
</resource>
<interaction>
<code value="transaction"/>
<documentation
value="### Request-Context custom header
All HNZ FHIR API requests must include the health user and context of usage of the application making the API request.
This context is supplied using the 'Request-Context' custom header in the form of a base64-encoded JSON object.
Consumers of the Rheumatic Fever FHIR API must set the following properties in `Request-Context`
|**Required context property**|**Attribute value**|
|:------------------|:---------|
| `userIdentifier` | The userid of the user as authenticated by RFCCS or the PMS/health application. |
| `purposeOfUse` | Set to `"POPHEALTH"` |
| `userFullName` | Display name of the user of RFCCS or the PMS/health application. |
| `hpiOrganisation` | The HPI Organisation identifier for the RF Secondary Prevention Service (aka Lead Provider) the user is affiliated with |
| `hpiPractitioner` | If available, the HPI Practitioner identifier (Common Person Number) of the user |
| `hpiFacility` | If available, the HPI Facility identifier of the health facility where the application is being used |
The schema for defining and validating these properties can be [found here](https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json)
### 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|
|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to access the resource|
|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|Incorrect search parameters or malformed request - see diagnostics in OperationOutcome|
|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to access the resource|
|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|
#### Create (POST or PUT) Operation Statuses
|**Code**|**Meaning**|**Description**|
|:--:|:-----------------|:--|
|200|OK |The request was successful, and the resource was updated. The response body contains the updated representation|
|201|CREATED |The request was successful, a new resource was created, and the response body contains the representation|
|204|OK - NO CONTENT |The request was successful, but no content is returned in the response. In reality this is seldom used for REST APIs and more typically for process APIs. Should include a `Location` header indicating the location of an associated relevant resource|
|207|MULTI STATUS |The HTTP 207 Multi-Status response code indicates that there might be a mixture of responses.|
|400|BAD REQUEST |The data given in the POST or PUT failed validation. Inspect the response body for details|
|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to create or update the resource|
|404|NOT FOUND |The endpoint that the API Consumer is attempting to create or update does not exist. Retrying this request is unlikely to be successful|
|405|METHOD NOT ALLOWED |You can't POST or PUT to the resource|
|422|UNPROCESSABLE CONTENT|The server understands the requests content and syntax however it is unable to process the instruction. Retrying this request will not succeed - the request must be modified|
|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|
|500|SERVER ERROR |We couldn't create or update the resource. Please try again later|
#### Delete (DELETE) Operation Statuses
|**Code**|**Meaning**|**Description**|
|:--:|:-----------------|:--|
|204|OK |The request was successful; the resource was deleted|
|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to delete the resource|
|404|NOT FOUND | |
|405|METHOD NOT ALLOWED |You can't DELETE the resource|
|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|
|500|SERVER ERROR |We couldn't delete the resource. Please 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."/>
</interaction>
</rest>
</CapabilityStatement>