ACT-NOW Capability Statement - XML Representation - ACT-NOW Implementation Guide v0.6.0

ACT-NOW Implementation Guide - Local Development build (v0.6.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
: ACT-NOW Capability Statement - XML Representation

Draft as of 2022-10-03
Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="AnCapabilityStatement"/>
  <meta>
    <profile
             value="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement AnCapabilityStatement</b></p><a name="AnCapabilityStatement"> </a><a name="hcAnCapabilityStatement"> </a><div style="display: inline-block; background-color: #fbffeb; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="file:///home/runner/work/fhir-ig-builder/fhir-ig-builder/hnz-digital-tooling/output/StructureDefinition-hnz-capability-statement.html">Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter</a></p></div><h2 id="title">ACT-NOW Capability Statement</h2><ul><li>Implementation Guide Version: 0.6.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2022-10-03 </li><li>Published by: Te aho o te kahu - Cancer Control Agency </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><blockquote><div><p>OAuth 2.0 - Client Credential flow.</p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>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="#Patient1-1">Patient</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-an-patient.html">ACT-NOW patient</a></td><td class="text-center"/><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier, name, gender</td><td/><td/><td/></tr><tr><td><a href="#CarePlan1-2">CarePlan</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-an-careplan-regimen.html">Regimen Careplan</a><br/>  <a href="StructureDefinition-an-careplan-cycle.html">Cycle Careplan</a></td><td class="text-center"/><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href="#Observation1-3">Observation</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-an-cT.html">Clinical T-score</a><br/>  <a href="StructureDefinition-an-cN.html">Clinical N-score</a><br/>  <a href="StructureDefinition-an-cM.html">Clinical M-score</a><br/>  <a href="StructureDefinition-an-cGroup.html">Clinical TNM group score</a><br/>  <a href="StructureDefinition-an-pT.html">Pathological T-score</a><br/>  <a href="StructureDefinition-an-pN.html">Pathological N-score</a><br/>  <a href="StructureDefinition-an-pM.html">Pathological M-score</a><br/>  <a href="StructureDefinition-an-pGroup.html">Pathological TNM group score</a><br/>  <a href="StructureDefinition-an-bsa.html">Body Surface Area</a><br/>  <a href="StructureDefinition-an-creat-clear.html">Creatinine Clearance</a><br/>  <a href="StructureDefinition-an-height.html">Height</a><br/>  <a href="StructureDefinition-an-weight.html">Weight</a><br/>  <a href="StructureDefinition-an-histology.html">Histology</a><br/>  <a href="StructureDefinition-an-ecog.html">ECOG score</a></td><td class="text-center"/><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href="#MedicationAdministration1-4">MedicationAdministration</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-an-medication-administration.html">ACT-NOW medication administration</a></td><td class="text-center"/><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href="#MedicationRequest1-5">MedicationRequest</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-an-medication-request.html">ACT-NOW medication request</a></td><td class="text-center"/><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href="#QuestionnaireResponse1-6">QuestionnaireResponse</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center">y</td><td/><td/><td/><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: unspecified </span>Patient</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/patient.html">Patient</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>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-an-patient.html">ACT-NOW patient</a></p></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>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="CarePlan1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>CarePlan</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/careplan.html">CarePlan</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>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-an-careplan-regimen.html">Regimen Careplan</a><br/><a href="StructureDefinition-an-careplan-cycle.html">Cycle Careplan</a></p></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>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-3" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Observation</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/observation.html">Observation</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>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-an-cT.html">Clinical T-score</a><br/><a href="StructureDefinition-an-cN.html">Clinical N-score</a><br/><a href="StructureDefinition-an-cM.html">Clinical M-score</a><br/><a href="StructureDefinition-an-cGroup.html">Clinical TNM group score</a><br/><a href="StructureDefinition-an-pT.html">Pathological T-score</a><br/><a href="StructureDefinition-an-pN.html">Pathological N-score</a><br/><a href="StructureDefinition-an-pM.html">Pathological M-score</a><br/><a href="StructureDefinition-an-pGroup.html">Pathological TNM group score</a><br/><a href="StructureDefinition-an-bsa.html">Body Surface Area</a><br/><a href="StructureDefinition-an-creat-clear.html">Creatinine Clearance</a><br/><a href="StructureDefinition-an-height.html">Height</a><br/><a href="StructureDefinition-an-weight.html">Weight</a><br/><a href="StructureDefinition-an-histology.html">Histology</a><br/><a href="StructureDefinition-an-ecog.html">ECOG score</a></p></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>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationAdministration1-4" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>MedicationAdministration</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/medicationadministration.html">MedicationAdministration</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>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-an-medication-administration.html">ACT-NOW medication administration</a></p></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>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationRequest1-5" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>MedicationRequest</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/medicationrequest.html">MedicationRequest</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>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-an-medication-request.html">ACT-NOW medication request</a></p></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>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="QuestionnaireResponse1-6" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </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>read</code>, <code>create</code>, <code>search-type</code>.</li></ul></div></div><p/><p/></div></div></div></div>
  </text>
  <extension
             url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension">
    <extension url="licenseURL">
      <valueUri
                value="https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx"/>
    </extension>
    <extension url="externalDocs">
      <valueUri value="https://fhir-ig.digital.health.nz/actnow"/>
    </extension>
    <extension url="licenseName">
      <valueString
                   value="Health New Zealand Digital Services Hub API Access and Use Agreement"/>
    </extension>
    <extension url="globalHeaders">
      <extension
                 url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension">
        <extension url="key">
          <valueString value="X-Correlation-Id"/>
        </extension>
        <extension url="value">
          <valueUri
                    value="https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Correlation-Id.json"/>
        </extension>
        <extension url="required">
          <valueBoolean value="false"/>
        </extension>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension">
        <extension url="key">
          <valueString value="Request-Context"/>
        </extension>
        <extension url="value">
          <valueUri
                    value="https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Request-Context.json"/>
        </extension>
        <extension url="required">
          <valueBoolean value="true"/>
        </extension>
        <extension url="documentation">
          <valueString
                       value="A base64-encoded JSON object that defines the context of the current request.
See https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json for the schema this object must conform to."/>
        </extension>
      </extension>
    </extension>
  </extension>
  <url
       value="http://canshare.co.nz/fhir/CapabilityStatement/AnCapabilityStatement"/>
  <version value="0.6.0"/>
  <name value="CanShareCapabilityStatement"/>
  <title value="ACT-NOW Capability Statement"/>
  <status value="draft"/>
  <date value="2022-10-03"/>
  <publisher value="Te aho o te kahu - Cancer Control Agency"/>
  <contact>
    <name value="Te aho o te kahu - Cancer Control Agency"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:david.hay25@gmail.com"/>
    </telecom>
  </contact>
  <description value="ACT-NOW capability statement"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="NZ"/>
      <display value="New Zealand"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <implementation>
    <description value="Health NZ | Te Whatu Ora ACT NOW API"/>
    <url value="https://fhir.api.digital.health.nz/R4"/>
  </implementation>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <security>
      <extension
                 url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris">
        <extension url="token">
          <valueUri
                    value="https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"/>
        </extension>
        <extension url="authorize">
          <valueUri
                    value="https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/authorize"/>
        </extension>
      </extension>
      <extension
                 url="http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities">
        <valueCode value="client-confidential-symmetric"/>
      </extension>
      <cors value="true"/>
      <service>
        <coding>
          <code value="SMART-on-FHIR"/>
        </coding>
      </service>
      <description value="OAuth 2.0 - Client Credential flow."/>
    </security>
    <resource>
      <type value="Patient"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-patient"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="gender"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="CarePlan"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-careplan-cycle"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Observation"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-cT"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-cN"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-cM"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-cGroup"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-pT"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-pN"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-pM"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-pGroup"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-bsa"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-creat-clear"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-height"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-weight"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-histology"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-ecog"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="MedicationAdministration"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-medication-administration"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="MedicationRequest"/>
      <supportedProfile
                        value="http://canshare.co.nz/fhir/StructureDefinition/an-medication-request"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="QuestionnaireResponse"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalCreate value="true"/>
    </resource>
    <interaction>
      <code value="transaction"/>
    </interaction>
  </rest>
</CapabilityStatement>