Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 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/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Draft as of 2024-10-08 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="NHSEFacade"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement NHSEFacade</b></p><a name="NHSEFacade"> </a><a name="hcNHSEFacade"> </a><a name="NHSEFacade-en-GB"> </a><h2 id="title">NHS England Service Facade</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="#Patient1-1">Patient</a></td><td><a href="StructureDefinition-Patient.html">https://fhir.virtually.healthcare/StructureDefinition/Patient</a><br/><em>Additional supported profiles:</em><br/> <a href="https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient">UK Core Patient</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, family, given, birthdate, gender, death-date, address-postalcode, general-practitioner, email, phone</td><td/><td/><td/></tr><tr><td><a href="#QuestionnaireResponse1-2">QuestionnaireResponse</a></td><td><a href="StructureDefinition-QuestionnaireResponse.html">https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse</a><br/><em>Additional supported profiles:</em><br/> <a href="https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse">UK Core Questionnaire Response</a></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>questionnaire, patient, patient:identifier</td><td/><td/><td/></tr><tr><td><a href="#RelatedPerson1-3">RelatedPerson</a></td><td><a href="StructureDefinition-RelatedPerson.html">https://fhir.virtually.healthcare/StructureDefinition/RelatedPerson</a><br/><em>Additional supported profiles:</em><br/> <a href="https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson">UK Core Related Person</a></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>patient:identifier</td><td/><td/><td/></tr><tr><td><a href="#Organization1-4">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.stu3.currentbuild@0.0.15-pre-release&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="Patient1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </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-Patient.html">Patient</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.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient">UK Core Patient</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 /Patient?{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 Patient's for a patient with a NHS Number of 9876543210</p>
<pre><code>GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
</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 patients NHS Number e.g. <code>identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210</code></p>
</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>A patients name</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>family</td><td><code>string</code></td><td><div><p>A patients surname</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>given</td><td><code>string</code></td><td><div><p>A patients first name</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>A patients date of birth</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>A patients gender - administrative</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>death-date</td><td><code>token</code></td><td><div><p>A patients date of birth</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode</td><td><code>string</code></td><td><div><p>A patients postcode</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>general-practitioner</td><td><code>token</code></td><td><div><p>A patients general practice</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>email</td><td><code>token</code></td><td><div><p>A patients email address</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>phone</td><td><code>token</code></td><td><div><p>A patients phone number</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="QuestionnaireResponse1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>QuestionnaireResponse</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-QuestionnaireResponse.html">QuestionnaireResponse</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.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse">UK Core Questionnaire Response</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>search-type</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>questionnaire</td><td><code>reference</code></td><td><div><p>The questionnaire the answers are provided for, e.g. <code>questionnaire=https://fhir.virtually.healthcare/Questionnaire/PDSPatientPreferences</code></p>
</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>The patient that is the subject of the questionnaire response, e.g. <code>patient=Patient/9449304424</code></p>
</div></td></tr><tr><td><b>SHALL</b></td><td>patient:identifier</td><td><code>token</code></td><td><div><p>The patient identifier that is the subject of the questionnaire response, e.g. <code>patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9449304424</code></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="RelatedPerson1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>RelatedPerson</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-RelatedPerson.html">RelatedPerson</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.stu3.currentbuild@0.0.15-pre-release&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson">UK Core Related Person</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>search-type</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>patient:identifier</td><td><code>token</code></td><td><div><p>The patient identifier this related person is related to, e.g. <code>patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9730906181</code></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-4" 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.stu3.currentbuild@0.0.15-pre-release&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/NHSEFacade"/>
<version value="0.1.0-current"/>
<name value="NHSEnglandFacade"/>
<title value="NHS England Service Facade"/>
<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 [Personal Demographics Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) and [Organisation Data Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir)
This facade is related to [IHE Patient Demographics Query for Mobile (PDQm)](https://profiles.ihe.net/ITI/PDQm/) and [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="Patient"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/Patient"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"/>
<documentation
value="
```
GET /Patient?{parameters}
```
Conformance to this implementation guide **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).
**Search Examples**
Search for Patient's for a patient with a NHS Number of 9876543210
```
GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
```
"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210`"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation value="A patients name"/>
</searchParam>
<searchParam>
<name value="family"/>
<type value="string"/>
<documentation value="A patients surname"/>
</searchParam>
<searchParam>
<name value="given"/>
<type value="string"/>
<documentation value="A patients first name"/>
</searchParam>
<searchParam>
<name value="birthdate"/>
<type value="date"/>
<documentation value="A patients date of birth"/>
</searchParam>
<searchParam>
<name value="gender"/>
<type value="token"/>
<documentation value="A patients gender - administrative"/>
</searchParam>
<searchParam>
<name value="death-date"/>
<type value="token"/>
<documentation value="A patients date of birth"/>
</searchParam>
<searchParam>
<name value="address-postalcode"/>
<type value="string"/>
<documentation value="A patients postcode"/>
</searchParam>
<searchParam>
<name value="general-practitioner"/>
<type value="token"/>
<documentation value="A patients general practice"/>
</searchParam>
<searchParam>
<name value="email"/>
<type value="token"/>
<documentation value="A patients email address"/>
</searchParam>
<searchParam>
<name value="phone"/>
<type value="token"/>
<documentation value="A patients phone number"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="QuestionnaireResponse"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="questionnaire"/>
<type value="reference"/>
<documentation
value="The questionnaire the answers are provided for, e.g. `questionnaire=https://fhir.virtually.healthcare/Questionnaire/PDSPatientPreferences`"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation
value="The patient that is the subject of the questionnaire response, e.g. `patient=Patient/9449304424`"/>
</searchParam>
<searchParam>
<name value="patient:identifier"/>
<type value="token"/>
<documentation
value="The patient identifier that is the subject of the questionnaire response, e.g. `patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9449304424`"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="RelatedPerson"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/RelatedPerson"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient:identifier"/>
<type value="token"/>
<documentation
value="The patient identifier this related person is related to, e.g. `patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9730906181`"/>
</searchParam>
</resource>
<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>