Medicines Data Repository Implementation Guide
0.1.0 - ci-build
Medicines Data Repository Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/mdr/ and changes regularly. See the Directory of published versions
| Draft as of 2022-09-01 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="ProviderCapabilityStatement"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement ProviderCapabilityStatement</b></p><a name="ProviderCapabilityStatement"> </a><a name="hcProviderCapabilityStatement"> </a><a name="ProviderCapabilityStatement-en-US"> </a><h2 id="title">Medicines Data Repository FHIR Server</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-09-01 20:26:40+0000 </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: no</div><div class="col-lg-6">Security services supported: <code>OAuth</code></div></div><blockquote><div><p>Supports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)</p>
</div></blockquote><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="#MedicationRequest1-1">MedicationRequest</a></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html">http://hl7.org/fhir/StructureDefinition/MedicationRequest</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td>_id, identifier, _lastUpdated, _security, code, status, authoredon, patient, requester, location</td><td/><td><code>Observation:based-on</code>, <code>MedicationDispense:prescription</code></td><td/></tr><tr><td><a href="#MedicationDispense1-2">MedicationDispense</a></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html">http://hl7.org/fhir/StructureDefinition/MedicationDispense</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td>_id, identifier, _lastUpdated, _security, code, patient, location, whenprepared, whenhandedover, status</td><td><code>MedicationDispense:prescription</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="http://hl7.org/fhir/R4/medicationrequest.html">MedicationRequest</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/><code>literal</code>, <code>local</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></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><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">identifier</a></td><td><code>token</code></td><td><div><p>Return prescriptions with this external identifier (SCID Item Identifier)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_security</a></td><td><code>token</code></td><td><div><p>Security Labels applied to this resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">code</a></td><td><code>token</code></td><td><div><p>Return prescriptions of this medication code (NZULM)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">status</a></td><td><code>token</code></td><td><div><p>Status of the prescription</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">authoredon</a></td><td><code>date</code></td><td><div><p>Return prescriptions written on this date</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">patient</a></td><td><code>reference</code></td><td><div><p>Returns prescriptions for a specific patient (NHI)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">requester</a></td><td><code>reference</code></td><td><div><p>Returns prescriptions prescribed by this prescriber (CPN)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>reference</code></td><td><div><p>Returns prescriptions prescribed at the facility (HPI Facility ID)</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="MedicationDispense1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>MedicationDispense</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="http://hl7.org/fhir/R4/medicationdispense.html">MedicationDispense</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/><code>literal</code>, <code>local</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></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><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">identifier</a></td><td><code>token</code></td><td><div><p>Returns dispenses with this external identifier (SCID Item Identifier)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_security</a></td><td><code>token</code></td><td><div><p>Security Labels applied to this resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">code</a></td><td><code>token</code></td><td><div><p>Returns dispenses of this medicine code (NZULM)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The identity of a patient to list dispenses for (NHI)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>reference</code></td><td><div><p>Returns dispenses performed at the principal physical location (HPI Facility ID)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">whenprepared</a></td><td><code>date</code></td><td><div><p>Returns dispenses prepared on this date</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">whenhandedover</a></td><td><code>date</code></td><td><div><p>Returns dispenses handed over on this date</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationdispense.html#search">status</a></td><td><code>token</code></td><td><div><p>Returns dispenses with a specified dispense status</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
</text>
<url value="https://apibroker.whanautahi.com/mdr/fhir/metadata"/>
<version value="0.1.0"/>
<name value="NZ_MDR"/>
<title value="Medicines Data Repository FHIR Server"/>
<status value="draft"/>
<experimental value="true"/>
<date value="2022-09-01T20:26:40.8906669Z"/>
<publisher value="Te Whatu Ora"/>
<contact>
<name value="Te Whatu Ora"/>
<telecom>
<system value="url"/>
<value value="https://tewhatuora.govt.nz"/>
</telecom>
<telecom>
<system value="email"/>
<value value="mailto:integration@health.govt.nz"/>
</telecom>
</contact>
<description value="MDR Capability Statement"/>
<kind value="capability"/>
<software>
<name value="Medicines Data Repository FHIR Proxy API"/>
<version value="1.0.0.0"/>
</software>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+json"/>
<rest>
<mode value="server"/>
<security>
<service>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
<code value="OAuth"/>
</coding>
</service>
<description
value="Supports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)"/>
</security>
<resource>
<type value="MedicationRequest"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/>
<interaction>
<code value="read"/>
</interaction>
<versioning value="no-version"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchRevInclude value="Observation:based-on"/>
<searchRevInclude value="MedicationDispense:prescription"/>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="Return prescriptions with this external identifier (SCID Item Identifier)"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed"/>
</searchParam>
<searchParam>
<name value="_security"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-security"/>
<type value="token"/>
<documentation value="Security Labels applied to this resource"/>
</searchParam>
<searchParam>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Return prescriptions of this medication code (NZULM)"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-status"/>
<type value="token"/>
<documentation value="Status of the prescription"/>
</searchParam>
<searchParam>
<name value="authoredon"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon"/>
<type value="date"/>
<documentation value="Return prescriptions written on this date"/>
</searchParam>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="Returns prescriptions for a specific patient (NHI)"/>
</searchParam>
<searchParam>
<name value="requester"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationRequest-requester"/>
<type value="reference"/>
<documentation
value="Returns prescriptions prescribed by this prescriber (CPN)"/>
</searchParam>
<searchParam>
<name value="location"/>
<definition
value="https://apibroker.whanautahi.com/mdr/fhir/SearchParameter/MedicationRequest-location"/>
<type value="reference"/>
<documentation
value="Returns prescriptions prescribed at the facility (HPI Facility ID)"/>
</searchParam>
</resource>
<resource>
<type value="MedicationDispense"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/MedicationDispense"/>
<interaction>
<code value="read"/>
</interaction>
<versioning value="no-version"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="MedicationDispense:prescription"/>
<searchParam>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation value="Logical id of this artifact"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="Returns dispenses with this external identifier (SCID Item Identifier)"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="When the resource version last changed"/>
</searchParam>
<searchParam>
<name value="_security"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-security"/>
<type value="token"/>
<documentation value="Security Labels applied to this resource"/>
</searchParam>
<searchParam>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation
value="Returns dispenses of this medicine code (NZULM)"/>
</searchParam>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The identity of a patient to list dispenses for (NHI)"/>
</searchParam>
<searchParam>
<name value="location"/>
<definition
value="https://apibroker.whanautahi.com/mdr/fhir/SearchParameter/MedicationDispense-location"/>
<type value="reference"/>
<documentation
value="Returns dispenses performed at the principal physical location (HPI Facility ID)"/>
</searchParam>
<searchParam>
<name value="whenprepared"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared"/>
<type value="date"/>
<documentation value="Returns dispenses prepared on this date"/>
</searchParam>
<searchParam>
<name value="whenhandedover"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover"/>
<type value="date"/>
<documentation value="Returns dispenses handed over on this date"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-status"/>
<type value="token"/>
<documentation
value="Returns dispenses with a specified dispense status"/>
</searchParam>
</resource>
<searchParam>
<name value="_count"/>
<type value="number"/>
<documentation value="How many resources to return"/>
</searchParam>
<searchParam>
<name value="_sort"/>
<type value="token"/>
<documentation value="How to sort the resources when returning"/>
</searchParam>
<searchParam>
<name value="_total"/>
<type value="number"/>
<documentation
value="Include number of resources that match the search parameters; Only Partial support available (_total=none and _total=accurate)"/>
</searchParam>
<searchParam>
<name value="_elements"/>
<type value="string"/>
<documentation value="What kind of information to return"/>
</searchParam>
</rest>
</CapabilityStatement>