New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
| Draft as of 2020-04-01 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="HpiCapabilityStatement"/>
<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 HpiCapabilityStatement</b></p><a name="HpiCapabilityStatement"> </a><a name="hcHpiCapabilityStatement"> </a><a name="HpiCapabilityStatement-en-US"> </a><h2 id="title">Capability Statement describing HPI FHIR APIs</h2><ul><li>Implementation Guide Version: 1.5.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-04-01 </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></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="#Practitioner1-1">Practitioner</a></td><td><a href="StructureDefinition-HPIPractitioner.html">http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner</a><br/><em>Additional supported profiles:</em><br/> <a href="StructureDefinition-HPIPractitioner.html">HPI Practitioner</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center">y</td><td>identifier, name, gender, birthdate</td><td/><td/><td><code>$update-core</code></td></tr><tr><td><a href="#PractitionerRole1-2">PractitionerRole</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-HPIPractitionerRole.html">HPI Practitioner role</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>practitioner, organization, location, role, active</td><td><code>practitioner</code>, <code>organization</code>, <code>location</code></td><td/><td/></tr><tr><td><a href="#Organization1-3">Organization</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-HpiOrganization.html">HPI Organization</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>active, name, identifier, type, partOf</td><td/><td/><td/></tr><tr><td><a href="#Location1-4">Location</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-HpiLocation.html">HPI Location</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>identifier, name, type, address, organization, dhb, status, messaging-address</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Practitioner</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-HPIPractitioner.html">HPI Practitioner</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-HPIPractitioner.html">HPI Practitioner</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <br/><code>read</code><div><p>GET, [base]/Practitioner[cpn], Retrieves a Practitioner resource by Id, system/Practitioner.r</p>
</div><code>search-type</code><div><p>GET,[base]/Practitioner, Queries against the Practitioner using name and other search parameters. Will return a Bundle (even if there are no matching resources),system/Practitioner.s</p>
</div><code>create</code><div><p>POST',[base]/Practitioner, Creates a new Practitioner record , system/Practitioner.c</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Practitioner query</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>identifier</td><td><code>token</code></td><td><div><p>For searching a Practitioner resource using their council/board registration number</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Should contain the person’s full name, include all given names and family name.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>Use with name and birthdate. Search by gender alone is not allowed.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>Use with name and gender. Search by birthdate alone is not allowed.</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div><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><a href="OperationDefinition-Practitioner-update-core.html">$update-core</a></td><td><div><p>POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details, system/Practitioner.u</p>
</div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="PractitionerRole1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>PractitionerRole</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/practitionerrole.html">PractitionerRole</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 <br/><code>read</code><div><p>GET, [base]/PractitionerRole[id], Used to retrieve a PractitionerRole resource by Id, system/PractitionerRole.r</p>
</div><code>search-type</code><div><p>GET, [base]/PractitionerRole, Queries against PractitionerRole using hpi-person-id and other parameters. Will return a Bundle (even if there are no matching resources), system/PractitionerRole.s</p>
</div><code>create</code><div><p>POST, [base]/PractitionerRole, Create a new PractitionerRole, system/PractitionerRole.c</p>
</div><code>update</code><div><p>PUT, [base]/PractitionerRole[id], Update contact details and end date on an existing PractitionerRole record, system/PractitionerRole.u</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-HPIPractitionerRole.html">HPI Practitioner role</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>PractitionerRole query</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>practitioner</td><td><code>reference</code></td><td><div><p>Given an hpi-person-id, returns the PractitionerRole records associated with that id</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>organization</td><td><code>reference</code></td><td><div><p>Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>token</code></td><td><div><p>Given an hpi-facility-id, returns the PractitionerRole records associated with that id</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>role</td><td><code>token</code></td><td><div><p>Returns PractitionerRole records based on role code</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>To enable exclusion of inactive PractitionerRole records</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="Organization1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Organization</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/organization.html">Organization</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 <br/><code>read</code><div><p>GET, [base]/Organization/[hpi-org-id], Used to retrieve an Organization resource by Id, system/Organization.r</p>
</div><code>search-type</code><div><p>GET, [base]/Organization, Queries against the Organization using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Organization.s</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-HpiOrganization.html">HPI Organization</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Organization query</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>active</td><td><code>token</code></td><td><div><p>To enable exclusion of inactive organizations</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>For searching using the organisation’s name or an alias name</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>For searching using an organisation's type E.g. DHB, RA, Educational institution</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>partOf</td><td><code>reference</code></td><td><div><p>For retrieving organizations that are 'part of' another.</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="Location1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Location</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/location.html">Location</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 <br/><code>read</code><div><p>GET, [base]/Location/[hpi-facid], Used to retrieve an Location resource by Id, system/Location.r</p>
</div><code>search-type</code><div><p>GET, [base]/Location, Queries against the Location using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Location.s</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-HpiLocation.html">HPI Location</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Location query</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>identifier</td><td><code>token</code></td><td><div><p>For searching using an organization’s legacy NZHIS facility code.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>For searching using the Locations name or alias name</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Retrieve Locations of the given type</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>address</td><td><code>string</code></td><td><div><p>Retrieve the Locations by address</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>organization</td><td><code>reference</code></td><td><div><p>Retrieve Locations with the given ManagingOrganization</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>dhb</td><td><code>token</code></td><td><div><p>Searching for Locations that are in a DHBs catchment area.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>Not yet enabled. To enable exclusion of inactive locations</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>messaging-address</td><td><code>string</code></td><td><div><p>Search by EDI address</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.digital.health.nz/hpi"/>
</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="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/openapi-definitions/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="https://fhir-ig.digital.health.nz/CapabilityStatement/HpiCapabilityStatement"/>
<version value="1.5.0"/>
<name value="HPI_CapabilityStatement"/>
<title value="Capability Statement describing HPI FHIR APIs"/>
<status value="draft"/>
<date value="2020-04-01"/>
<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="This is the computable resource that describes the RESTful endpoint"/>
<kind value="instance"/>
<implementation>
<description value="The HPI endpoint"/>
<url value="https://api.hip.digital.health.nz/fhir/hpi/v1/"/>
</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.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"/>
</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>
</security>
<resource>
<type value="Practitioner"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"/>
<documentation value="Practitioner query
"/>
<interaction>
<code value="read"/>
<documentation
value="GET, [base]/Practitioner[cpn], Retrieves a Practitioner resource by Id, system/Practitioner.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET,[base]/Practitioner, Queries against the Practitioner using name and other search parameters. Will return a Bundle (even if there are no matching resources),system/Practitioner.s "/>
</interaction>
<interaction>
<code value="create"/>
<documentation
value="POST',[base]/Practitioner, Creates a new Practitioner record , system/Practitioner.c"/>
</interaction>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching a Practitioner resource using their council/board registration number"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="Should contain the person’s full name, include all given names and family name."/>
</searchParam>
<searchParam>
<name value="gender"/>
<type value="token"/>
<documentation
value="Use with name and birthdate. Search by gender alone is not allowed."/>
</searchParam>
<searchParam>
<name value="birthdate"/>
<type value="date"/>
<documentation
value="Use with name and gender. Search by birthdate alone is not allowed."/>
</searchParam>
<operation>
<name value="update-core"/>
<definition
value="https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core"/>
<documentation
value="POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details, system/Practitioner.u"/>
</operation>
</resource>
<resource>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole"/>
<documentation value="PractitionerRole query
"/>
<interaction>
<code value="read"/>
<documentation
value="GET, [base]/PractitionerRole[id], Used to retrieve a PractitionerRole resource by Id, system/PractitionerRole.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET, [base]/PractitionerRole, Queries against PractitionerRole using hpi-person-id and other parameters. Will return a Bundle (even if there are no matching resources), system/PractitionerRole.s"/>
</interaction>
<interaction>
<code value="create"/>
<documentation
value="POST, [base]/PractitionerRole, Create a new PractitionerRole, system/PractitionerRole.c"/>
</interaction>
<interaction>
<code value="update"/>
<documentation
value="PUT, [base]/PractitionerRole[id], Update contact details and end date on an existing PractitionerRole record, system/PractitionerRole.u"/>
</interaction>
<searchInclude value="practitioner"/>
<searchInclude value="organization"/>
<searchInclude value="location"/>
<searchParam>
<name value="practitioner"/>
<type value="reference"/>
<documentation
value="Given an hpi-person-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="organization"/>
<type value="reference"/>
<documentation
value="Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="location"/>
<type value="token"/>
<documentation
value="Given an hpi-facility-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="role"/>
<type value="token"/>
<documentation
value="Returns PractitionerRole records based on role code"/>
</searchParam>
<searchParam>
<name value="active"/>
<type value="token"/>
<documentation
value="To enable exclusion of inactive PractitionerRole records"/>
</searchParam>
</resource>
<resource>
<type value="Organization"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization"/>
<documentation value="Organization query
"/>
<interaction>
<code value="read"/>
<documentation
value="GET, [base]/Organization/[hpi-org-id], Used to retrieve an Organization resource by Id, system/Organization.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET, [base]/Organization, Queries against the Organization using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Organization.s"/>
</interaction>
<searchParam>
<name value="active"/>
<type value="token"/>
<documentation value="To enable exclusion of inactive organizations"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="For searching using the organisation’s name or an alias name"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code."/>
</searchParam>
<searchParam>
<name value="type"/>
<type value="token"/>
<documentation
value="For searching using an organisation's type E.g. DHB, RA, Educational institution"/>
</searchParam>
<searchParam>
<name value="partOf"/>
<type value="reference"/>
<documentation
value="For retrieving organizations that are 'part of' another."/>
</searchParam>
</resource>
<resource>
<type value="Location"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/HPILocation"/>
<documentation value="Location query"/>
<interaction>
<code value="read"/>
<documentation
value="GET, [base]/Location/[hpi-facid], Used to retrieve an Location resource by Id, system/Location.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="GET, [base]/Location, Queries against the Location using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Location.s"/>
</interaction>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching using an organization’s legacy NZHIS facility code."/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="For searching using the Locations name or alias name"/>
</searchParam>
<searchParam>
<name value="type"/>
<type value="token"/>
<documentation value="Retrieve Locations of the given type"/>
</searchParam>
<searchParam>
<name value="address"/>
<type value="string"/>
<documentation value="Retrieve the Locations by address"/>
</searchParam>
<searchParam>
<name value="organization"/>
<type value="reference"/>
<documentation
value="Retrieve Locations with the given ManagingOrganization"/>
</searchParam>
<searchParam>
<name value="dhb"/>
<type value="token"/>
<documentation
value="Searching for Locations that are in a DHBs catchment area."/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="Not yet enabled. To enable exclusion of inactive locations"/>
</searchParam>
<searchParam>
<name value="messaging-address"/>
<type value="string"/>
<documentation value="Search by EDI address"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>