Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
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
| Draft as of 2024-10-08 |
{
"resourceType" : "CapabilityStatement",
"id" : "VH-ClinicalDataRepository",
"text" : {
"status" : "extensions",
"div" : "<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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\">UK Core Patient</a><br/>\u00a0\u00a0<code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</code></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, birthdate+family, birthdate+name, gender+family, gender+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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance\">UK Core AllergyIntolerance</a><br/>\u00a0\u00a0<code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</code></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, patient+clinical-status, patient+date, patient+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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&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/>\u00a0\u00a0<code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest\">UK Core MedicationRequest</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/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation\">UK Core Observation</a><br/>\u00a0\u00a0<code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</code><br/>\u00a0\u00a0<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, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+date</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.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\">UK Core Patient</a><br/><code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</code></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}\n</code></pre>\n<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>\n<p><strong>Search Examples</strong></p>\n<p>Search for Patient's for a patient with a NHS Number of 9876543210</p>\n<pre><code>GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210\n``\n</code></pre>\n</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>family</td><td><code>string</code></td><td><div><p>A patients surname</p>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>A patients name</p>\n</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><b>SHALL</b></td><td>birthdate+family</td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHALL</b></td><td>birthdate+name</td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHALL</b></td><td>gender+family</td><td><code>token</code>+<code>string</code></td></tr><tr><td><b>SHALL</b></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.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance\">UK Core AllergyIntolerance</a><br/><code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</code></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>\n</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>\n</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>\n</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>\n</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><b>SHALL</b></td><td>patient+clinical-status</td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td>patient+date</td><td><code>reference</code>+<code>date</code></td></tr><tr><td><b>SHALL</b></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.stu2@2.1.0&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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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><code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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.stu2@2.1.0&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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest\">UK Core MedicationRequest</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation\">UK Core Observation</a><br/><code>http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</code><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>\n</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>\n</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>\n</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>\n</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>\n</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><b>SHALL</b></td><td>patient+category</td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td>patient+code</td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td>patient+category+date</td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHALL</b></td><td>patient+category+status</td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></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>"
},
"url" : "https://fhir.virtually.healthcare/CapabilityStatement/VH-ClinicalDataRepository",
"version" : "0.1.0-current",
"name" : "ClinicalDataRepository",
"title" : "Virtually Healthcare - Clinical Data Repository",
"status" : "draft",
"experimental" : false,
"date" : "2024-10-08",
"publisher" : "Virtually Healthcare",
"contact" : [
{
"name" : "Virtually Healthcare",
"telecom" : [
{
"system" : "url",
"value" : "https://virtually.healthcare"
}
]
}
],
"description" : "The CDR adheres to the following standards:\n\n - [UK SNOMED CT](https://digital.nhs.uk/services/terminology-and-classifications/snomed-ct) and [LOINC](https://loinc.org/) for our clinical terminology.\n - [NHS Data Dictionary](https://www.datadictionary.nhs.uk/) for identifiers and values, such as NHS Number, GMC, GMP, ODS, etc.\n - [HL7 UK Core](https://simplifier.net/HL7FHIRUKCoreR4/)\n\nThe CDR closely follows:\n\n - [HL7 International Patient Access](https://build.fhir.org/ig/HL7/fhir-ipa/) Server\n - [IHE Query for Existing Data for Mobile (QEDm)](https://build.fhir.org/ig/IHE/QEDm/branches/master/index.html) Server\n - [HL7 UK - UK Core Access](https://build.fhir.org/ig/HL7-UK/UK-Core-Access/index.html)",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "GB",
"display" : "United Kingdom of Great Britain and Northern Ireland"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "gender"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "gender"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/Patient",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient"
],
"documentation" : "\n```\nGET /Patient?{parameters}\n```\n\nConformance to this implementation guide **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).\n\n**Search Examples**\n\nSearch for Patient's for a patient with a NHS Number of 9876543210\n\n```\nGET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210\n``\n",
"interaction" : [
{
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "birthdate",
"type" : "date",
"documentation" : "A patients date of birth"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "family",
"type" : "string",
"documentation" : "A patients surname"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "gender",
"type" : "token",
"documentation" : "A patients gender - administrative"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "given",
"type" : "string",
"documentation" : "A patients first name"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210`"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"type" : "string",
"documentation" : "A patients name"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "last-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "AllergyIntolerance",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance",
"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Who the sensitivity is for"
},
{
"name" : "clinical-status",
"type" : "token",
"documentation" : "active | inactive | resolved"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"type" : "date",
"documentation" : "Date first version of the resource instance was recorded"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "last-date",
"type" : "date",
"documentation" : "Date(/time) of last known occurrence of a reaction"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Condition",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/Condition",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Who has the condition?"
},
{
"name" : "onset-date",
"type" : "date",
"documentation" : "Date related onsets (dateTime and Period)"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DocumentReference",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/DocumentReference",
"supportedProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "date",
"type" : "date",
"documentation" : "When this document reference was created"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Immunization",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/Immunization",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "The patient for the vaccination record"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Vaccination (non)-Administration Date"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "MedicationRequest",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/MedicationRequest",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Returns prescriptions for a specific patient"
},
{
"name" : "authoredon",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/Observation",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation"🔗 ,
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "The subject that the observation is about (if patient)"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name" : "category",
"type" : "token",
"documentation" : "The classification of the type of observation"
},
{
"name" : "code",
"type" : "token",
"documentation" : "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The status of the observation"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Binary",
"profile" : "http://hl7.org/fhir/StructureDefinition/Binary",
"interaction" : [
{
"code" : "read"
}
]
}
]
}
]
}