KIOLA Standard Treatment Plan Apply

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Supported Patch Formats:
  • Published on: 2023-01-11
  • Published by: null

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: server

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

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
PlanDefinitionhttps://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-planyy

Resource Conformance: supportedPlanDefinition

Base System Profile
https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-standard-treatment-plan
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Extended Operations
ConformanceOperationDocumentation
SHALL$$apply
 <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="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 value="This capability might be used by other systems (e.g. patient management systems) to apply treatment plans to specific patients."/> <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 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 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="$apply"/> <definition value="http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply"/> </operation> </resource> </rest> </CapabilityStatement>