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

: KIOLA Standard Treatment Plan Apply - JSON Representation

Draft as of 2023-01-11

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "kiola-standard-treatment-plan-apply",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">KIOLA Standard Treatment Plan Apply</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 &quot;SHALL NOT&quot;. 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 call should be made with the following parameters, on the standard treatment plan instance: <code>PlanDefinition/[STANDARD_TREATMENT_PLAN_ID]/$apply?subject=[KIOLA_SUBJECT_UUID]</code>, e.g. <code>PlanDefinition/1822/$apply?subject=hCZQJm6BrSimF232A39oL2</code></p>\n</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>$$apply</td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>"
  },
  "url" : "https://fhir.ehealth-systems.at/artifacts/CapabilityStatement/kiola-standard-treatment-plan-apply",
  "version" : "0.1.0",
  "name" : "KIOLAStandardTreatmentPlanApply",
  "title" : "KIOLA Standard Treatment Plan Apply",
  "status" : "draft",
  "date" : "2023-01-11",
  "contact" : [
    {
      "name" : "AIT Austrian Institute of Technology",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:office@ait.ac.at"
        }
      ]
    }
  ],
  "description" : "Apply a KIOLA standard treatment plan to a patient to generate a treatment plan instance. The current KIOLA care plan of the patient is not taken into account. The standard treatment plan is simply applied to the patient and a new KIOLA care plan containing this treatment plan is returned.",
  "purpose" : "This capability might be used by other systems (e.g. patient management systems) to apply treatment plans to specific patients.",
  "kind" : "capability",
  "software" : {
    "name" : "KIOLA",
    "version" : "Bundle 2.5",
    "releaseDate" : "2023-02-01"
  },
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The call should be made with the following parameters, on the standard treatment plan instance: `PlanDefinition/[STANDARD_TREATMENT_PLAN_ID]/$apply?subject=[KIOLA_SUBJECT_UUID]`, e.g. `PlanDefinition/1822/$apply?subject=hCZQJm6BrSimF232A39oL2`",
      "resource" : [
        {
          "type" : "PlanDefinition",
          "profile" : "https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "operation" : [
            {
              "name" : "$apply",
              "definition" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply"
            }
          ]
        }
      ]
    }
  ]
}