New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-06-14 |
{
"resourceType" : "CapabilityStatement",
"id" : "RheumaticFeverCapabilityStatement",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"
]
},
"text" : {
"status" : "extensions",
"div" : "<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: 1.0.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>\n<p>All HNZ FHIR API requests must include the health user and context of usage of the application making the API request.</p>\n<p>This context is supplied using the 'Request-Context' custom header in the form of a base64-encoded JSON object.</p>\n<p>Consumers of the Rheumatic Fever FHIR API must set the following properties in <code>Request-Context</code></p>\n<table class=\"grid\">\n<thead>\n<tr>\n<th align=\"left\"><strong>Required context property</strong></th>\n<th align=\"left\"><strong>Attribute value</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>userIdentifier</code></td>\n<td align=\"left\">The userid of the user as authenticated by RFCCS or the PMS/health application.</td>\n</tr>\n<tr>\n<td align=\"left\"><code>purposeOfUse</code></td>\n<td align=\"left\">Set to <code>"POPHEALTH"</code></td>\n</tr>\n<tr>\n<td align=\"left\"><code>userFullName</code></td>\n<td align=\"left\">Display name of the user of RFCCS or the PMS/health application.</td>\n</tr>\n<tr>\n<td align=\"left\"><code>hpiOrganisation</code></td>\n<td align=\"left\">The HPI Organisation identifier for the RF Secondary Prevention Service (aka Lead Provider) the user is affiliated with</td>\n</tr>\n<tr>\n<td align=\"left\"><code>hpiPractitioner</code></td>\n<td align=\"left\">If available, the HPI Practitioner identifier (Common Person Number) of the user</td>\n</tr>\n<tr>\n<td align=\"left\"><code>hpiFacility</code></td>\n<td align=\"left\">If available, the HPI Facility identifier of the health facility where the application is being used</td>\n</tr>\n</tbody>\n</table>\n<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>\n<h3>Error status codes</h3>\n<h4>Read (GET) Operation Statuses</h4>\n<table class=\"grid\">\n<thead>\n<tr>\n<th align=\"center\"><strong>Code</strong></th>\n<th align=\"left\"><strong>Meaning</strong></th>\n<th align=\"left\"><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"center\">200</td>\n<td align=\"left\">OK</td>\n<td align=\"left\">The request was successful, and the response body contains the representation requested</td>\n</tr>\n<tr>\n<td align=\"center\">302</td>\n<td align=\"left\">FOUND</td>\n<td align=\"left\">A common redirect response; you can GET the representation at the URI in the Location response header</td>\n</tr>\n<tr>\n<td align=\"center\">304</td>\n<td align=\"left\">NOT MODIFIED</td>\n<td align=\"left\">Your client's cached version of the representation is still up to date</td>\n</tr>\n<tr>\n<td align=\"center\">401</td>\n<td align=\"left\">UNAUTHORIZED</td>\n<td align=\"left\">The supplied credentials, if any, are not sufficient to access the resource</td>\n</tr>\n<tr>\n<td align=\"center\">404</td>\n<td align=\"left\">NOT FOUND</td>\n<td align=\"left\">The requested representation was not found. Retrying this request is unlikely to be successful</td>\n</tr>\n<tr>\n<td align=\"center\">429</td>\n<td align=\"left\">TOO MANY REQUESTS</td>\n<td align=\"left\">Your application is sending too many simultaneous requests</td>\n</tr>\n<tr>\n<td align=\"center\">500</td>\n<td align=\"left\">SERVER ERROR</td>\n<td align=\"left\">An internal server error prevented return of the representation response</td>\n</tr>\n<tr>\n<td align=\"center\">503</td>\n<td align=\"left\">SERVICE UNAVAILABLE</td>\n<td align=\"left\">We are temporarily unable to return the representation. Please wait and try again later</td>\n</tr>\n</tbody>\n</table>\n<h4>Search (GET) Operation Statuses</h4>\n<table class=\"grid\">\n<thead>\n<tr>\n<th align=\"center\"><strong>Code</strong></th>\n<th align=\"left\"><strong>Meaning</strong></th>\n<th align=\"left\"><strong>OperationOutcome</strong> in response?</th>\n<th align=\"left\"><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"center\">200</td>\n<td align=\"left\">OK</td>\n<td align=\"left\">Yes, when there are additional messages about a match result</td>\n<td align=\"left\">The request was successful, and the response body contains the representation requested</td>\n</tr>\n<tr>\n<td align=\"center\">302</td>\n<td align=\"left\">FOUND</td>\n<td align=\"left\">No</td>\n<td align=\"left\">A common redirect response; you can GET the representation at the URI in the Location response header</td>\n</tr>\n<tr>\n<td align=\"center\">400</td>\n<td align=\"left\">BAD REQUEST</td>\n<td align=\"left\">Yes</td>\n<td align=\"left\">Incorrect search parameters or malformed request - see diagnostics in OperationOutcome</td>\n</tr>\n<tr>\n<td align=\"center\">401</td>\n<td align=\"left\">UNAUTHORIZED</td>\n<td align=\"left\">The supplied credentials, if any, are not sufficient to access the resource</td>\n<td align=\"left\"/>\n</tr>\n<tr>\n<td align=\"center\">429</td>\n<td align=\"left\">TOO MANY REQUESTS</td>\n<td align=\"left\">No</td>\n<td align=\"left\">Your application is sending too many simultaneous requests</td>\n</tr>\n<tr>\n<td align=\"center\">500</td>\n<td align=\"left\">SERVER ERROR</td>\n<td align=\"left\">No</td>\n<td align=\"left\">An internal server error prevented return of the representation response</td>\n</tr>\n<tr>\n<td align=\"center\">503</td>\n<td align=\"left\">SERVICE UNAVAILABLE</td>\n<td align=\"left\">No</td>\n<td align=\"left\">The server is temporarily unable to return the representation. Please wait and try again later</td>\n</tr>\n</tbody>\n</table>\n<h4>Create (POST or PUT) Operation Statuses</h4>\n<table class=\"grid\">\n<thead>\n<tr>\n<th align=\"center\"><strong>Code</strong></th>\n<th align=\"left\"><strong>Meaning</strong></th>\n<th align=\"left\"><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"center\">200</td>\n<td align=\"left\">OK</td>\n<td align=\"left\">The request was successful, and the resource was updated. The response body contains the updated representation</td>\n</tr>\n<tr>\n<td align=\"center\">201</td>\n<td align=\"left\">CREATED</td>\n<td align=\"left\">The request was successful, a new resource was created, and the response body contains the representation</td>\n</tr>\n<tr>\n<td align=\"center\">204</td>\n<td align=\"left\">OK - NO CONTENT</td>\n<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>\n</tr>\n<tr>\n<td align=\"center\">207</td>\n<td align=\"left\">MULTI STATUS</td>\n<td align=\"left\">The HTTP 207 Multi-Status response code indicates that there might be a mixture of responses.</td>\n</tr>\n<tr>\n<td align=\"center\">400</td>\n<td align=\"left\">BAD REQUEST</td>\n<td align=\"left\">The data given in the POST or PUT failed validation. Inspect the response body for details</td>\n</tr>\n<tr>\n<td align=\"center\">401</td>\n<td align=\"left\">UNAUTHORIZED</td>\n<td align=\"left\">The supplied credentials, if any, are not sufficient to create or update the resource</td>\n</tr>\n<tr>\n<td align=\"center\">404</td>\n<td align=\"left\">NOT FOUND</td>\n<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>\n</tr>\n<tr>\n<td align=\"center\">405</td>\n<td align=\"left\">METHOD NOT ALLOWED</td>\n<td align=\"left\">You can't POST or PUT to the resource</td>\n</tr>\n<tr>\n<td align=\"center\">422</td>\n<td align=\"left\">UNPROCESSABLE CONTENT</td>\n<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>\n</tr>\n<tr>\n<td align=\"center\">429</td>\n<td align=\"left\">TOO MANY REQUESTS</td>\n<td align=\"left\">Your application is sending too many simultaneous requests</td>\n</tr>\n<tr>\n<td align=\"center\">500</td>\n<td align=\"left\">SERVER ERROR</td>\n<td align=\"left\">We couldn't create or update the resource. Please try again later</td>\n</tr>\n</tbody>\n</table>\n<h4>Delete (DELETE) Operation Statuses</h4>\n<table class=\"grid\">\n<thead>\n<tr>\n<th align=\"center\"><strong>Code</strong></th>\n<th align=\"left\"><strong>Meaning</strong></th>\n<th align=\"left\"><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"center\">204</td>\n<td align=\"left\">OK</td>\n<td align=\"left\">The request was successful; the resource was deleted</td>\n</tr>\n<tr>\n<td align=\"center\">401</td>\n<td align=\"left\">UNAUTHORIZED</td>\n<td align=\"left\">The supplied credentials, if any, are not sufficient to delete the resource</td>\n</tr>\n<tr>\n<td align=\"center\">404</td>\n<td align=\"left\">NOT FOUND</td>\n<td align=\"left\"/>\n</tr>\n<tr>\n<td align=\"center\">405</td>\n<td align=\"left\">METHOD NOT ALLOWED</td>\n<td align=\"left\">You can't DELETE the resource</td>\n</tr>\n<tr>\n<td align=\"center\">429</td>\n<td align=\"left\">TOO MANY REQUESTS</td>\n<td align=\"left\">Your application is sending too many simultaneous requests</td>\n</tr>\n<tr>\n<td align=\"center\">500</td>\n<td align=\"left\">SERVER ERROR</td>\n<td align=\"left\">We couldn't delete the resource. Please try again later</td>\n</tr>\n</tbody>\n</table>\n<h3>Non existent API endpoints</h3>\n<p>When a consumer attempts to call a non-existent API end point, respond\nwith a <strong>501 Not Implemented</strong> status code.</p>\n</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/>\u00a0\u00a0<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/>\u00a0\u00a0<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/>\u00a0\u00a0<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/>\u00a0\u00a0<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>\u00a0</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>\u00a0</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\n<a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></p>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n<ol>\n<li>RheumaticFeverCareTeam - simply requires use of particular Condition.category codes in rheumatic fever health applications</li>\n</ol>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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\nObtained date/time. If the obtained element is a period, a date that falls in the period</p>\n</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>\n</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\n<a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></p>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"extension" : [
{
"extension" : [
{
"url" : "licenseURL",
"valueUri" : "https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx"
},
{
"url" : "externalDocs",
"valueUri" : "https://fhir-ig.digital.health.nz/rf"
},
{
"url" : "licenseName",
"valueString" : "Health New Zealand Digital Services Hub API Access and Use Agreement"
},
{
"extension" : [
{
"extension" : [
{
"url" : "key",
"valueString" : "Correlation-Id"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Correlation-Id.json"
},
{
"url" : "required",
"valueBoolean" : false
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
},
{
"extension" : [
{
"url" : "key",
"valueString" : "x-api-key"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Api-Key.json"
},
{
"url" : "required",
"valueBoolean" : true
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
},
{
"extension" : [
{
"url" : "key",
"valueString" : "Request-Context"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/openapi-definitions/Request-Context.json"
},
{
"url" : "required",
"valueBoolean" : true
},
{
"url" : "documentation",
"valueString" : "A base64-encoded JSON object that defines the context of the current request.\nSee https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json for the schema this object must conform to."
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
}
],
"url" : "globalHeaders"
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"
}
],
"url" : "https://fhir-ig.digital.health.nz/rheumatic-fever/CapabilityStatement/RheumaticFeverCapabilityStatement",
"version" : "1.0.0",
"name" : "RheumaticFeverAPICapabilityStatement",
"title" : "Rheumatic Fever FHIR API Capability Statement",
"status" : "active",
"date" : "2024-06-14",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
},
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz"
}
]
},
{
"name" : "HNZ Integration Team",
"telecom" : [
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz",
"use" : "work"
}
]
}
],
"description" : "New Zealand rheumatic fever FHIR API capability statement",
"kind" : "instance",
"implementation" : {
"description" : "NZ Rheumatic Fever FHIR API",
"url" : "https://fhir.api.digital.health.nz/R4"
},
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"extension" : [
{
"extension" : [
{
"url" : "token",
"valueUri" : "https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"
}
],
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
},
{
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities",
"valueCode" : "client-confidential-symmetric"
}
],
"cors" : true,
"service" : [
{
"coding" : [
{
"code" : "SMART-on-FHIR"
}
]
}
]
},
"resource" : [
{
"type" : "Bundle",
"profile" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the sensitivity is for \n [Patient](http://hl7.org/fhir/R4/patient.html)"
},
{
"name" : "actor",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-actor",
"type" : "reference",
"documentation" : "Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location)"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-status",
"type" : "token",
"documentation" : "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Appointment date/time"
}
]
},
{
"type" : "CarePlan",
"profile" : "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careplan",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*",
"CarePlan:encounter"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the care plan is for"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"type" : "token",
"documentation" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-subject",
"type" : "reference",
"documentation" : "Who the care plan is for"
},
{
"name" : "_profile",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Resource-profile",
"type" : "reference",
"documentation" : "Filter **RheumaticFeverCarePlan instances** using the applicable profile canonical Url from IG"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "category",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#CarePlan-category",
"type" : "token",
"documentation" : "Care plan search by category code. All rheumatic fever care plans are categorised #rf-nz"
}
]
},
{
"type" : "CareTeam",
"supportedProfile" : [
🔗 "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careteam"
],
"documentation" : "\nThis server supports one subtype of FHIR CareTeam - refer to Profiles\n1. RheumaticFeverCareTeam - simply requires use of particular Condition.category codes in rheumatic fever health applications\n",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "identifier",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier",
"type" : "token",
"documentation" : "The patient's official NHI identifier"
},
{
"name" : "_profile",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Resource-profile",
"type" : "reference",
"documentation" : "Filter **RheumaticFeverCareTeam instances** using the applicable profile canonical Url from IG"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "category",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#CareTeam-category",
"type" : "token",
"documentation" : "Care team search by category code. All rheumatic fever care teams are categorised #rf-nz"
}
]
},
{
"type" : "Condition",
"profile" : "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-condition",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who has the condition?"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-subject",
"type" : "reference",
"documentation" : "Who has the condition?"
},
{
"name" : "_profile",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Resource-profile",
"type" : "reference",
"documentation" : "Filter **RheumaticFeverCondition instances** using the applicable profile canonical Url from IG"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "category",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Condition-category",
"type" : "token",
"documentation" : "Condition search by category code. All rheumatic fever condtion instances have two category values (#rf-nz, SNOMED #58718002)"
}
]
},
{
"type" : "Consent",
"profile" : "http://hl7.org/fhir/StructureDefinition/Consent",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*",
"Consent:source-reference"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the consent applies to"
},
{
"name" : "data",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-data",
"type" : "reference",
"documentation" : "The actual data reference"
},
{
"name" : "source-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-source-reference",
"type" : "reference",
"documentation" : "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-status",
"type" : "token",
"documentation" : "draft | proposed | active | rejected | inactive | entered-in-error"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
}
]
},
{
"type" : "Encounter",
"profile" : "http://hl7.org/fhir/StructureDefinition/Encounter",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*",
"Encounter:diagnosis"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient or group present at the encounter"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-status",
"type" : "token",
"documentation" : "planned | arrived | triaged | in-progress | onleave | finished | cancelled +"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"type" : "reference",
"documentation" : "The patient or group present at the encounter"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
}
]
},
{
"type" : "MedicationRequest",
"profile" : "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-medicationrequest",
"supportedProfile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest"
],
"documentation" : "\nThis server profiles NzMedicationRequest AND supports the NZ Base IG profile NzMedicationRequest.\n",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The rheumatic fever patient for whom this medication is prescribed"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-status",
"type" : "token",
"documentation" : "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown +"
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Return all MedicationRequests that relate to this type of medication"
}
]
},
{
"type" : "MedicationStatement",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"supportedProfile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/NzMedicationStatement"
],
"documentation" : "\nThis server supports the NZ Base IG profiles NzMedicationStatement in addition to the base MedicationStatement FHIR resource.\n",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The rheumatic fever patient to whom medication was administered"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-status",
"type" : "token",
"documentation" : "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken +"
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Return all instances of administration of this medication"
}
]
},
{
"type" : "Observation",
"profile" : "http://hl7.org/fhir/StructureDefinition/Observation",
"supportedProfile" : [
🔗 "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-diagnosisgroup"
],
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*",
"Observation:patient",
"Observation:encounter",
"Observation:based-on",
"Observation:derived-from",
"Observation:device",
"Observation:focus",
"Observation:has-member",
"Observation:part-of",
"Observation:performer",
"Observation:specimen",
"Observation:subject"
],
"searchParam" : [
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Describes what was observed. Sometimes this is called the observation 'name'"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Observation.effective \n Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "A unique identifier assigned to this observation."
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the observation is for \n [Patient](http://hl7.org/fhir/R4/patient.html)"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-based-on",
"type" : "reference",
"documentation" : "Reference to the service request."
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "The Encounter resource associated with the Observation."
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "The classification of the type of observation"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-derived-from",
"type" : "reference",
"documentation" : "Related measurements the observation is made from"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-performer",
"type" : "reference",
"documentation" : "Who performed the observation"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "The status of the observation"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-subject",
"type" : "reference",
"documentation" : "The subject that the observation is about"
},
{
"name" : "value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-concept",
"type" : "token",
"documentation" : "The value of the observation, if the value is a CodeableConcept"
},
{
"name" : "value-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-date",
"type" : "date",
"documentation" : "The value of the observation, if the value is a date or period of time"
},
{
"name" : "value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"type" : "quantity",
"documentation" : "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)"
},
{
"name" : "value-string",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-string",
"type" : "string",
"documentation" : "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
}
]
},
{
"type" : "Patient",
"profile" : "https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-patient",
"documentation" : "\nThis server supports one profile of FHIR Patient which is the rheumatic fever patient profile\n",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "identifier",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier",
"type" : "token",
"documentation" : "The patient's official NHI identifier"
},
{
"name" : "_profile",
"definition" : "https://hl7.org/fhir/searchparameter-registry.html#Resource-profile",
"type" : "reference",
"documentation" : "Filter **RheumaticFeverPatient instances** using the applicable profile canonical Url from IG"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
}
]
},
{
"type" : "Questionnaire",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type" : "token",
"documentation" : "External identifier for the questionnaire"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-name",
"type" : "string",
"documentation" : "Computationally friendly name of the questionnaire"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type" : "token",
"documentation" : "The current status of the questionnaire"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type" : "string",
"documentation" : "The human-friendly name of the questionnaire"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type" : "uri",
"documentation" : "The uri that identifies the questionnaire"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
}
]
},
{
"type" : "QuestionnaireResponse",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*",
"QuestionnaireResponse:based-on",
"QuestionnaireResponse:encounter"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient",
"type" : "reference",
"documentation" : "The patient that is the subject of the questionnaire response"
},
{
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"type" : "reference",
"documentation" : "The questionnaire the answers are provided for"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"type" : "token",
"documentation" : "The status of the questionnaire response"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject",
"type" : "reference",
"documentation" : "The subject of the questionnaire response"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
}
]
}
],
"interaction" : [
{
"code" : "transaction",
"documentation" : "### Request-Context custom header\n\nAll HNZ FHIR API requests must include the health user and context of usage of the application making the API request.\n\nThis context is supplied using the 'Request-Context' custom header in the form of a base64-encoded JSON object.\n\nConsumers of the Rheumatic Fever FHIR API must set the following properties in `Request-Context`\n\n|**Required context property**|**Attribute value**|\n|:------------------|:---------|\n| `userIdentifier` | The userid of the user as authenticated by RFCCS or the PMS/health application. |\n| `purposeOfUse` | Set to `\"POPHEALTH\"` |\n| `userFullName` | Display name of the user of RFCCS or the PMS/health application. |\n| `hpiOrganisation` | The HPI Organisation identifier for the RF Secondary Prevention Service (aka Lead Provider) the user is affiliated with |\n| `hpiPractitioner` | If available, the HPI Practitioner identifier (Common Person Number) of the user |\n| `hpiFacility` | If available, the HPI Facility identifier of the health facility where the application is being used |\n\nThe schema for defining and validating these properties can be [found here](https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json)\n\n\n### Error status codes\n\n#### Read (GET) Operation Statuses\n\n|**Code**|**Meaning**|**Description**|\n|:--:|:-----------------|:--|\n|200|OK |The request was successful, and the response body contains the representation requested|\n|302|FOUND |A common redirect response; you can GET the representation at the URI in the Location response header|\n|304|NOT MODIFIED |Your client's cached version of the representation is still up to date|\n|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to access the resource|\n|404|NOT FOUND |The requested representation was not found. Retrying this request is unlikely to be successful|\n|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|\n|500|SERVER ERROR |An internal server error prevented return of the representation response|\n|503|SERVICE UNAVAILABLE|We are temporarily unable to return the representation. Please wait and try again later|\n\n#### Search (GET) Operation Statuses\n\n|**Code**|**Meaning** |**OperationOutcome** in response?|**Description**|\n|:--:|:-----------------|:----------------------------------|:----------------------------------|\n|200|OK |Yes, when there are additional messages about a match result|The request was successful, and the response body contains the representation requested|\n|302|FOUND |No |A common redirect response; you can GET the representation at the URI in the Location response header|\n|400|BAD REQUEST |Yes|Incorrect search parameters or malformed request - see diagnostics in OperationOutcome|\n|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to access the resource|\n|429|TOO MANY REQUESTS |No |Your application is sending too many simultaneous requests|\n|500|SERVER ERROR |No |An internal server error prevented return of the representation response|\n|503|SERVICE UNAVAILABLE|No |The server is temporarily unable to return the representation. Please wait and try again later|\n\n#### Create (POST or PUT) Operation Statuses\n\n|**Code**|**Meaning**|**Description**|\n|:--:|:-----------------|:--|\n|200|OK |The request was successful, and the resource was updated. The response body contains the updated representation|\n|201|CREATED |The request was successful, a new resource was created, and the response body contains the representation|\n|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|\n|207|MULTI STATUS |The HTTP 207 Multi-Status response code indicates that there might be a mixture of responses.|\n|400|BAD REQUEST |The data given in the POST or PUT failed validation. Inspect the response body for details|\n|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to create or update the resource|\n|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|\n|405|METHOD NOT ALLOWED |You can't POST or PUT to the resource|\n|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|\n|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|\n|500|SERVER ERROR |We couldn't create or update the resource. Please try again later|\n\n#### Delete (DELETE) Operation Statuses\n\n|**Code**|**Meaning**|**Description**|\n|:--:|:-----------------|:--|\n|204|OK |The request was successful; the resource was deleted|\n|401|UNAUTHORIZED |The supplied credentials, if any, are not sufficient to delete the resource|\n|404|NOT FOUND | |\n|405|METHOD NOT ALLOWED |You can't DELETE the resource|\n|429|TOO MANY REQUESTS |Your application is sending too many simultaneous requests|\n|500|SERVER ERROR |We couldn't delete the resource. Please try again later|\n\n\n### Non existent API endpoints\n\nWhen a consumer attempts to call a non-existent API end point, respond\nwith a **501 Not Implemented** status code."
}
]
}
]
}