Breast Screening NZ FHIR Implementation Guide
1.1.0 - Release
Breast Screening NZ FHIR Implementation Guide
1.1.0 - Release
Breast Screening NZ FHIR Implementation Guide - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2023-05-24 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="BSACapabilityStatement"/>
<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 BSACapabilityStatement</b></p><a name="BSACapabilityStatement"> </a><a name="hcBSACapabilityStatement"> </a><div style="display: inline-block; background-color: #d9e0e7; 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">BSA FHIR API Capability Statement</h2><ul><li>Implementation Guide Version: 1.1.0 </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: 2023-05-24 </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><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="#DiagnosticReport1-1">DiagnosticReport</a></td><td><a href="StructureDefinition-BsaDiagnosticReport.html">https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaDiagnosticReport</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>patient, status, date, category</td><td/><td/><td/></tr><tr><td><a href="#CarePlan1-2">CarePlan</a></td><td><a href="StructureDefinition-BsaCarePlan.html">https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaCarePlan</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>patient, _lastUpdated</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="DiagnosticReport1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>DiagnosticReport</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-BsaDiagnosticReport.html">BSA Diagnostic Report</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]/DiagnosticReport/[id],Used to retrieve a participant's BSA screening outcomes and radiologist assessment reports, system/DiagnosticReport.r</p>
</div><code>search-type</code><div><p>GET,[base]/DiagnosticReport, Search for a patient's participant's BSA screening outcomes and radiologist assessment reports,system/DiagnosticReport.s</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Describes a participant's BSA screening outcomes and radiologist assessment reports</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>NHI id of patient who is the subject of the report</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>report status</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>token</code></td><td><div><p>The clinically relevant time of the report</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Which diagnostic discipline/department created the report</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="CarePlan1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </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-BsaCarePlan.html">BSA Care Plan</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]/CarePlan/[id],Used to retrieve a participant's BSA screening enrolment and pathway status, system/CarePlan.r</p>
</div><code>search-type</code><div><p>GET,[base]/CarePlan, Search for a participant's BSA screening enrolment and pathway status,system/CarePlan.s</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Describes a participant's BSA screening enrolment and pathway status</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>NHI id of patient who is the subject of the CarePlan</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>token</code></td><td><div><p>The date the care plan was last updated</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension">
<extension url="licenseURL">
<valueUri
value="https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx"/>
</extension>
<extension url="externalDocs">
<valueUri value="https://fhir-ig-uat.digital.health.nz/bsa"/>
</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>
</extension>
</extension>
<url
value="https://fhir-ig.digital.health.nz/bsa/CapabilityStatement/BSACapabilityStatement"/>
<version value="1.1.0"/>
<name value="BSACapabilityStatement"/>
<title value="BSA FHIR API Capability Statement"/>
<status value="draft"/>
<date value="2023-05-24"/>
<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="BSA FHIR Capabilities"/>
<kind value="instance"/>
<implementation>
<description
value="Health NZ | Te Whatu Ora NZ Breats Screening Aotearoa API"/>
<url value="https://fhir-ig-uat.digital.health.nz/bsa"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<patchFormat value="json"/>
<rest>
<mode value="server"/>
<resource>
<type value="DiagnosticReport"/>
<profile
value="https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaDiagnosticReport"/>
<documentation
value="Describes a participant's BSA screening outcomes and radiologist assessment reports"/>
<interaction>
<code value="read"/>
<documentation
value="GET,[base]/DiagnosticReport/[id],Used to retrieve a participant's BSA screening outcomes and radiologist assessment reports, system/DiagnosticReport.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET,[base]/DiagnosticReport, Search for a patient's participant's BSA screening outcomes and radiologist assessment reports,system/DiagnosticReport.s"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation
value="NHI id of patient who is the subject of the report"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation value="report status"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="token"/>
<documentation value="The clinically relevant time of the report"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation
value="Which diagnostic discipline/department created the report"/>
</searchParam>
</resource>
<resource>
<type value="CarePlan"/>
<profile
value="https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaCarePlan"/>
<documentation
value="Describes a participant's BSA screening enrolment and pathway status"/>
<interaction>
<code value="read"/>
<documentation
value="GET,[base]/CarePlan/[id],Used to retrieve a participant's BSA screening enrolment and pathway status, system/CarePlan.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET,[base]/CarePlan, Search for a participant's BSA screening enrolment and pathway status,system/CarePlan.s"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation
value="NHI id of patient who is the subject of the CarePlan"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<type value="token"/>
<documentation value="The date the care plan was last updated"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>