New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : NhiCapabilityStatement - XML Representation

Draft as of 2020-04-21

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="NhiCapabilityStatement"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement NhiCapabilityStatement</b></p><a name="NhiCapabilityStatement"> </a><a name="hcNhiCapabilityStatement"> </a><h2 id="title"/><ul><li>Implementation Guide Version: 1.6.5 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: <code>json</code></li><li>Published on: 2020-04-21 </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><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>http://hl7.org.nz/fhir/StructureDefinition/NHI</li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"/></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><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="#Patient1-1">Patient</a></td><td><a href="StructureDefinition-NhiPatient.html">http://hl7.org.nz/fhir/StructureDefinition/NhiPatient</a></td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td><code>$match</code>, <code>$set-preferred-name</code>, <code>$set-address</code>, <code>$set-unvalidated-address</code>, <code>$remove-postal-address</code>, <code>$update-birth</code>, <code>$update-identity</code>, <code>$add-name</code>, <code>$replace-name</code>, <code>$inactivate-name</code>, <code>$update-eligibility</code>, <code>$create</code></td></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-1" 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-NhiPatient.html">NHI 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 <br/><code>read</code><div><p>GET,[base]/Patient/[nhi-id], Retrieve a Patient resource by Id , patient:Patient.r system/Patient.r</p>
    </div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$match</td><td><div><p>POST, [base]/Patient/$match, &lt;b&gt;Match&lt;/b&gt;: with In parameter &lt;code&gt;onlyCertainMatches=0&lt;/code&gt; (False) the operation will search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores.  &lt;br/&gt;&lt;b&gt;Validate:&lt;/b&gt; with In parameter &lt;code&gt;onlyCertainMatches=1&lt;/code&gt; (True) the operation will validate known patient demographic details against an NHI number. Returns a bundle of results with one patient resource that only includes the live nhi-id.,  system/Patient.s system/Patient.v</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-set-preferred-name.html">$set-preferred-name</a></td><td><div><p>POST, [base]/Patient/$set-preferred-name, Set the patient's preferred name,patient:Patient.u system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-set-address.html">$set-address</a></td><td><div><p>POST, [base]/Patient/$set-address,Update a patient's address, patient:Patient.u system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-set-unvalidated-address.html">$set-unvalidated-address</a></td><td><div><p>POST, [base]/Patient/$set-unvalidated-address, Allows a user to replace a physical address OR add or replace a postal address with an unvalidated address,system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-remove-postal-address.html">$remove-postal-address</a></td><td><div><p>POST, [base]/Patient/$remove-postal-address, Remove a patient's postal address,patient:Patient.u system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-update-birth.html">$update-birth</a></td><td><div><p>POST, [base]/Patient/$update-birth, Update a patient's birth information,  system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-update-identity.html">$update-identity</a></td><td><div><p>POST, [base]/Patient/$update-identity, An operation to update a patient's identity details.,  patient:Patient.u  system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-add-name.html">$add-name</a></td><td><div><p>POST, [base]/Patient/$add-name, Add a name to a patient's NHI record, system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-replace-name.html">$replace-name</a></td><td><div><p>POST, [base]/Patient/$replace-name, An operation to replace a name on a patient's record, system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-inactivate-name.html">$inactivate-name</a></td><td><div><p>POST, [base]/Patient/$inactivate-name, Inactivate a name that is currently active on a patients record ,system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-update-eligibility.html">$update-eligibility</a></td><td><div><p>POST, [base]/Patient/$update-eligibility, Update a patient's citizenship information, system/Patient.u</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-Patient-create.html">$create</a></td><td><div><p>POST, [base]/Patient/$create,Create a new patient record in the NHI, system/Patient.c</p>
    </div></td></tr></tbody></table></div></div></div></div></div></div>
      </text>
      <url
           value="http://hl7.org.nz/fhir/ig/nhi/CapabilityStatement/NhiCapabilityStatement"/>
      <version value="1.6.5"/>
      <status value="draft"/>
      <date value="2020-04-21"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="email"/>
          <value value="mailto:integration@health.govt.nz"/>
        </telecom>
      </contact>
      <description value="A FHIR API in front of the New Zealand NHI"/>
      <kind value="instance"/>
      <implementation>
        <description value="HPI system"/>
      </implementation>
      <fhirVersion value="4.0.1"/>
      <format value="json"/>
      <patchFormat value="json"/>
      <implementationGuide
                           value="http://hl7.org.nz/fhir/StructureDefinition/NHI"/>
      <rest>
        <mode value="server"/>
        <resource>
          <type value="Patient"/>
          <profile value="http://hl7.org.nz/fhir/StructureDefinition/NhiPatient"/>
          <interaction>
            <code value="read"/>
            <documentation
                           value="GET,[base]/Patient/[nhi-id], Retrieve a Patient resource by Id , patient:Patient.r system/Patient.r"/>
          </interaction>
          <operation>
            <name value="match"/>
            <definition
                        value="http://hl7.org/fhir/OperationDefinition/Patient-match"/>
            <documentation
                           value="POST, [base]/Patient/$match, &lt;b&gt;Match&lt;/b&gt;: with In parameter &lt;code&gt;onlyCertainMatches=0&lt;/code&gt; (False) the operation will search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores.  &lt;br/&gt;&lt;b&gt;Validate:&lt;/b&gt; with In parameter &lt;code&gt;onlyCertainMatches=1&lt;/code&gt; (True) the operation will validate known patient demographic details against an NHI number. Returns a bundle of results with one patient resource that only includes the live nhi-id.,  system/Patient.s system/Patient.v"/>
          </operation>
          <operation>
            <name value="set-preferred-name"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-preferred-name"/>
            <documentation
                           value="POST, [base]/Patient/$set-preferred-name, Set the patient's preferred name,patient:Patient.u system/Patient.u"/>
          </operation>
          <operation>
            <name value="set-address"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-address"/>
            <documentation
                           value="POST, [base]/Patient/$set-address,Update a patient's address, patient:Patient.u system/Patient.u"/>
          </operation>
          <operation>
            <name value="set-unvalidated-address"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address"/>
            <documentation
                           value="POST, [base]/Patient/$set-unvalidated-address, Allows a user to replace a physical address OR add or replace a postal address with an unvalidated address,system/Patient.u"/>
          </operation>
          <operation>
            <name value="remove-postal-address"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/remove-postal-address"/>
            <documentation
                           value="POST, [base]/Patient/$remove-postal-address, Remove a patient's postal address,patient:Patient.u system/Patient.u"/>
          </operation>
          <operation>
            <name value="update-birth"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-birth"/>
            <documentation
                           value="POST, [base]/Patient/$update-birth, Update a patient's birth information,  system/Patient.u"/>
          </operation>
          <operation>
            <name value="update-identity"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-identity"/>
            <documentation
                           value="POST, [base]/Patient/$update-identity, An operation to update a patient's identity details.,  patient:Patient.u  system/Patient.u "/>
          </operation>
          <operation>
            <name value="add-name"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-name"/>
            <documentation
                           value="POST, [base]/Patient/$add-name, Add a name to a patient's NHI record, system/Patient.u"/>
          </operation>
          <operation>
            <name value="replace-name"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name"/>
            <documentation
                           value="POST, [base]/Patient/$replace-name, An operation to replace a name on a patient's record, system/Patient.u"/>
          </operation>
          <operation>
            <name value="inactivate-name"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/inactivate-name"/>
            <documentation
                           value="POST, [base]/Patient/$inactivate-name, Inactivate a name that is currently active on a patients record ,system/Patient.u"/>
          </operation>
          <operation>
            <name value="update-eligibility"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-eligibility"/>
            <documentation
                           value="POST, [base]/Patient/$update-eligibility, Update a patient's citizenship information, system/Patient.u"/>
          </operation>
          <operation>
            <name value="create"/>
            <definition
                        value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/create-patient"/>
            <documentation
                           value="POST, [base]/Patient/$create,Create a new patient record in the NHI, system/Patient.c "/>
          </operation>
        </resource>
      </rest>
    </CapabilityStatement>