1.2.0 - release
1.2.0 - release
KLGateway, published by KL. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7dk/kl-gateway/ and changes regularly. See the Directory of published versions
| Active as of 2023-06-08 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="klgateway"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement klgateway</b></p><a name="klgateway"> </a><a name="hcklgateway"> </a><a name="klgateway-en-US"> </a><h2 id="title"/><ul><li>Implementation Guide Version: 1.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>xml</code>, <code>application/fhir+json</code>, <code>json</code>, <code>application/x-turtle</code>, <code>ttl</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-06-08 00:29:49+0200 </li><li>Published by: KL </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 past versions of resources (vread interaction)">V-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="#Bundle1-1">Bundle</a></td><td>http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-delivery-report</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td>_content, _filter, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, composition, identifier, message, timestamp, type</td><td><code>*</code>, <code>Bundle:composition</code>, <code>Bundle:message</code></td><td><code>Bundle:composition</code>, <code>Bundle:message</code></td><td/></tr><tr><td><a href="#OperationDefinition1-2">OperationDefinition</a></td><td><a href="http://hl7.org/fhir/R4/operationdefinition.html">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td><code>*</code></td><td><code>Bundle:composition</code>, <code>Bundle:message</code></td><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Bundle1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Bundle</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/><code>http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-delivery-report</code></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>search-type</code>, <code>update</code>, <code>vread</code>, <code>read</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>_content</td><td><code>string</code></td><td><div><p>Search the contents of the resource's data using a fulltext search</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_filter</td><td><code>string</code></td><td><div><p>Search the contents of the resource's data using a filter</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_has</td><td><code>string</code></td><td><div><p>Return resources linked to by the given target</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>The ID of the resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_language</td><td><code>string</code></td><td><div><p>The language of the resource</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>Only return resources which were last updated as specified by the given range</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>uri</code></td><td><div><p>Search for resources which have the given profile</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_security</td><td><code>token</code></td><td><div><p>Search for resources which have the given security labels</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_source</td><td><code>uri</code></td><td><div><p>Search for resources which have the given source value (Resource.meta.source)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_tag</td><td><code>token</code></td><td><div><p>Search for resources which have the given tag</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_text</td><td><code>string</code></td><td><div><p>Search the contents of the resource's narrative using a fulltext search</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>composition</td><td><code>reference</code></td><td><div><p>The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>Persistent identifier for the bundle</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>message</td><td><code>reference</code></td><td><div><p>The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>timestamp</td><td><code>date</code></td><td><div><p>When the bundle was assembled</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection</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="OperationDefinition1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>OperationDefinition</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/operationdefinition.html">OperationDefinition</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="http://fhir.kl.dk/gateway/CapabilityStatement/klgateway"/>
<version value="1.2.0"/>
<name value="RestServer"/>
<status value="active"/>
<date value="2023-06-08T00:29:49.294+02:00"/>
<publisher value="KL"/>
<contact>
<name value="KL"/>
<telecom>
<system value="url"/>
<value value="http://www.kl.dk"/>
</telecom>
</contact>
<description
value="The Care Gateway (henceforth gateway) is a service that recieves care delivery reports from the municipalities and asynchronously forwards them other data sources such as FLIS and SEI2. Care delivery reports follows the FHIR format specified in the KL-Gateway FHIR Implementation Guide (IG)."/>
<kind value="instance"/>
<software>
<name value="Trifork Gateway FHIR Server"/>
<version value="6.2.5"/>
</software>
<implementation>
<description value="Trifork Gateway FHIR Server"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+xml"/>
<format value="xml"/>
<format value="application/fhir+json"/>
<format value="json"/>
<format value="application/x-turtle"/>
<format value="ttl"/>
<rest>
<mode value="server"/>
<resource>
<type value="Bundle"/>
<profile
value="http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-delivery-report"/>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<searchInclude value="*"/>
<searchInclude value="Bundle:composition"/>
<searchInclude value="Bundle:message"/>
<searchRevInclude value="Bundle:composition"/>
<searchRevInclude value="Bundle:message"/>
<searchParam>
<name value="_content"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a fulltext search"/>
</searchParam>
<searchParam>
<name value="_filter"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a filter"/>
</searchParam>
<searchParam>
<name value="_has"/>
<type value="string"/>
<documentation
value="Return resources linked to by the given target"/>
</searchParam>
<searchParam>
<name value="_id"/>
<type value="token"/>
<documentation value="The ID of the resource"/>
</searchParam>
<searchParam>
<name value="_language"/>
<type value="string"/>
<documentation value="The language of the resource"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<type value="date"/>
<documentation
value="Only return resources which were last updated as specified by the given range"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given profile"/>
</searchParam>
<searchParam>
<name value="_security"/>
<type value="token"/>
<documentation
value="Search for resources which have the given security labels"/>
</searchParam>
<searchParam>
<name value="_source"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given source value (Resource.meta.source)"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="_text"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's narrative using a fulltext search"/>
</searchParam>
<searchParam>
<name value="composition"/>
<type value="reference"/>
<documentation
value="The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation value="Persistent identifier for the bundle"/>
</searchParam>
<searchParam>
<name value="message"/>
<type value="reference"/>
<documentation
value="The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents"/>
</searchParam>
<searchParam>
<name value="timestamp"/>
<type value="date"/>
<documentation value="When the bundle was assembled"/>
</searchParam>
<searchParam>
<name value="type"/>
<type value="token"/>
<documentation
value="document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection"/>
</searchParam>
</resource>
<resource>
<type value="OperationDefinition"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/>
<interaction>
<code value="read"/>
</interaction>
<searchInclude value="*"/>
<searchRevInclude value="Bundle:composition"/>
<searchRevInclude value="Bundle:message"/>
</resource>
</rest>
</CapabilityStatement>