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="VH-ClinicalDataRepository"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement VH-ClinicalDataRepository</b></p><a name="VH-ClinicalDataRepository"> </a><a name="hcVH-ClinicalDataRepository"> </a><a name="VH-ClinicalDataRepository-en-GB"> </a><h2 id="title">Virtually Healthcare - Clinical Data Repository</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>_id, birthdate, family, gender, given, identifier, name</td><td/><td/><td/></tr><tr><td><a href="#AllergyIntolerance1-2">AllergyIntolerance</a></td><td><a href="StructureDefinition-AllergyIntolerance.html">https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance</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-AllergyIntolerance">UK Core Allergy Intolerance</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, clinical-status, date, last-date</td><td/><td/><td/></tr><tr><td><a href="#Condition1-3">Condition</a></td><td><a href="StructureDefinition-Condition.html">https://fhir.virtually.healthcare/StructureDefinition/Condition</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-Condition">UK Core Condition</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, onset-date</td><td/><td/><td/></tr><tr><td><a href="#DocumentReference1-4">DocumentReference</a></td><td><a href="StructureDefinition-DocumentReference.html">https://fhir.virtually.healthcare/StructureDefinition/DocumentReference</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-DocumentReference">UK Core Document Reference</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, date</td><td/><td/><td/></tr><tr><td><a href="#Immunization1-5">Immunization</a></td><td><a href="StructureDefinition-Immunization.html">https://fhir.virtually.healthcare/StructureDefinition/Immunization</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-Immunization">UK Core Immunization</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, date</td><td/><td/><td/></tr><tr><td><a href="#MedicationRequest1-6">MedicationRequest</a></td><td><a href="StructureDefinition-MedicationRequest.html">https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest</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-MedicationRequest">UK Core Medication Request</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, authoredon</td><td/><td/><td/></tr><tr><td><a href="#Observation1-7">Observation</a></td><td><a href="StructureDefinition-Observation.html">https://fhir.virtually.healthcare/StructureDefinition/Observation</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-Observation">UK Core Observation</a><br/> <a href="http://hl7.org/fhir/R4/vitalsigns.html">Vital Signs Profile</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, date, category, code, status</td><td/><td/><td/></tr><tr><td><a href="#Binary1-8">Binary</a></td><td><a href="http://hl7.org/fhir/R4/binary.html">http://hl7.org/fhir/StructureDefinition/Binary</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></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><strong>SHALL</strong> support <code>search-type</code>.</li><li>Supports <code>read</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>_id</td><td><code>token</code></td><td><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>family</td><td><code>string</code></td><td><div><p>A patients surname</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>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>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></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td> </td><td>birthdate+family</td><td><code>date</code>+<code>string</code></td></tr><tr><td> </td><td>birthdate+name</td><td><code>date</code>+<code>string</code></td></tr><tr><td> </td><td>gender+family</td><td><code>token</code>+<code>string</code></td></tr><tr><td> </td><td>gender+name</td><td><code>token</code>+<code>string</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="AllergyIntolerance1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>AllergyIntolerance</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-AllergyIntolerance.html">AllergyIntolerance</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-AllergyIntolerance">UK Core Allergy Intolerance</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</td><td><code>reference</code></td><td><div><p>Who the sensitivity is for</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>clinical-status</td><td><code>token</code></td><td><div><p>active | inactive | resolved</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Date first version of the resource instance was recorded</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>last-date</td><td><code>date</code></td><td><div><p>Date(/time) of last known occurrence of a reaction</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td> </td><td>patient+clinical-status</td><td><code>reference</code>+<code>token</code></td></tr><tr><td> </td><td>patient+date</td><td><code>reference</code>+<code>date</code></td></tr><tr><td> </td><td>patient+last-date</td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Condition1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Condition</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-Condition.html">Condition</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-Condition">UK Core Condition</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</td><td><code>reference</code></td><td><div><p>Who has the condition?</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>onset-date</td><td><code>date</code></td><td><div><p>Date related onsets (dateTime and Period)</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="DocumentReference1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>DocumentReference</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-DocumentReference.html">DocumentReference</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-DocumentReference">UK Core Document Reference</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</td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>When this document reference was created</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="Immunization1-5" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Immunization</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-Immunization.html">Immunization</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-Immunization">UK Core Immunization</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</td><td><code>reference</code></td><td><div><p>The patient for the vaccination record</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Vaccination (non)-Administration Date</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="MedicationRequest1-6" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </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="StructureDefinition-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/></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-MedicationRequest">UK Core Medication Request</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</td><td><code>reference</code></td><td><div><p>Returns prescriptions for a specific patient</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>authoredon</td><td><code>date</code></td><td><div><p>Return prescriptions written on this date</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="Observation1-7" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Observation</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-Observation.html">Observation</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-Observation">UK Core Observation</a><br/><a href="http://hl7.org/fhir/R4/vitalsigns.html">Vital Signs Profile</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</td><td><code>reference</code></td><td><div><p>The subject that the observation is about (if patient)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Obtained date/time. If the obtained element is a period, a date that falls in the period</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>The classification of the type of observation</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div><p>Obtained date/time. If the obtained element is a period, a date that falls in the period</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The status of the observation</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><span class="lead">Combined Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td> </td><td>patient+category</td><td><code>reference</code>+<code>token</code></td></tr><tr><td> </td><td>patient+code</td><td><code>reference</code>+<code>token</code></td></tr><tr><td> </td><td>patient+category+date</td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td> </td><td>patient+category+status</td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td> </td><td>patient+code+date</td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Binary1-8" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Binary</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/binary.html">Binary</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-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/></div></div></div></div>
</text>
<url
value="https://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository"/>
<version value="0.1.0-current"/>
<name value="ClinicalDataRepository"/>
<title value="Virtually Healthcare - Clinical Data Repository"/>
<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="The CDR adheres to the following standards:
- [UK SNOMED CT](https://digital.nhs.uk/services/terminology-and-classifications/snomed-ct) and [LOINC](https://loinc.org/) for our clinical terminology.
- [NHS Data Dictionary](https://www.datadictionary.nhs.uk/) for identifiers and values, such as NHS Number, GMC, GMP, ODS, etc.
- [HL7 UK Core](https://simplifier.net/HL7FHIRUKCoreR4/)
The CDR closely follows:
- [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/) Server
- [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/index.html) Server
- [HL7 UK - UK Core Access](https://build.fhir.org/ig/HL7-UK/UK-Core-Access/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>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="gender"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="gender"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</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>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="birthdate"/>
<type value="date"/>
<documentation value="A patients date of birth"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="family"/>
<type value="string"/>
<documentation value="A patients surname"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="gender"/>
<type value="token"/>
<documentation value="A patients gender - administrative"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="given"/>
<type value="string"/>
<documentation value="A patients first name"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<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>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<type value="string"/>
<documentation value="A patients name"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="last-date"/>
</extension>
</extension>
<type value="AllergyIntolerance"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who the sensitivity is for"/>
</searchParam>
<searchParam>
<name value="clinical-status"/>
<type value="token"/>
<documentation value="active | inactive | resolved"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="date"/>
<type value="date"/>
<documentation
value="Date first version of the resource instance was recorded"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="last-date"/>
<type value="date"/>
<documentation
value="Date(/time) of last known occurrence of a reaction"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Condition"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/Condition"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who has the condition?"/>
</searchParam>
<searchParam>
<name value="onset-date"/>
<type value="date"/>
<documentation value="Date related onsets (dateTime and Period)"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="DocumentReference"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/DocumentReference"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who/what is the subject of the document"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="date"/>
<documentation value="When this document reference was created"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Immunization"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/Immunization"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="The patient for the vaccination record"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="date"/>
<documentation value="Vaccination (non)-Administration Date"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="MedicationRequest"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Returns prescriptions for a specific patient"/>
</searchParam>
<searchParam>
<name value="authoredon"/>
<type value="date"/>
<documentation value="Return prescriptions written on this date"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<type value="Observation"/>
<profile
value="https://fhir.virtually.healthcare/StructureDefinition/Observation"/>
<supportedProfile
value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"/>
<supportedProfile
value="http://hl7.org/fhir/StructureDefinition/vitalsigns"/>
<interaction>
<code value="search-type"/>
</interaction>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation
value="The subject that the observation is about (if patient)"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="date"/>
<documentation
value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation value="The classification of the type of observation"/>
</searchParam>
<searchParam>
<name value="code"/>
<type value="token"/>
<documentation
value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation value="The status of the observation"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Binary"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Binary"/>
<interaction>
<code value="read"/>
</interaction>
</resource>
</rest>
</CapabilityStatement>