KIOLA Implementation Guide
0.1.0 - STU1
KIOLA Implementation Guide
0.1.0 - STU1
KIOLA Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2023-01-11 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="kiola-standard-treatment-plan-set-default"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">KIOLA Standard Treatment Plan Set Default</h2><ul><li>Implementation Guide Version: 0.1.0</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-01-11</li><li>Published by: null</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><p>The <code>$meta-add</code> and <code>$meta-remove</code> operations might be used with the tag <code>https://fhir.ehealth-systems.at/artifacts/PlanDefinition/tag#default</code> to add or remove a standard treatment plan from the set of default plans. The read and search operations might be used to query all standard treatment plans and lookup default plans in the result. The <code>$meta</code> operation might be used to check if a specific plan currently is a default plan. When creating a new treatment plan, the meta tag might also be included to declare it as a default plan.</p>
</div><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="#PlanDefinition1-1">PlanDefinition</a></td><td><a href="StructureDefinition-kiola-standard-treatment-plan.html">https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan</a></td><td>y</td><td class="text-center">y</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="PlanDefinition1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>PlanDefinition</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-kiola-standard-treatment-plan.html">https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan</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>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$meta-add</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$$meta-remove</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$$meta</td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>
</text>
<url
value="https://fhir.ehealth-systems.at/artifacts/CapabilityStatement/kiola-standard-treatment-plan-set-default"/>
<version value="0.1.0"/>
<name value="KIOLAStandardTreatmentPlanSetDefault"/>
<title value="KIOLA Standard Treatment Plan Set Default"/>
<status value="draft"/>
<date value="2023-01-11"/>
<contact>
<name value="AIT Austrian Institute of Technology"/>
<telecom>
<system value="email"/>
<value value="mailto:office@ait.ac.at"/>
</telecom>
</contact>
<description
value="One or more KIOLA standard treatment plans might be set as default plans, to be preselected when registering a new patient."/>
<purpose
value="This capability might be used by other systems (e.g. editors for standard treatment plans) to set some KIOLA standard treatment plans as default plans. Those default plans will then be preselected and eventually applied when registering a new patient."/>
<kind value="capability"/>
<software>
<name value="KIOLA"/>
<version value="Bundle 2.5"/>
<releaseDate value="2023-02-01"/>
</software>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+json"/>
<rest>
<mode value="server"/>
<documentation
value="The `$meta-add` and `$meta-remove` operations might be used with the tag `https://fhir.ehealth-systems.at/artifacts/PlanDefinition/tag#default` to add or remove a standard treatment plan from the set of default plans. The read and search operations might be used to query all standard treatment plans and lookup default plans in the result. The `$meta` operation might be used to check if a specific plan currently is a default plan. When creating a new treatment plan, the meta tag might also be included to declare it as a default plan."/>
<resource>
<type value="PlanDefinition"/>
<profile
value="https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<operation>
<name value="$meta-add"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/Resource-meta-add"/>
</operation>
<operation>
<name value="$meta-remove"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/Resource-meta-remove"/>
</operation>
<operation>
<name value="$meta"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/Resource-meta"/>
</operation>
</resource>
</rest>
</CapabilityStatement>