BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-10-10 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="bc-hcim-capability-statement-client"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement bc-hcim-capability-statement-client</b></p><a name="bc-hcim-capability-statement-client"> </a><a name="hcbc-hcim-capability-statement-client"> </a><h2 id="title">BC HCIM Client Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2025-10-10 </li><li>Published by: BC Ministry of Health </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>client</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></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><a href="StructureDefinition-bc-patient.html">http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-patient</a><br/><em>Additional supported profiles:</em><br/> <a href="StructureDefinition-bc-subscription-notification-bundle.html">SubscriptionNotificationBundle</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td><code>$PatientNotification</code></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-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-bc-patient.html">ClientRegistryPatient</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-bc-subscription-notification-bundle.html">SubscriptionNotificationBundle</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><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-bc-patient-notification.html">$PatientNotification</a></td><td><div><p>POST [base]/Patient/$PatientNotification with a bc-subscription-notification-bundle.</p>
</div></td></tr></tbody></table></div></div></div></div></div></div>
</text>
<url
value="http://hlth.gov.bc.ca/fhir/client/CapabilityStatement/bc-hcim-capability-statement-client"/>
<version value="1.0.0"/>
<name value="HCIMClientCapabilityStatement"/>
<title value="BC HCIM Client Capability Statement"/>
<status value="active"/>
<date value="2025-10-10"/>
<publisher value="BC Ministry of Health"/>
<contact>
<name value="BC Ministry of Health"/>
<telecom>
<system value="url"/>
<value
value="https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/health"/>
</telecom>
</contact>
<description
value="PCR as a client posts notifications/distributions via a patient-level operation. This capability statement describes the use cases that are supported by the BC FHIR implementation of the Client Registry when it is acting as a client, sending distributions (notifications)."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="CA"/>
<display value="Canada"/>
</coding>
</jurisdiction>
<kind value="capability"/>
<software>
<name value="BC HCIM FHIR Implementation"/>
</software>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<rest>
<mode value="client"/>
<security>
<service>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
<code value="OAuth"/>
</coding>
</service>
</security>
<resource>
<type value="Patient"/>
<profile
value="http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-patient"/>
<supportedProfile
value="http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-subscription-notification-bundle"/>
<operation>
<name value="PatientNotification"/>
<definition
value="http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-notification"/>
<documentation
value="POST [base]/Patient/$PatientNotification with a bc-subscription-notification-bundle."/>
</operation>
</resource>
</rest>
</CapabilityStatement>