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" : "ODSFacade",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ODSFacade</b></p><a name=\"ODSFacade\"> </a><a name=\"hcODSFacade\"> </a><a name=\"ODSFacade-en-GB\"> </a><h2 id=\"title\">Facade - Organisation Data Service - FHIR API</h2><ul><li>Implementation Guide Version: 0.1.0-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-10-08 </li><li>Published by: Virtually Healthcare </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Organization1-1\">Organization</a></td><td><a href=\"StructureDefinition-Organization.html\">https://fhir.virtually.healthcare/StructureDefinition/Organization</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization\">UK Core Organization</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, name, active, address-postalcode, address-city, ods-org-primaryRole, type</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Organization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Organization.html\">Organization</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&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}\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 Organization's for a patient with a ODS Code of RR8</p>\n<pre><code>GET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8\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>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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "https://fhir.virtually.healthcare/CapabilityStatement/ODSFacade",
"version" : "0.1.0-current",
"name" : "FacadeOrganisationDataService",
"title" : "Facade - Organisation Data Service - FHIR API",
"status" : "draft",
"experimental" : false,
"date" : "2024-10-08",
"publisher" : "Virtually Healthcare",
"contact" : [
{
"name" : "Virtually Healthcare",
"telecom" : [
{
"system" : "url",
"value" : "https://virtually.healthcare"
}
]
}
],
"description" : "\nThis is a [Service Facade](ActorDefinition-ServiceFacade.html) to [Organisation Data Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir)\n\nThis facade is related to [IHE Mobile Care Services Discovery (mCSD)](https://profiles.ihe.net/ITI/mCSD/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"
}
],
"type" : "Organization",
"profile" : "https://fhir.virtually.healthcare/StructureDefinition/Organization",
"supportedProfile" : [
🔗 "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
],
"documentation" : "\n```\nGET /Organization?{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 Organization's for a patient with a ODS Code of RR8\n\n```\nGET /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8\n```\n",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token",
"documentation" : "A organisations ODS Code e.g. `identifier=https://fhir.nhs.uk/Id/ods-organization-code|RR8`"
},
{
"name" : "name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Is the Organization record active"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "ods-org-primaryRole",
"type" : "token",
"documentation" : "organisation ods primary role"
},
{
"name" : "type",
"type" : "token",
"documentation" : "A code for the type of organization"
}
]
}
]
}
]
}