Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build United Kingdom flag

Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

: Facade - Organisation Data Service - FHIR API - XML Representation

Draft as of 2024-10-08

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="ODSFacade"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement ODSFacade</b></p><a name="ODSFacade"> </a><a name="hcODSFacade"> </a><a name="ODSFacade-en-GB"> </a><h2 id="title">Facade - Organisation Data Service - FHIR API</h2><ul><li>Implementation Guide Version: 0.1.0-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-10-08 </li><li>Published by: Virtually Healthcare </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>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="#Organization1-1">Organization</a></td><td><a href="StructureDefinition-Organization.html">https://fhir.virtually.healthcare/StructureDefinition/Organization</a><br/><em>Additional supported profiles:</em><br/>  <a href="https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization">UK Core 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>identifier, name, active, address-postalcode, address-city, ods-org-primaryRole, type</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Organization</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-Organization.html">Organization</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="https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization">UK Core Organization</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><pre><code>GET /Organization?{parameters}
</code></pre>
<p>Conformance to this implementation guide <strong>SHOULD</strong> be tested via <a href="https://hl7.org/fhir/R4/validation.html">FHIR Validation</a>.</p>
<p><strong>Search Examples</strong></p>
<p>Search for Organization's for a patient with a ODS Code of RR8</p>
<pre><code>GET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8
</code></pre>
</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>A organisations ODS Code e.g. <code>identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8</code></p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>A portion of the organization's name or alias</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>Is the Organization record active</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode</td><td><code>string</code></td><td><div><p>A postal code specified in an address</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>address-city</td><td><code>string</code></td><td><div><p>A city specified in an address</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>ods-org-primaryRole</td><td><code>token</code></td><td><div><p>organisation ods primary role</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>A code for the type of organization</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://fhir.virtually.healthcare/CapabilityStatement/ODSFacade"/>
  <version value="0.1.0-current"/>
  <name value="FacadeOrganisationDataService"/>
  <title value="Facade - Organisation Data Service - FHIR API"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2024-10-08"/>
  <publisher value="Virtually Healthcare"/>
  <contact>
    <name value="Virtually Healthcare"/>
    <telecom>
      <system value="url"/>
      <value value="https://virtually.healthcare"/>
    </telecom>
  </contact>
  <description
               value="
This is a [Service Facade](ActorDefinition-ServiceFacade.html) to [Organisation Data Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir)

This facade is related to [IHE Mobile Care Services Discovery (mCSD)](https://profiles.ihe.net/ITI/mCSD/index.html)"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="GB"/>
      <display value="United Kingdom of Great Britain and Northern Ireland"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Organization"/>
      <profile
               value="https://fhir.virtually.healthcare/StructureDefinition/Organization"/>
      <supportedProfile
                        value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"/>
      <documentation
                     value="
```
GET /Organization?{parameters}
```

Conformance to this implementation guide **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).

**Search Examples**

Search for Organization's for a patient with a ODS Code of RR8

```
GET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8
```
"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="A organisations ODS Code e.g. `identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8`"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation value="A portion of the organization's name or alias"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation value="Is the Organization record active"/>
      </searchParam>
      <searchParam>
        <name value="address-postalcode"/>
        <type value="string"/>
        <documentation value="A postal code specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="address-city"/>
        <type value="string"/>
        <documentation value="A city specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="ods-org-primaryRole"/>
        <type value="token"/>
        <documentation value="organisation ods primary role"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation value="A code for the type of organization"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>