Health New Zealand Example Implementation Guide
0.0.0 - release

Health New Zealand Example Implementation Guide - Local Development build (v0.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Health New Zealand FHIR Server Example Capability Statement - XML Representation

Active as of 2023-10-19

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="ExampleCapabilityStatement"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Health New Zealand FHIR Server Example Capability Statement</h2><ul><li>Implementation Guide Version: 0.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: 2023-10-19 </li><li>Published by: null </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 &quot;SHALL NOT&quot;. 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>OAuth</code></div></div><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li></ul></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><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="#MedicationRequest1-1">MedicationRequest</a></td><td><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest">http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest</a><br/><em>Additional supported profiles:</em><br/>  <a href="http://hl7.org/fhir/R4/medicationrequest.html">MedicationRequest</a></td><td></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td></td><td><code>*</code></td><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationRequest1-1" 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="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest">http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest</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="http://hl7.org/fhir/R4/medicationrequest.html">http://hl7.org/fhir/StructureDefinition/MedicationRequest</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <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 in addition to the base FHIR MedicationRequest resource.</p>
    <ol>
    <li>NzMedicationRequest - from the NZ Base Implementation Guide 2.0</li>
    </ol>
    </div></blockquote></div></div></div></div></div></div>
      </text>
      <url
           value="https://build.fhir.org/ig/tewhatuora/example.fhir.ig/CapabilityStatement/ExampleCapabilityStatement"/>
      <version value="0.0.0"/>
      <name value="ExampleCapabilityStatement"/>
      <title value="Health New Zealand FHIR Server Example Capability Statement"/>
      <status value="active"/>
      <date value="2023-10-19"/>
      <description value="Search for Prescribed Medication"/>
      <kind value="instance"/>
      <implementation>
        <description value="The Care In The Community Manaaki Nga Tahi FHIR API"/>
        <url value="https://api.mdr.mwnz.org"/>
      </implementation>
      <fhirVersion value="4.0.1"/>
      <format value="json"/>
      <rest>
        <mode value="server"/>
        <security>
          <extension
                     url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris">
            <extension url="token">
              <valueUri
                        value="https://auth.integration.covid19.health.nz/oauth2/token"/>
            </extension>
            <extension url="authorize">
              <valueUri
                        value="https://auth.integration.covid19.health.nz/oauth2/authorize"/>
            </extension>
          </extension>
          <cors value="true"/>
          <service>
            <coding>
              <system
                      value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
              <code value="OAuth"/>
            </coding>
          </service>
        </security>
        <resource>
          <type value="MedicationRequest"/>
          <profile
                   value="http://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/>
          <documentation
                         value="
    This server supports one profile in addition to the base FHIR MedicationRequest resource.
    1. NzMedicationRequest - from the NZ Base Implementation Guide 2.0
    "/>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <versioning value="versioned"/>
          <readHistory value="false"/>
          <updateCreate value="false"/>
          <conditionalCreate value="false"/>
          <conditionalRead value="not-supported"/>
          <conditionalUpdate value="false"/>
          <conditionalDelete value="not-supported"/>
          <searchInclude value="*"/>
        </resource>
        <interaction>
          <code value="transaction"/>
        </interaction>
      </rest>
    </CapabilityStatement>